CSLExtrapolation Class Reference

#include <Extrapolation.h>

Inheritance diagram for CSLExtrapolation:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   EExtrapolationType {
  SI_NO_CONTRIBUTION,
  SI_HOLD,
  SI_CYCLE,
  SI_BOUNCE
}

Public Member Functions
  CSLExtrapolation (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate, EExtrapolationType in_Type=CSLExtrapolation::SI_NO_CONTRIBUTION)
CSLTemplate::ETemplateType  Type ()
EExtrapolationType  GetExtrapolationType ()
SI_Void  SetExtrapolationType (CSLExtrapolation::EExtrapolationType in_Type)
SI_Float  GetValue ()
SI_Void  SetValue (SI_Float in_fValue)

Detailed Description

Determine how a an action clip (CSLActionClip) contributes to the animation outside of the frames on which it is defined. You can create an instance of this class with the CSLTimeControl::CreateExtrapolation method.

Note:
CSLExtrapolation is not supported by SI3D
See also:
CSLActionClip

CSLTimeControl

Member Enumeration Documentation

enum EExtrapolationType

Defines the type of extrapolation to perform

Enumerator:
SI_NO_CONTRIBUTION  Results in no extrapolation. Use this to delete an extrapolation.
SI_HOLD  Results in the first or last values being held for the number of frames specified by CSLExtrapolation::GetValue.
SI_CYCLE  Repeats the clip for the number of times specified by CSLExtrapolation::GetValue.
SI_BOUNCE  Repeats the clip forward, then backward, and so on for the number of times specified by CSLExtrapolation::GetValue.

Constructor & Destructor Documentation

CSLExtrapolation ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate,
EExtrapolationType  in_Type = CSLExtrapolation::SI_NO_CONTRIBUTION  
)

Constructor

Parameters:
in_pScene  The scene containing this template
in_pModel  The parent model containing this template
in_pTemplate  The actual template the defines the extrapolation type
in_Type  Default extrapolation type to use

Member Function Documentation

CSLTemplate::ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::XSI_EXTRAPOLATION 

Implements CSLTemplate.

EExtrapolationType GetExtrapolationType (  ) 

Gets the extrapolation type

Returns:
Type of extrapolation

SI_Void SetExtrapolationType ( CSLExtrapolation::EExtrapolationType  in_Type  ) 

Sets the extrapolation type

Returns:
in_Type New type of extrapolation

SI_Float GetValue (  ) 

Gets the extrapolation value

Returns:
Extrapolation value
Note:
The meaning of the value changes according to the extrapolation type
See also:
CSLExtrapolation::EExtrapolationType

SI_Void SetValue ( SI_Float  in_fValue  ) 

Sets the extrapolation value

Returns:
in_fValue New extrapolation value
Note:
The meaning of the value changes according to the extrapolation type.
See also:
CSLExtrapolation::EExtrapolationType

The documentation for this class was generated from the following file: