Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLXSICustomParamInfo Class Reference

Provides additional information concerning a specific parameter in a CSLCustomPSet. More...

#include <CustomParamInfo.h>

Inheritance diagram for CSLXSICustomParamInfo::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Provides additional information concerning a specific parameter in a CSLCustomPSet.

The CSLXSICustomParamInfo class enhances the usability of the CSLCustonPSet class by providing minimum and maximum range values of a parameter. It can also be used to define the capabilities of the parameter. You can create a custom parameter information with the CSLCustomPSet::CreateCustomParamInfo method.

See also:
CSLCustomPSet , CSLXSICustomParamInfo::ECapabilitiesFlag


Member Enumeration Documentation

enum CSLXSICustomParamInfo::ECapabilitiesFlag
 

Definition of all possible parameter capabilies flags.

You can use a combination of flags using the bitwise 'or' operator

Example:

Enumeration values:
SI_ANIMATABLE  Animatable
SI_READ_ONLY  Cannot be written to
SI_PERSISTABLE  Is saved with its parameter set
SI_NOT_INSPECTABLE  Does not show up in the UI
SI_SILENT  Does not notify if its value is changed
SI_NOT_PSET_PERSISTABLE  Will not be saved in presets
SI_TEXTURABLE  Parameter support connection to rendering node


Constructor & Destructor Documentation

CSLXSICustomParamInfo::CSLXSICustomParamInfo CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate,
CSLVariantParameter   in_pParameter = 0
 

Constructor

Parameters:
in_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  referred template
in_pParameter  Parameter whose definition is enhanced


Member Function Documentation

SI_ULong CSLXSICustomParamInfo::GetCapabilities  
 

Gets the Capabilities flag value

Returns:
SI_ULong Capabilities flags
You can test for specific capabilities with the bitwise 'and' operator.

Example:

                SI_ULong l_uCapabilities = l_pCustomParamInfo->GetCapabilities();
                // if the paramater is animatable, do something
                if ( CSLXSICustomParamInfo::SI_ANIMATABLE & l_uCapabilities )
                {
                        // Do something
                }

CSLVariantProxy & CSLXSICustomParamInfo::GetMaxValue  
 

Gets the maximum value

Returns:
CSLVariantProxy The maximum value of the parameter

SI_Error CSLXSICustomParamInfo::GetMaxValue SI_TinyVariant   out_Value
 

Gets the maximum value

Parameters:
out_Value  The maximum value of the parameter
Return values:
SI_SUCCESS  Got the maximum value
SI_ERR_BAD_ARGUMENT  The variant type of out_Value does not match the type of the minimum value.

CSLVariantProxy & CSLXSICustomParamInfo::GetMinValue  
 

Gets the minimum value

Returns:
CSLVariantProxy The minimum value of the parameter

SI_Error CSLXSICustomParamInfo::GetMinValue SI_TinyVariant   out_Value
 

Gets the minimum value

Parameters:
out_Value  The minimum value
Return values:
SI_SUCCESS  Got the minimum value
SI_ERR_BAD_ARGUMENT  The variant type of out_Value does not match the type of the minimum value.

SI_Void CSLXSICustomParamInfo::SetCapabilities SI_ULong    in_ulValue
 

Sets the Capabilities flag value.

Parameters:
in_ulValue  New capabilities flags
Please note that in_ulValue must be a combination of valid values coming from the CSLXSICustomParamInfo::ECapabilitiesFlag enum. You can combine values with the bitwise 'or' operator.

Example:

                l_pCustomParamInfo->SetCapabilities
                ( 
                        (SI_ULong)CSLXSICustomParamInfo::SI_ANIMATABLE | 
                        (SI_ULong)CSLXSICustomParamInfo::SI_PERSISTABLE 
                );

SI_Error CSLXSICustomParamInfo::SetMaxValue const SI_TinyVariant   in_Value
 

Sets the maximum value

Parameters:
in_Value  The maximum value
Return values:
SI_SUCCESS  The value was set
SI_ERR_BAD_ARGUMENT  The variant type of in_Value does not match the type of the minimum value.

SI_Error CSLXSICustomParamInfo::SetMaxValue const CSLVariantProxy   in_Value
 

Sets the maximum value

Parameters:
in_Value  The maximum value
Return values:
SI_SUCCESS  The value was set
SI_ERR_BAD_ARGUMENT  The variant type of in_Value does not match the type of the minimum value.

SI_Error CSLXSICustomParamInfo::SetMinValue const SI_TinyVariant   in_Value
 

Sets the minimum value

Parameters:
in_Value  The minimum value
Return values:
SI_SUCCESS  The value was set
SI_ERR_BAD_ARGUMENT  The variant type of in_Value does not match the type of the minimum value.

SI_Error CSLXSICustomParamInfo::SetMinValue const CSLVariantProxy   in_Value
 

Sets the minimum value

Parameters:
in_Value  The minimum value
Return values:
SI_SUCCESS  The value was set
SI_ERR_BAD_ARGUMENT  The variant type of in_Value does not match the type of the minimum value.

SI_Error CSLXSICustomParamInfo::Synchronize   [virtual]
 

Synchronize will ensure that the animated parameter is up to date.

Returns:
SI_Error Error code

Reimplemented from CSLTemplate.

ETemplateType CSLXSICustomParamInfo::Type   [inline, virtual]
 

Returns the type of this template

Returns:
CSLTemplate::XSI_CUSTOM_PARAM_INFO

Reimplemented from CSLTemplate.


Introduced

3.6
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.