CSLVariantParameter Class Reference

Represents variant parameters. More...

#include <VariantParameter.h>

Inheritance diagram for CSLVariantParameter:

CSLAnimatableType CSLCustomParameter List of all members.

Public Member Functions
  CSLVariantParameter (CdotXSITemplate *in_pTemplate, SI_Int in_nValueIndex)
virtual  ~CSLVariantParameter ()
  Destructor.
CSLAnimatableType::EElementType  ValueType ()
SI_Void  SetValue (SI_TinyVariant *in_pNewVal)
virtual CSLVariantParameter::EElementType  Type ()
virtual CSLXSICustomParamInfo *  CustomParamInfo ()
virtual SI_Float  GetFloatValue ()
virtual SI_Void  SetFloatValue (SI_Float in_fValue)

Detailed Description

Represents variant parameters.

See also:
CSLCustomPSet

Constructor & Destructor Documentation

CSLVariantParameter ( CdotXSITemplate *  in_pTemplate,
SI_Int  in_nValueIndex  
)

Constructor

Parameters:
[in]  in_pTemplate  Parent Template
[in]  in_nValueIndex  Index

Member Function Documentation

CSLAnimatableType::EElementType ValueType (  ) 

Constructor

Returns:
The type stored in the variant

SI_Void SetValue ( SI_TinyVariant *  in_pNewVal  ) 

Sets the stored value

Parameters:
[in]  in_pNewVal  Pointer to the new value to store

virtual CSLVariantParameter::EElementType Type (  )  [inline, virtual]

Returns the animatable type of this element

Return values:
CSLVariantParameter::SI_VARIANT_TYPE  Type of this element

Implements CSLAnimatableType.

virtual CSLXSICustomParamInfo* CustomParamInfo (  )  [inline, virtual]

Returns custom parameter information

Note:
A CSLVariantParameter cannot contain custom parameter information.
Return values:
NULL 

Reimplemented in CSLCustomParameter.

virtual SI_Float GetFloatValue (  )  [virtual]

Converts the value of the referred parameter to float

Returns:
The converted value

Implements CSLAnimatableType.

virtual SI_Void SetFloatValue ( SI_Float  in_fValue  )  [virtual]

Sets the value of the referred parameter from a float

Parameters:
[in]  in_fValue  The float value used to set the parameter

Implements CSLAnimatableType.

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