CSLBoolProxy Class Reference

Class that allows modification of a boolean parameter in a template. More...

#include <SL_Bool.h>

Inheritance diagram for CSLBoolProxy:

CSLAnimatableType List of all members.

Public Member Functions
  CSLBoolProxy (CdotXSITemplate *in_pTemplate, SI_Int in_nIndex)
CSLBoolProxy &  operator= (const CSLBoolProxy &in_Value)
CSLBoolProxy &  operator= (const SI_Bool &in_Value)
SI_Bool  operator== (const CSLBoolProxy &in_ToCompare)
SI_Bool  operator== (const SI_Bool &in_ToCompare)
  operator SI_Bool ()
virtual EElementType  Type ()
virtual SI_Float  GetFloatValue ()
virtual SI_Void  SetFloatValue (SI_Float in_fValue)
virtual SI_Error  Connect (CdotXSITemplate *in_pTemplate, SI_Int in_nIndex)

Detailed Description

Class that allows modification of a boolean parameter in a template.

Constructor & Destructor Documentation

CSLBoolProxy ( CdotXSITemplate *  in_pTemplate,
SI_Int  in_nIndex  
)

Constructor. Connects to a boolean parameter in a template

Parameters:
[in]  in_pTemplate  Pointer to the template
[in]  in_nIndex  Index of the parameter in the template

Member Function Documentation

CSLBoolProxy& operator= ( const CSLBoolProxy &  in_Value  ) 

Assignment operator. Assigns in_Value to the parameter referred by this proxy.

Parameters:
[in]  in_Value  The new value
Returns:
Reference to the current object.

CSLBoolProxy& operator= ( const SI_Bool &  in_Value  ) 

Assignment operator. Assigns in_Value to the parameter referred by this proxy.

Parameters:
[in]  in_Value  The new value
Returns:
Reference to the current object.

SI_Bool operator== ( const CSLBoolProxy &  in_ToCompare  ) 

Comparison operator. Compares in_ToCompare with the value of the parameter referred by this proxy.

Parameters:
[in]  in_ToCompare  The instance to compare values with
Returns:
Whether or not the referred parameter and in_ToCompare are equal

SI_Bool operator== ( const SI_Bool &  in_ToCompare  ) 

Comparison operator. Compares in_ToCompare with the value of the parameter referred by this proxy.

Parameters:
[in]  in_ToCompare  The instance to compare values with
Returns:
Whether or not the referred parameter and in_ToCompare are equal

operator SI_Bool (  ) 

Conversion operator.

virtual EElementType Type (  )  [virtual]

Returns the animatable type of this class

Returns:
CSLAnimatableType::SI_BOOL_TYPE Animatable type

Implements CSLAnimatableType.

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.

virtual SI_Error Connect ( CdotXSITemplate *  in_pTemplate,
SI_Int  in_nIndex  
) [virtual]

Connects the proxy to a parameter of a template

Parameters:
[in]  in_pTemplate  Parent template
[in]  in_nIndex  Index of the parameter in the parent template
Return values:
SI_Error::SI_SUCCESS 

Reimplemented from CSLAnimatableType.

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