Additional Controller Related Functions

The following functions may be used to control the playing and suspension of animation, get and set the start and end animation times, and returns new instances of default controllers of various types.

This ensures that animate mode is unchanged after you're through. The animate button never changes appearance so the user doesn't have to be aware that anything is happening.

Animation Modes Functions

The functions below allow a developer to control the state of the 'Animate' button in the user interface, and also set if animate mode is on or off. The pseudo code below demonstrate how these methods might be used. If you need to do something associated with a controller but did not want keys to be generated you could write:

  • Animating() - Determines if the animate button is on. Returns nonzero if on; zero if off.
  • AnimateOn() - This method turns animation on but does not change the appearance of the button.
  • AnimateOff() - This method turns animation off (i.e. prevents generation of keys) but does not change the appearance of the button. This method logically turns animating off but does not change the appearance of the button.
  • SuspendAnimate() - Suspend the animation from running. This method uses a stack so if several calls are made to the SuspendAnimate(), they must all be resumed before animation will resume.
  • ResumeAnimate() - Resume suspended animation. The method SuspendAnimate() uses a stack so if several calls are made to SuspendAnimate(), they must all be resumed using this method before the animation will resume.
  • GetAnimStart() - Retrieves the start time of the animation.
  • GetAnimEnd() - Retrieves the end time of the animation.
  • SetAnimStart() - Sets the start time of the animation.
  • SetAnimEnd() - Sets the end time of the animation.

Controller Creation Functions

  • NewDefaultFloatController() - Creates an instance of the default float controller.
  • NewDefaultPoint3Controller() - Creates an instance of the default Point3 controller.
  • NewDefaultMatrix3Controller() - Creates an instance of the default Matrix3 controller.
  • NewDefaultPositionController() - Creates an instance of the default position controller.
  • NewDefaultRotationController() - Creates an instance of the default rotation controller.
  • NewDefaultScaleController() - Creates an instance of the default scale controller.
  • NewDefaultColorController() - Creates an instance of the default color controller.
  • NewDefaultBoolController() - Returns an instance of the default boolean controller.
  • CreateInterpFloat() - Creates and returns a pointer to a new Bezier float controller.
  • CreateInterpPosition() - Creates and returns a pointer to a new Bezier position controller.
  • CreateInterpPoint3() - Creates and returns a pointer to a new Bezier Color controller.
  • CreateInterpRotation() - Creates and returns a pointer to a new TCB Rotation controller.
  • CreateInterpRotation() - Creates and returns a pointer to a new Bezier Scale controller.
  • CreatePRSControl() - Creates and returns a pointer to a new PRS transform controller.
  • CreateLookatControl() - Creates and returns a pointer to a new Look At transform controller.

Default Controller Functions

  • SetDefaultController() - Sets the default controller of the specified type to the controller whose ClassDesc is passed.
  • GetDefaultController() - Returns a pointer to the class descriptor for the default controller of the specified type.
  • SetDefaultColorController() - Sets the default Color controller.
  • SetDefaultBoolController() - Sets the default Boolean controller

Other Functions

  • ApplyScaling() - Used to apply a ScaleValue to the specified Matrix3. This is used in controller implementation of GetValue() when the GetSetMethod is CTRL_RELATIVE and the controller is a scale controller.

Global Functions

The global functions below provide access to the default tangent types for both the Bezier and TCB controllers.

  • GetBezierDefaultTangentType() - Retrieves the default tangent types for the Bezier controller.
  • SetBezierDefaultTangentType() - Sets the default tangent types for the Bezier controller.
  • GetTCBDefaultParams() - Retrieves the parameters for the default TCB controller.
  • SetTCBDefaultParams() - Sets the parameters for the default TCB controller.

See Also: