# cee::ug::ModeShapeAnimation

class `ModeShapeAnimation`

  Settings for mode shape animation.

  See also

  UnstructGridModel and DataSourceDirectory

  Public Types

  enum `InterpolationType`

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

    Values:

    enumerator `LINEAR`

      Linear interpolation.

    enumerator `SINE`

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

  enum `AnimationType`

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

    Values:

    enumerator `QUARTER`

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

    enumerator `HALF`

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

    enumerator `FULL`

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

  Public Functions

  size_t `frameCount`() const

    Returns the number of frames in a mode shape animation.

    Returns 0 if there is no mode shape animation set.

  void `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.

  bool `interpolateScalars`() const

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

  void `setInterpolateScalars`(bool interpolate)

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

  InterpolationType `interpolationMode`() const

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

  void `setInterpolationMode`(InterpolationType interpolationType)

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

  AnimationType `animationMode`() const

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

  void `setAnimationMode`(AnimationType animationType)

    Specifies the length of the mode-shape animation.

  void `clear`()

    Sets default values (no mode shape animation)

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Envision for Desktop in your own language, or choose a sample question below to start a conversation:

What is HOOPS Envision for Desktop?
What are the latest release notes for HOOPS Envision for Desktop?
How do I start evaluating HOOPS Envision for Desktop?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...