Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLCluster Class Reference

Describes a cluster. More...

#include <Cluster.h>

Inheritance diagram for CSLCluster::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Describes a cluster.


Member Typedef Documentation

typedef CSLArrayProxy<SI_Int, SI_Int, 1> CSLCluster::CSLIntArray
 

Proxy class that allows modifying a list of SI_Int like an array.


Member Enumeration Documentation

enum CSLCluster::EClusterWeightingType
 

The EClusterWeightingType enum contains possible weighting types for a cluster

Enumeration values:
SI_AVERAGE  The cluster uses an averaging function to determine weights
SI_ADDITIVE  The cluster uses an additive function to determine weights


Constructor & Destructor Documentation

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

Constructor

Parameters:
in_pScene  Pointer to the scene containing the Cluster
in_pModel  Pointer to the model containing the Cluster
in_pTemplate  Pointer to the CdotXSITemplate containing the Cluster
Returns:
an instance of CSLCluster

CSLCluster::~CSLCluster   [virtual]
 

Destructor


Member Function Documentation

CSLUserDataList * CSLCluster::AddUserDataList  
 

Adds an user data list to the user data lists

Returns:
CSLUserDataList Pointer to the newly added UserDataList

SI_Error CSLCluster::ClearUserDataLists  
 

Removes all connections points from the user data lists

Returns:
SI_Error Whether or not the list could be cleared

CSLBaseShape * CSLCluster::ConnectShape CSLBaseShape   in_pNewShape
 

Connects a shape to that cluster

Parameters:
in_pNewShape  New shape to connect
Returns:
CSLBaseShape* a pointer to the connected shape

CSLUserDataList * CSLCluster::ConnectUserDataList CSLUserDataList   in_pNewUserDataList
 

Adds an exisiting user data list to the user data lists

Parameters:
in_pToConnect  Pointer to the user data list to add
Returns:
The added user data list or NULL if it already exists in the list

CSLBaseShape * CSLCluster::CreateShape  
 

Create a new shape for the cluster.

Returns:
CSLBaseShape* Newly creates shape object.

SI_Error CSLCluster::DestroyShape  
 

Destroy the shape of the cluster.

Returns:
SI_Error Error code.

CSLUserDataList * CSLCluster::FindUserDataList SI_Char *    in_szName
 

Searches for a given user data list

Parameters:
in_szUserDataListName  Name of the user data list to look for
Returns:
CSLUserDataList Pointer to the user data list or null if it cannot be found

CSLModel * CSLCluster::GetCenter  
 

Return the center of the cluster.

Returns:
CSLModel* Pointer to the cluster center model.

CSLModel * CSLCluster::GetReference  
 

Return the model possessing this cluster.

Returns:
CSLModel* Pointer to the model that has this cluster

SI_Int CSLCluster::GetUserDataListCount  
 

Gets the total number of user data lists

Returns:
SI_Int Number of user data lists

CSLUserDataList ** CSLCluster::GetUserDataLists  
 

Gets a pointer to the internally-stored user data list pointer list

Returns:
CSLUserDataList Pointer to the list

SI_Int CSLCluster::GetVertexIndicesCount  
 

Return the number of vertex indices.

Returns:
SI_Int Number of vertex index.

CSLCluster::CSLIntArray * CSLCluster::GetVertexIndicesList  
 

Return the vertex indices in an array proxy.

Returns:
CSLIntArray* Pointer to an array proxy of vertex indices.

SI_Int * CSLCluster::GetVertexIndicesListPtr  
 

Returns an array of SI_Int containing the vertex indices.

Returns:
SI_Int* Array of vertex indices.

CSLCluster::EClusterWeightingType CSLCluster::GetWeightingType  
 

Return the type of weighting for the cluster.

Returns:
EClusterWeightingType Type of weighting.

SI_Error CSLCluster::RemoveUserDataList CSLUserDataList   in_pUserDataList
 

Removes an user data list from the user data lists

Parameters:
in_pToRemove  Pointer to the user data list to remove
Returns:
SI_Error Whether or not the user data list could be removed

SI_Error CSLCluster::RemoveUserDataList SI_Int    in_nIndex
 

Removes an user data list from the user data lists

Parameters:
in_nIndex  Index of the UserDataList to remove
Returns:
SI_Error Whether or not the user data list could be removed

SI_Void CSLCluster::SetCenter CSLModel   in_pNewCenter
 

Change the center of the cluster.

Parameters:
CSLModel  * New cluster center object.
Returns:
SI_Void

SI_Void CSLCluster::SetWeightingType EClusterWeightingType    in_Type
 

Change the type of weighting of the cluster.

Parameters:
EClusterWeightingType  New weighting type.
Returns:
SI_Void

CSLBaseShape * CSLCluster::Shape  
 

Return the shape of the cluster.

Returns:
CSLBaseShape* Pointer to a shape object.

SI_Error CSLCluster::Synchronize   [virtual]
 

Synchronizes this cluster instance with its IO layer representation

Returns:
SI_Error
Return values:
SI_SUCCESS  this function always returns SI_SUCCESS

Reimplemented from CSLTemplate.

virtual ETemplateType CSLCluster::Type   [inline, virtual]
 

Get the template type

Returns:
ETemplateType the template type of the cluster

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.