Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

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 Methods


Detailed Description

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


Constructor & Destructor Documentation

CSLBoolProxy::CSLBoolProxy CdotXSITemplate   in_pTemplate,
SI_Int    in_nIndex
 

Constructor. Connects to a boolean parameter in a template

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


Member Function Documentation

SI_Float CSLBoolProxy::GetFloatValue   [virtual]
 

Converts the value of the referred parameter to float

Returns:
The converted value

Reimplemented from CSLAnimatableType.

CSLBoolProxy::operator SI_Bool  
 

Conversion operator.

CSLBoolProxy & CSLBoolProxy::operator= const SI_Bool &    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.

CSLBoolProxy & CSLBoolProxy::operator= const CSLBoolProxy &    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 CSLBoolProxy::operator== const SI_Bool &    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 CSLBoolProxy::operator== const CSLBoolProxy &    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_Void CSLBoolProxy::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

Reimplemented from CSLAnimatableType.

CSLAnimatableType::EElementType CSLBoolProxy::Type   [virtual]
 

Returns the animatable type of this class

Returns:
CSLAnimatableType::SI_BOOL_TYPE

Reimplemented from CSLAnimatableType.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.