Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLCustomPSet Class Reference

Class representing customer parameter sets. More...

#include <CustomPSet.h>

Inheritance diagram for CSLCustomPSet::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Class representing customer parameter sets.


Member Enumeration Documentation

enum CSLCustomPSet::EPropagationType
 

Defines the various propagation types.

Enumeration values:
SI_BRANCH  Branch propagation
SI_NODE  Node propagation
SI_INHERITED  Inherited propagation


Constructor & Destructor Documentation

CSLCustomPSet::CSLCustomPSet CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate
 

Constructor

Parameters:
in_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  Refered template
Returns:
an instance of CSLCustomPSet


Member Function Documentation

CSLVariantParameter * CSLCustomPSet::AddParameter  
 

Add a parameter to the parameter list

Returns:
CSLParameter Pointer to the newly added parameter

SI_Error CSLCustomPSet::ClearParameters  
 

Removes all connections points from the parameter list

Returns:
SI_Error Whether or not the list could be cleared

CSLXSICustomParamInfo * CSLCustomPSet::ConnectCustomParamInfo CSLXSICustomParamInfo   in_pToConnect
 

Connects custom parameter information

Parameters:
in_pToConnect  Pointer to the custom parameter information
Returns:
CSLXSICustomParamInfo Pointer to the newly connected parameter information or null if the refered parameter does not exist or if there's already a custom parameter information
Note:
Introduced in 3.6

CSLVariantParameter * CSLCustomPSet::ConnectParameter CSLVariantParameter   in_pToConnect
 

Adds an exisiting parameter to the parameter list

Parameters:
in_pToConnect  Pointer to the parameter to add
Returns:
The added parameter or null if it already exists in the list

CSLXSICustomParamInfo * CSLCustomPSet::CreateCustomParamInfo SI_Int    in_nIndex
 

Creates a new custom parameter information

Parameters:
in_nIndex  Index of the parameter where to attach the new custom parameter information
Returns:
CSLXSICustomParamInfo Pointer to the new custom parameter information or null creation could not be done
Note:
Introduced in 3.6

SI_Int CSLCustomPSet::GetParameterCount  
 

Gets the total number of parameters

Returns:
SI_Int Number of parameters

CSLVariantParameter ** CSLCustomPSet::GetParameterList  
 

Gets a pointer to the internally-stored parameter pointer list

Returns:
CSLParameter Pointer to the list

CSLCustomPSet::EPropagationType CSLCustomPSet::GetPropagationType  
 

Get the propagation type.

Returns:
EPropagationType The propagation type

CSLAnimatableType * CSLCustomPSet::ParameterFromName SI_Char *    in_szName [virtual]
 

Searches for a parameter by name

Parameters:
in_szName  Name of the parameter to look for
Returns:
CSLAnimatableType Pointer to the found parameter or null if not found

Reimplemented from CSLTemplate.

CSLAnimatableType * CSLCustomPSet::ParameterFromType EFCurveType    in_Type,
SI_Char *    in_szParameterName
[virtual]
 

Searches for a parameter by name and type

Parameters:
in_Type  Type of the parameter to look for
in_szName  Name of the parameter to look for
Returns:
CSLAnimatableType Pointer to the found parameter or null if not found

Reimplemented from CSLTemplate.

SI_Error CSLCustomPSet::RemoveParameter CSLVariantParameter   in_pToRemove
 

Removes a parameter from the parameter list

Parameters:
in_pToRemove  Pointer to the parameter to remove
Returns:
SI_Error Whether or not the parameter could be removed

SI_Error CSLCustomPSet::RemoveParameter SI_Int    in_nIndex
 

Removes a parameter from the parameter list

Parameters:
in_nIndex  Index of the parameter to remove
Returns:
SI_Error Whether or not the parameter could be removed

SI_Void CSLCustomPSet::SetPropagationType CSLCustomPSet::EPropagationType    in_PropagationType
 

Set the propagation type.

Parameters:
in_PropagationType  New type of propagation tp use
Returns:
SI_Void

SI_Error CSLCustomPSet::Synchronize   [virtual]
 

Commit the current template information

Returns:
SI_Error Whether or not the commit was successful

Reimplemented from CSLTemplate.

virtual ETemplateType CSLCustomPSet::Type   [inline, virtual]
 

Returns the type of this template (SI_CUSTOM_PSET)

Returns:
CSLTemplate::ETemplateType The type of this template (SI_CUSTOM_PSET)

Reimplemented from CSLTemplate.


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.