CSLXSILimit Class Reference

This class represents an XSI_Limit template. More...

#include <XSILimit.h>

Inheritance diagram for CSLXSILimit:

CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLXSILimit (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLXSILimit ()
  Destructor.
ETemplateType  Type ()
CSLAnimatableType *  GetParameter ()
CSLAnimatableType *  ConnectParameter (CSLAnimatableType *in_pNewParameter)
virtual SI_Float  GetMinimum ()
virtual SI_Void  SetMinimum (SI_Float in_fMin)
virtual SI_Float  GetMaximum ()
virtual SI_Void  SetMaximum (SI_Float in_fMax)
virtual SI_Bool  GetMinimumActive ()
virtual SI_Void  SetMinimumActive (SI_Bool in_bActive)
virtual SI_Bool  GetMaximumActive ()
virtual SI_Void  SetMaximumActive (SI_Bool in_bActive)
SI_Char *  GetParameterName ()
SI_Void  SetParameterName (SI_Char *in_szParameterName)
virtual const SI_Char *  GetParameterName (CSLAnimatableType *in_pParameter)
virtual CSLAnimatableType *  ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType *  ParameterFromType (EFCurveType in_Type, SI_Char *in_szParameterName)
virtual SI_Error  Evaluate ()

Detailed Description

This class represents an XSI_Limit template.

Encapsulates the minimum and maximum limits for dotXSI 5.0+ (see the XSI_Limit template reference).

See also:
CSLAnimatableType

CSLTemplate

Constructor & Destructor Documentation

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

Constructor

Parameters:
[in]  in_pScene  Pointer to the scene
[in]  in_pModel  Pointer to the model
[in]  in_pTemplate  Pointer to the CdotXSITemplate

Member Function Documentation

ETemplateType Type (  )  [inline, virtual]

Returns the type of this template

Return values:
CSLTemplate::XSI_LIMIT  Template type

Implements CSLTemplate.

CSLAnimatableType* GetParameter (  ) 

Returns the parameter connected to this limit.

Returns:
Pointer to a parameter proxy.

CSLAnimatableType* ConnectParameter ( CSLAnimatableType *  in_pNewParameter  ) 

Connects a previously allocated parameter

Parameters:
[in]  in_pNewParameter  Parameter to connect
Returns:
The connected parameter (in_pNewParameter) or NULL if a parameter was already connected.

virtual SI_Float GetMinimum (  )  [virtual]

Returns the minimum value

Returns:
the minimum value

virtual SI_Void SetMinimum ( SI_Float  in_fMin  )  [virtual]

Sets the minimum value

Parameters:
[in]  in_fMin  The minimum value.

virtual SI_Float GetMaximum (  )  [virtual]

Returns the maximum value

Returns:
the maximum value

virtual SI_Void SetMaximum ( SI_Float  in_fMax  )  [virtual]

Sets the maximum value

Parameters:
[in]  in_fMax  The maximum value.

virtual SI_Bool GetMinimumActive (  )  [virtual]

Returns the Minimum active value

Returns:
the minimum active value

virtual SI_Void SetMinimumActive ( SI_Bool  in_bActive  )  [virtual]

Sets the Minimum active value

Parameters:
[in]  in_bActive  Activeness.

virtual SI_Bool GetMaximumActive (  )  [virtual]

Returns the Maximum active value

Returns:
the maximum active value

virtual SI_Void SetMaximumActive ( SI_Bool  in_bActive  )  [virtual]

Sets the Maximum active value

Parameters:
[in]  in_bActive  Activeness.

SI_Char* GetParameterName (  ) 

Returns the name of the parameter

Returns:
The name.

SI_Void SetParameterName ( SI_Char *  in_szParameterName  ) 

Sets the name of the parameter

Parameters:
[in]  in_szParameterName  The name.

virtual const SI_Char* GetParameterName ( CSLAnimatableType *  in_pParameter  )  [virtual]

Returns the name (string) of a specified sub parameter.

Parameters:
[in]  in_pParameter  The sub parameter
Returns:
Name of the sub parameter.

Reimplemented from CSLTemplate.

virtual CSLAnimatableType* ParameterFromName ( SI_Char *  in_szName  )  [virtual]

Searches for a parameter by name

Parameters:
[in]  in_szName  Name of the parameter to look for
Returns:
Pointer to the found parameter or null if not found

Reimplemented from CSLTemplate.

virtual CSLAnimatableType* ParameterFromType ( EFCurveType  in_Type,
SI_Char *  in_szParameterName  
) [virtual]

Searches for a parameter by name and type

Parameters:
[in]  in_Type  Type of the parameter to look for
[in]  in_szParameterName  Name of the parameter to look for
Returns:
Pointer to the found parameter or null if not found

Reimplemented from CSLTemplate.

virtual SI_Error Evaluate (  )  [virtual]

Evaluates this limit

Return values:
SI_Error::SI_SUCCESS  on success
SI_Error::SI_ERROR  if the parameter is not connected

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