# CSLIntProxy Class Reference

Class that allows modification of an integer parameter in a template. More...

`#include <SL_Int.h>`

Inheritance diagram for CSLIntProxy:

List of all members.

## Public Member Functions
| CSLIntProxy (SI_Int *in_pValue)
| CSLIntProxy (CdotXSITemplate *in_pTemplate, SI_Int in_nIndex)
| CSLIntProxy ()
CSLIntProxy & | operator= (const CSLIntProxy &in_Value)
CSLIntProxy & | operator= (const SI_Int &in_Value)
SI_Bool | operator== (const CSLIntProxy &in_ToCompare)
SI_Bool | operator== (const SI_Int &in_ToCompare)
| operator SI_Int ()
| Conversion operator.
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 an integer parameter in a template.

## Constructor & Destructor Documentation

CSLIntProxy | ( | SI_Int * | in_pValue | ) |

Constructor. Creates a proxy to `in_pValue`

Parameters:

  | in_pValue | Pointer to the value to access/modify trough this proxy

CSLIntProxy | ( | CdotXSITemplate * | in_pTemplate,
|  | SI_Int | in_nIndex |
| ) |  |  |

Constructor. Connects to a parameter in the parent template

Parameters:

  | in_pTemplate | Pointer to the parent template
  | in_Index | Index of the parameter in the template

CSLIntProxy | ( |  | ) |

Constructor Creates an unconnected proxy

## Member Function Documentation

CSLIntProxy& operator= | ( | const CSLIntProxy & | in_Value | ) |

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

Parameters:

  | in_Value | The new value

Returns:
  Reference to the current object.

CSLIntProxy& operator= | ( | const SI_Int & | in_Value | ) |

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

Parameters:

  | in_Value | The new value

Returns:
  Reference to the current object.

SI_Bool operator== | ( | const CSLIntProxy & | in_ToCompare | ) |

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

Parameters:

  | 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_Int & | in_ToCompare | ) |

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

Parameters:

  | in_ToCompare | The instance to compare values with

Returns:
  Whether or not the referred parameter and `in_ToCompare` are equal

virtual EElementType Type | ( |  | ) | `[virtual]`

Returns the animatable type of this class

Returns:
  CSLAnimatableType::SI_INT_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_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_pTemplate | Parent template
  | in_nIndex | Index of the parameter in the parent template

Return values:

  | SI_SUCCESS |

Reimplemented from CSLAnimatableType.

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

- SL_Int.h