Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLVariantParameter Class Reference

#include <VariantParameter.h>

Inheritance diagram for CSLVariantParameter::

CSLAnimatableType CSLCustomParameter List of all members.

Public Methods


Detailed Description

Class CSLVariantParameter

Class representing variant parameters

See also:
CSLCustomPSet


Constructor & Destructor Documentation

CSLVariantParameter::CSLVariantParameter CdotXSITemplate   in_pTemplate,
SI_Int    in_nValueIndex
 

Constructor

Parameters:
in_pTemplate  Parent Template
m in_nValueIndex Index


Member Function Documentation

virtual CSLXSICustomParamInfo* CSLVariantParameter::CustomParamInfo   [inline, virtual]
 

Gets custom parameter information

Return values:
NULL 
Note:
A CSLVariantParameter cannot contain custom parameter information.

Reimplemented in CSLCustomParameter.

SI_Float CSLVariantParameter::GetFloatValue   [virtual]
 

Converts the value of the referred parameter to float

Returns:
The converted value

Reimplemented from CSLAnimatableType.

SI_Char * CSLVariantParameter::GetName  
 

Gets the name of the parameter

Returns:
SI_Char String representing the name of the parameter

SI_TinyVariant * CSLVariantParameter::GetValue  
 

Gets the stored value

Returns:
SI_TinyVariant Pointer to the stored value

SI_Void CSLVariantParameter::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.

SI_Void CSLVariantParameter::SetName SI_Char *    in_szName
 

Sets the name of the parameter

Parameters:
in_szName  New name for the parameter

SI_Void CSLVariantParameter::SetValue SI_TinyVariant   in_pNewVal
 

Sets the stored value

Returns:
in_pNewVal Pointer to the new value to store

CSLVariantParameter::EElementType CSLVariantParameter::Type   [inline, virtual]
 

Returns the animatable type type (SI_VARIANT_TYPE)

Returns:
CSLVariantParameter::EElementType Type of this element (SI_VARIANT_TYPE)

Reimplemented from CSLAnimatableType.

CSLAnimatableType::EElementType CSLVariantParameter::ValueType  
 

Returns:
CSLAnimatableType::EElementType The type stored in the variant


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.