Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLModel Class Reference

Handles the Model template. More...

#include <Model.h>

Inheritance diagram for CSLModel::

CSLTemplate CSLConstrainableType CSIBCNode List of all members.

Public Methods


Detailed Description

Handles the Model template.


Constructor & Destructor Documentation

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

Constructor

Parameters:
in_pScene  Parent Scene
in_pModel  Parent Model
in_pTemplate  Parent Template
Returns:
an instance of CSLModel


Member Function Documentation

CSLModel * CSLModel::AddCamera  
 

Adds a camera to the children list

Returns:
Pointer to the new children

CSLCluster * CSLModel::AddCluster  
 

Add a cluster to the cluster list

Returns:
CSLCluster Pointer to the newly added cluster

CSLConstraint * CSLModel::AddConstraint CSLConstraint::EConstraintType    in_ConstraintType [virtual]
 

Add a constraint to the constraint list

Returns:
CSLConstraint Pointer to the newly added constraint

Reimplemented from CSLConstrainableType.

CSLModel * CSLModel::AddCurveList  
 

Adds a curve list to the children list

Returns:
Pointer to the new children

CSLModel * CSLModel::AddDirectionalLight  
 

Adds a directional light to the children list

Returns:
Pointer to the new children

CSLFXTree * CSLModel::AddFXTree  
 

Adds an FX tree to the FX tree list

Returns:
CSLFXTree Pointer to the newly added FX tree

SI_Error CSLModel::AddGlobalMaterial  
 

Adds a new GlobalMaterial to this model

Returns:
Success or Error

CSLModel * CSLModel::AddIKChain SI_Int    in_nNbJoints
 

Adds an IK Chain to the children list

Returns:
Pointer to the new children

CSLModel * CSLModel::AddInfiniteLight  
 

Adds an infinite light to the children list

Returns:
Pointer to the new children

CSLModel * CSLModel::AddInstance  
 

Adds an instance to the children list

Returns:
Pointer to the new children

CSLModel * CSLModel::AddMesh  
 

Adds a mesh to the children list

Returns:
Pointer to the new children

CSLModel * CSLModel::AddModel  
 

Adds a model to the children list

Returns:
Pointer to the new children

CSLModel * CSLModel::AddNull  
 

Adds a null object to the children list

Returns:
Pointer to the new children

CSLModel* CSLModel::AddPatch  
 

Adds a patch to the children list

Returns:
Pointer to the new children

CSLModel * CSLModel::AddPointLight  
 

Adds a point light to the children list

Returns:
Pointer to the new children

CSLModel * CSLModel::AddSpotLight  
 

Adds a spot light to the children list

Returns:
Pointer to the new children

CSLModel * CSLModel::AddSurfaceMesh  
 

Adds a surface mesh to the children list

Returns:
Pointer to the new children

SI_Error CSLModel::ClearChildren  
 

Deallocates all the children of the model

Returns:
SI_Error Whether or not clearance was a success

SI_Error CSLModel::ClearClusters  
 

Removes all clusters from the internally-stored list and deallocate them

Returns:
SI_Error Whether or not removal was a success

SI_Error CSLModel::ClearFXTrees  
 

Removes all connections points from the FX tree list

Returns:
SI_Error Whether or not the list could be cleared

CSLTransform * CSLModel::ConnectBasePose CSLTransform   in_pNewBasePose
 

Connects to an existing base position

Parameters:
in_pNewBasePose  Pointer to the base pose to connect
Returns:
CSLTransform Pointer to the newly connected base pose

CSLCluster * CSLModel::ConnectCluster CSLCluster   in_pNewCluster
 

Adds a reference to an existing cluster

Parameters:
in_pNewCluster  Pointer to the new object to refer to
Returns:
Pointer to the new reference

CSLEnvelope * CSLModel::ConnectEnvelope CSLEnvelope   in_pNewEnvelope
 

Adds a reference to an existing envelope

Parameters:
in_pNewCluster  Pointer to the new object to refer to
Returns:
Pointer to the new reference

CSLFXTree * CSLModel::ConnectFXTree CSLFXTree   in_pNewFXTree
 

Adds an exisiting FX tree to the FX tree list

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

CSLGlobalMaterial * CSLModel::ConnectGlobalMaterial CSLGlobalMaterial   in_pNew
 

Connects to an existing global material

Parameters:
in_pNewGlobalMaterial  Pointer to the global material to connect
Returns:
CSLGlobalMaterial Pointer to the newly connected global material

CSLMixer * CSLModel::ConnectMixer CSLMixer   in_pNewMixer
 

Connects a mixer to the model

Parameters:
in_pNewMixer  Mixer to connect
Returns:
CSLMixer Pointer to the newly connected mixer

CSLModel * CSLModel::ConnectModel CSLModel *    in_pModel
 

Connects to an existing model

Parameters:
in_pNewModel  Pointer to the model to connect
Returns:
CSLModel Pointer to the newly connected model

CSLPrimitive * CSLModel::ConnectPrimitive CSLPrimitive   in_pNewPrimitive
 

Connects to an existing primitive

Parameters:
in_pNewPrimitive  Pointer to the primitive to connect
Returns:
CSLPrimitive Pointer to the newly connected primitive

CSLTransform * CSLModel::ConnectTransform CSLTransform   in_pNewTransform
 

Connects to an existing transform

Parameters:
in_pNewTransform  Pointer to the transform to connect
Returns:
CSLTransform Pointer to the newly connected transform

CSLVisibility * CSLModel::ConnectVisibility CSLVisibility   in_pNewVisibility
 

Connects to an existing visibility

Parameters:
in_pNewVisibility  Pointer to the visibility to connect
Returns:
CSLVisibility Pointer to the newly connected visibility

CSLTransform * CSLModel::CreateBasePose  
 

Allocates and connects a new base position to the model

Returns:
CSLTransform Pointer to the newly allocated base position

CSLMixer * CSLModel::CreateMixer  
 

Allocates and connects a new mixer to the model

Returns:
CSLMixer Pointer to the newly allocated mixer

SI_Error CSLModel::DestroyBasePose  
 

Deallocates the base position

Returns:
SI_Error Whether or not the base position was removed

SI_Error CSLModel::DestroyMixer  
 

Deallocates the mixer

Returns:
SI_Error Whether or not the mixer was removed

CSLFXTree * CSLModel::FindFXTree SI_Char *    in_szName
 

Searches for a given FX tree

Parameters:
in_szFXTreeName  Name of the FX tree to look for
Returns:
CSLFXTree Pointer to the FX tree or null if it cannot be found

SI_Error CSLModel::Fix   [virtual]
 

Fixes all problems in the model to ensure it is valid

Returns:
SI_Error Whether or not the model could be fixed

Reimplemented from CSLTemplate.

CSLTransform * CSLModel::GetBasePose  
 

Returns the base position

Returns:
CSLTransform Pointer to the base position

SI_Int CSLModel::GetChildrenCount  
 

Gets the number of children

Returns:
SI_Int Number of children

CSLModel ** CSLModel::GetChildrenList  
 

Gets the children of the model

Returns:
CSLModel List of the children

SI_Int CSLModel::GetClusterCount  
 

Gets the total number of clusters in the cluster list

Returns:
Number of clusters

CSLCluster ** CSLModel::GetClusterList  
 

Gets a pointer to the internally-stored cluster pointer list

Returns:
CSLCluster Pointer to the list

SI_Int CSLModel::GetEnvelopeCount  
 

Gets the total number of envelopes in the envelope list

Returns:
Number of envelopes

CSLEnvelope ** CSLModel::GetEnvelopeList  
 

Gets a pointer to the internally-stored envelope pointer list

Returns:
CSLEnvelope Pointer to the list

SI_Int CSLModel::GetFXTreeCount  
 

Gets the total number of FXTrees

Returns:
SI_Int Number of FXTrees

CSLFXTree ** CSLModel::GetFXTreeList  
 

Gets a pointer to the internally-stored FX tree pointer list

Returns:
CSLFXTree Pointer to the list

CSLTemplate::ETemplateType CSLModel::GetPrimitiveType  
 

Returns the primitive type of this model

Returns:
ETemplateType Type of the primitive

CSLGlobalMaterial * CSLModel::GlobalMaterial  
 

Returns the global material

Returns:
CSLGlobalMaterial Pointer to the global material

CSLMixer * CSLModel::Mixer  
 

Returns the mixer

Returns:
CSLMixer Pointer to the mixer

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

Gets a handle on one of this model's parameters by using its name

Parameters:
in_szName  the name of the parameter to get the handle from
Returns:
CSLAnimatableType* the handle to the parameter

Reimplemented from CSLTemplate.

CSLModel * CSLModel::Parent  
 

Returns the parent of the model

Returns:
CSLModel Pointer to the parent

CSLPrimitive * CSLModel::Primitive  
 

Returns the primitive of the model

Returns:
CSLPrimitive Pointer to the primitive

SI_Error CSLModel::RemoveChild SI_Int    in_nIndex
 

Removes a child

Parameters:
in_nIndex  Index of the child to remove
Returns:
SI_Error Whether or not removal was a success

SI_Error CSLModel::RemoveChild CSLModel *    in_pChild
 

Removes a child

Parameters:
in_pChild  Pointer to the child to remove
Returns:
SI_Error Whether or not removal was a success

SI_Error CSLModel::RemoveCluster CSLCluster   in_pToRemove
 

Removes a cluster from the cluster list

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

SI_Error CSLModel::RemoveCluster SI_Int    in_nIndex
 

Removes a cluster from the cluster list

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

SI_Error CSLModel::RemoveFXTree CSLFXTree   in_pFXTree
 

Removes an FX tree from the FX tree list

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

SI_Error CSLModel::RemoveFXTree SI_Int    in_nIndex
 

Removes an FX tree from the FX tree list

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

SI_Error CSLModel::Reparent CSLModel *    in_pNewParent
 

Sets a new parent for the model

Parameters:
in_pNewParent  The new parent
Returns:
SI_Error Whether or not reparenting was a success

SI_Error CSLModel::Synchronize   [virtual]
 

Updates the template with information from this instance

Returns:
SI_Error Whether or not the template could be updated

Reimplemented from CSLConstrainableType.

CSLTransform * CSLModel::Transform  
 

Returns the transform

Returns:
CSLTransform Pointer to the transform

CSLTemplate::ETemplateType CSLModel::Type   [virtual]
 

Returns the type of this template: SI_Model

Returns:
SI_Model

Reimplemented from CSLTemplate.

SI_Error CSLModel::UnconnectEnvelope CSLEnvelope   in_pToUnconnect
 

Removes the reference to the specified envelope

Parameters:
in_pToUnconnect  Pointer to the envelope whose reference is to be removed
Returns:
SI_Error Whether or not the removal was a success

CSLVisibility * CSLModel::Visibility  
 

Returns visibility \CSLVisibility Pointer to the visibility


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.