cee::ug::ModeShapeAnimation Class Reference

Settings for mode shape animation. More...

Public Types

enum  InterpolationType { LINEAR, SINE }
 Type of interpolation to use when creating the mode shape animation. More...
 
enum  AnimationType { QUARTER, HALF, FULL }
 Type of animation to create, quarter, half or full. More...
 

Public Member Functions

size_t frameCount () const
 Returns the number of frames in a mode shape animation. More...
 
void setFrameCount (size_t stepCount)
 Sets the number of frames for using mode shape animation. More...
 
bool interpolateScalars () const
 Returns true if the scalars will be interpolated in a mode-shape animation. Returns false if not. More...
 
void setInterpolateScalars (bool interpolate)
 Specifies if the scalars should be interpolated during a mode-shape animation or not. More...
 
InterpolationType interpolationMode () const
 Returns the interpolation type to use for mode-shape animations. More...
 
void setInterpolationMode (InterpolationType interpolationType)
 Specifies which interpolation type to use for mode-shape animations. More...
 
AnimationType animationMode () const
 Returns the type of animation to create in mode-shape: Quarter, half or full. More...
 
void setAnimationMode (AnimationType animationType)
 Specifies the length of the mode-shape animation. More...
 
void clear ()
 Sets default values (no mode shape animation) More...
 

Detailed Description

Settings for mode shape animation.

See also
UnstructGridModel
DataSourceDirectory

Member Enumeration Documentation

Type of animation to create, quarter, half or full.

Enumerator
QUARTER 

Animate from original position to the displaced position: V0 ... VD.

HALF 

Animate from original position to the displaced position and back again: V0 ... VD ... V0.

FULL 

Animate from original position to the displaced position and back again, then to the negative displacement and back: V0 ... VD ... V0 ... -VD ... V0.

Type of interpolation to use when creating the mode shape animation.

Enumerator
LINEAR 

Linear interpolation.

SINE 

Sine(alpha) interpolation where the angular speed is constant, making the interpolation factor follow a sine(x) curve.

Member Function Documentation

ModeShapeAnimation::AnimationType cee::ug::ModeShapeAnimation::animationMode ( ) const

Returns the type of animation to create in mode-shape: Quarter, half or full.

void cee::ug::ModeShapeAnimation::clear ( )

Sets default values (no mode shape animation)

size_t cee::ug::ModeShapeAnimation::frameCount ( ) const

Returns the number of frames in a mode shape animation.

Returns 0 if there is no mode shape animation set.

bool cee::ug::ModeShapeAnimation::interpolateScalars ( ) const

Returns true if the scalars will be interpolated in a mode-shape animation. Returns false if not.

ModeShapeAnimation::InterpolationType cee::ug::ModeShapeAnimation::interpolationMode ( ) const

Returns the interpolation type to use for mode-shape animations.

void cee::ug::ModeShapeAnimation::setAnimationMode ( AnimationType  animationType)

Specifies the length of the mode-shape animation.

void cee::ug::ModeShapeAnimation::setFrameCount ( size_t  stepCount)

Sets the number of frames for using mode shape animation.

Sets to 0 if no mode shape animation should be used.

void cee::ug::ModeShapeAnimation::setInterpolateScalars ( bool  interpolate)

Specifies if the scalars should be interpolated during a mode-shape animation or not.

void cee::ug::ModeShapeAnimation::setInterpolationMode ( InterpolationType  interpolationType)

Specifies which interpolation type to use for mode-shape animations.