Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLAnimatableType Class Reference

Base class for animatable types. More...

#include <AnimatableType.h>

Inheritance diagram for CSLAnimatableType::

CSLBoolProxy CSLByteProxy CSLDoubleProxy CSLEnumProxy CSLFloatProxy CSLIntProxy CSLLongProxy CSLShortProxy CSLStrEnumProxy CSLUByteProxy CSLULongProxy CSLVariantParameter List of all members.

Public Types

Public Methods

Protected Methods


Detailed Description

Base class for animatable types.

This class is abstract, but it defines basic operations of all animatable sub-classes.


Member Enumeration Documentation

enum CSLAnimatableType::EElementType
 

This enumeration lists all base types supported by animatable types

Enumeration values:
SI_BOOL_TYPE  The element is of type boolean
SI_BYTE_TYPE  The element is of type byte
SI_UBYTE_TYPE  The element is of type unsigned byte
SI_DOUBLE_TYPE  The element is of type double
SI_FLOAT_TYPE  The element is of type float
SI_INT_TYPE  The element is of type integer
SI_LONG_TYPE  The element is of type long
SI_ULONG_TYPE  The element is of type unsigned long
SI_SHORT_TYPE  The element is of type short
SI_VARIANT_TYPE  The element is of type variant
SI_ENUM_TYPE  The element is of type enumeration
SI_STRING_ENUM_TYPE  The element is of type string enumeration


Constructor & Destructor Documentation

CSLAnimatableType::CSLAnimatableType   [protected]
 

Constructor (default). This member is protected so that the class cannot be instantiated.

CSLAnimatableType::~CSLAnimatableType   [protected]
 

Destructor


Member Function Documentation

virtual SI_Float CSLAnimatableType::GetFloatValue   [pure virtual]
 

Converts the value of the referred parameter to float

Returns:
The converted value

Reimplemented in CSLBoolProxy, CSLByteProxy, CSLUByteProxy, CSLDoubleProxy, CSLEnumProxy, CSLStrEnumProxy, CSLFloatProxy, CSLIntProxy, CSLLongProxy, CSLShortProxy, CSLULongProxy, CSLVariantParameter, CSLEnumProxy< EFogInterpolationType, SI_EXPONENTIAL >, CSLEnumProxy< EOutputType, SI_OT_MODEL >, CSLEnumProxy< EMappingType, SI_REFLECTION_MAP >, CSLEnumProxy< EScalingType, SI_CUSTOM >, CSLEnumProxy< EVOrientation, SI_UP >, CSLEnumProxy< EFogType, SI_FOG >, CSLEnumProxy< EBlendingType, SI_RGB_MODULATION >, CSLEnumProxy< ECompressionType, SI_UNCOMPRESSED >, CSLEnumProxy< EWrapType, SI_REPEAT >, CSLEnumProxy< EUOrientation, SI_LEFT >, CSLEnumProxy< EParametrizationType, SI_CENTRIPETAL >, CSLEnumProxy< EActionType, SI_AT_NONE >, CSLEnumProxy< EProjectionType, SI_WORLD >, CSLEnumProxy< EAxisOrientation, SI_OUT >, CSLEnumProxy< EHandRotation, SI_RIGHT_HANDED >, CSLEnumProxy< EFallofMode, SI_EXPONENT >, CSLEnumProxy< EShadingModel, VERTEX_COLOR >, CSLEnumProxy< EAngleType, SI_RADIANS >, CSLEnumProxy< EOutputType, SI_DEFAULT >, CSLStrEnumProxy< ETimingType, SI_FRAMES >, CSLStrEnumProxy< EConstraintType, SI_PREFERED_AXIS >, CSLStrEnumProxy< EPropagationType, SI_INHERITED >, CSLStrEnumProxy< EExtrapolationType, SI_BOUNCE >, CSLStrEnumProxy< EClusterWeightingType, SI_ADDITIVE >, CSLStrEnumProxy< EJointSolverType, SI_3D >, and CSLStrEnumProxy< EFCurveInterpolationType, SI_CUBIC >.

virtual SI_Void CSLAnimatableType::SetFloatValue SI_Float    in_fValue [pure virtual]
 

Sets the value of the referred parameter from a float

Parameters:
in_fValue  The float value used to set the parameter

Reimplemented in CSLBoolProxy, CSLByteProxy, CSLUByteProxy, CSLDoubleProxy, CSLEnumProxy, CSLStrEnumProxy, CSLFloatProxy, CSLIntProxy, CSLLongProxy, CSLShortProxy, CSLULongProxy, CSLVariantParameter, CSLEnumProxy< EFogInterpolationType, SI_EXPONENTIAL >, CSLEnumProxy< EOutputType, SI_OT_MODEL >, CSLEnumProxy< EMappingType, SI_REFLECTION_MAP >, CSLEnumProxy< EScalingType, SI_CUSTOM >, CSLEnumProxy< EVOrientation, SI_UP >, CSLEnumProxy< EFogType, SI_FOG >, CSLEnumProxy< EBlendingType, SI_RGB_MODULATION >, CSLEnumProxy< ECompressionType, SI_UNCOMPRESSED >, CSLEnumProxy< EWrapType, SI_REPEAT >, CSLEnumProxy< EUOrientation, SI_LEFT >, CSLEnumProxy< EParametrizationType, SI_CENTRIPETAL >, CSLEnumProxy< EActionType, SI_AT_NONE >, CSLEnumProxy< EProjectionType, SI_WORLD >, CSLEnumProxy< EAxisOrientation, SI_OUT >, CSLEnumProxy< EHandRotation, SI_RIGHT_HANDED >, CSLEnumProxy< EFallofMode, SI_EXPONENT >, CSLEnumProxy< EShadingModel, VERTEX_COLOR >, CSLEnumProxy< EAngleType, SI_RADIANS >, CSLEnumProxy< EOutputType, SI_DEFAULT >, CSLStrEnumProxy< ETimingType, SI_FRAMES >, CSLStrEnumProxy< EConstraintType, SI_PREFERED_AXIS >, CSLStrEnumProxy< EPropagationType, SI_INHERITED >, CSLStrEnumProxy< EExtrapolationType, SI_BOUNCE >, CSLStrEnumProxy< EClusterWeightingType, SI_ADDITIVE >, CSLStrEnumProxy< EJointSolverType, SI_3D >, and CSLStrEnumProxy< EFCurveInterpolationType, SI_CUBIC >.

virtual EElementType CSLAnimatableType::Type   [pure virtual]
 

Returns the type of this parameter

Returns:
ETemplateType The type of this parameter (Defined by sub-class)

Reimplemented in CSLBoolProxy, CSLByteProxy, CSLUByteProxy, CSLDoubleProxy, CSLEnumProxy, CSLStrEnumProxy, CSLFloatProxy, CSLIntProxy, CSLLongProxy, CSLShortProxy, CSLULongProxy, CSLVariantParameter, CSLEnumProxy< EFogInterpolationType, SI_EXPONENTIAL >, CSLEnumProxy< EOutputType, SI_OT_MODEL >, CSLEnumProxy< EMappingType, SI_REFLECTION_MAP >, CSLEnumProxy< EScalingType, SI_CUSTOM >, CSLEnumProxy< EVOrientation, SI_UP >, CSLEnumProxy< EFogType, SI_FOG >, CSLEnumProxy< EBlendingType, SI_RGB_MODULATION >, CSLEnumProxy< ECompressionType, SI_UNCOMPRESSED >, CSLEnumProxy< EWrapType, SI_REPEAT >, CSLEnumProxy< EUOrientation, SI_LEFT >, CSLEnumProxy< EParametrizationType, SI_CENTRIPETAL >, CSLEnumProxy< EActionType, SI_AT_NONE >, CSLEnumProxy< EProjectionType, SI_WORLD >, CSLEnumProxy< EAxisOrientation, SI_OUT >, CSLEnumProxy< EHandRotation, SI_RIGHT_HANDED >, CSLEnumProxy< EFallofMode, SI_EXPONENT >, CSLEnumProxy< EShadingModel, VERTEX_COLOR >, CSLEnumProxy< EAngleType, SI_RADIANS >, CSLEnumProxy< EOutputType, SI_DEFAULT >, CSLStrEnumProxy< ETimingType, SI_FRAMES >, CSLStrEnumProxy< EConstraintType, SI_PREFERED_AXIS >, CSLStrEnumProxy< EPropagationType, SI_INHERITED >, CSLStrEnumProxy< EExtrapolationType, SI_BOUNCE >, CSLStrEnumProxy< EClusterWeightingType, SI_ADDITIVE >, CSLStrEnumProxy< EJointSolverType, SI_3D >, and CSLStrEnumProxy< EFCurveInterpolationType, SI_CUBIC >.


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.