CSLStaticValue Class Reference

#include <StaticValue.h>

Inheritance diagram for CSLStaticValue:

CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLStaticValue (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
CSLTemplate::ETemplateType  Type ()
SI_Bool  GetActive ()
SI_Void  SetActive (SI_Bool in_bActive)
SI_Char *  GetParameterName ()
SI_Void  SetParameterName (SI_Char *in_szName)
SI_Float  GetValue ()
SI_Void  SetValue (SI_Float in_fValue)

Detailed Description

Stores a pose (static action--see the SI_ShapeAnimation template reference). You can create a CSLStaticValue with the CSLAction::AddStaticValue method.
See also:
CSLAction

Constructor & Destructor Documentation

CSLStaticValue ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate  
)

Constructor

Parameters:
in_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  Referred template

Member Function Documentation

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

Returns the type of the template

Returns:
CSLTemplate::ETemplateType The type of this template (XSI_STATIC_VALUES)

Implements CSLTemplate.

SI_Bool GetActive (  ) 

Gets whether or not the parameter is active.

Returns:
SI_Bool Value of the flag

SI_Void SetActive ( SI_Bool  in_bActive  ) 

Sets whether or not the parameter is active.

Parameters:
in_bActive  Value of the flag

SI_Char* GetParameterName (  ) 

Gets the name of the parameter

Returns:
SI_Char Name of the parameter

SI_Void SetParameterName ( SI_Char *  in_szName  ) 

Sets the name of the parameter

Parameters:
in_szName  Name of the parameter

SI_Float GetValue (  ) 

Gets the value of the parameter

Returns:
SI_Float Value of the parameter

SI_Void SetValue ( SI_Float  in_fValue  ) 

Sets the value of the parameter

Parameters:
in_fValue  Value of the parameter

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