Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLConstrainableType Class Reference

#include <ConstrainableType.h>

Inheritance diagram for CSLConstrainableType::

CSLCamera CSLLight CSLModel CSLDirectionalLight CSLInfiniteLight CSLPointLight CSLSpotLight List of all members.

Public Methods


Detailed Description

Base classe for all templates supporting constraints


Member Function Documentation

virtual CSLConstraint* CSLConstrainableType::AddConstraint CSLConstraint::EConstraintType    in_ConstraintType [pure virtual]
 

Add a constraint to the constraint list

Returns:
CSLConstraint Pointer to the newly added constraint

Reimplemented in CSLCamera, CSLLight, and CSLModel.

SI_Error CSLConstrainableType::ClearConstraints  
 

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

Returns:
SI_Error Whether or not removal was a success

CSLConstraint * CSLConstrainableType::ConnectConstraint CSLConstraint   in_pNewConstraint
 

Adds a reference to an existing constraint

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

SI_Int CSLConstrainableType::GetConstraintCount  
 

Gets the total number of constraints in the constraints list

Returns:
Number of constraints

CSLConstraint ** CSLConstrainableType::GetConstraintList  
 

Gets a pointer to the internally-stored constraint pointer list

Returns:
CSLConstraint Pointer to the list

SI_Error CSLConstrainableType::RemoveConstraint CSLConstraint   in_pToRemove
 

Removes a constraint from the constraint list

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

SI_Error CSLConstrainableType::RemoveConstraint SI_Int    in_nIndex
 

Removes a constraint from the constraint list

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


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.