# CSLXSILimit Class Reference

`#include <XSILimit.h>`

Inheritance diagram for CSLXSILimit:

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

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_pScene | Pointer to the scene
  | in_pModel | Pointer to the model
  | in_pTemplate | Pointer to the CdotXSITemplate

## Member Function Documentation

ETemplateType Type | ( |  | ) | `[inline, virtual]`

Indicate which dotXSI template this object describes.

Returns:
  ETemplateType Type of template

Implements CSLTemplate.

CSLAnimatableType* GetParameter | ( |  | ) |

Returns the parameter connected to this limit.

Returns:
  CSLAnimatableType* Pointer to a parameter proxy.

CSLAnimatableType* ConnectParameter | ( | CSLAnimatableType * | in_pNewParameter | ) |

Connects a previously allocated parameter

Parameters:

  | in_pNewParameter | Parameter to connect

Return values:

  | CSLAnimatableType* | The connected parameter (`in_pNewParameter`)
  | NULL | A parameter was already connected.

virtual SI_Float GetMinimum | ( |  | ) | `[virtual]`

Gets the minimum value

Return values:

  | SI_Float |

virtual SI_Void SetMinimum | ( | SI_Float | in_fMin | ) | `[virtual]`

Sets the minimum value

Parameters:

  | in_fMin | The minimum value.

virtual SI_Float GetMaximum | ( |  | ) | `[virtual]`

Gets the maximum value

Return values:

  | SI_Float |

virtual SI_Void SetMaximum | ( | SI_Float | in_fMax | ) | `[virtual]`

Sets the maximum value

Parameters:

  | in_fMax | The maximum value.

virtual SI_Bool GetMinimumActive | ( |  | ) | `[virtual]`

Gets the Minimum active value

Return values:

  | SI_Bool |

virtual SI_Void SetMinimumActive | ( | SI_Bool | in_bActive | ) | `[virtual]`

Sets the Minimum active value

Parameters:

  | in_bActive | Activeness.

virtual SI_Bool GetMaximumActive | ( |  | ) | `[virtual]`

Gets the Maximum active value

Return values:

  | SI_Bool |

virtual SI_Void SetMaximumActive | ( | SI_Bool | in_bActive | ) | `[virtual]`

Sets the Maximum active value

Parameters:

  | in_bActive | Activeness.

SI_Char* GetParameterName | ( |  | ) |

Gets the name of the parameter

Returns:
  SI_Char* The name.

SI_Void SetParameterName | ( | SI_Char * | in_szParameterName | ) |

Sets the name of the parameter

Parameters:

  | in_szParameterName | The name.

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

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

Parameters:

  | in_pParameter | The sub parameter

Returns:
  SI_Char* Name of the sub parameter.

Reimplemented from CSLTemplate.

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

Searches for a parameter by name

Parameters:

  | in_szName | Name of the parameter to look for

Returns:
  CSLAnimatableType 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_Type | Type of the parameter to look for
  | in_szName | Name of the parameter to look for

Returns:
  CSLAnimatableType 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 if the parameter is not connected

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

- XSILimit.h