CSLConstrainableType Class Reference

Base class for all templates supporting constraints. More...

#include <ConstrainableType.h>

Inheritance diagram for CSLConstrainableType:

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

Public Member Functions
virtual CSLConstraint *  AddConstraint (CSLConstraint::EConstraintType in_ConstraintType)=0
SI_Error  RemoveConstraint (SI_Int in_nIndex)
SI_Error  RemoveConstraint (CSLConstraint *in_pToRemove)
SI_Int  GetConstraintCount ()
CSLConstraint **  GetConstraintList ()
SI_Error  ClearConstraints ()
CSLConstraint *  ConnectConstraint (CSLConstraint *in_pNewConstraint)

Detailed Description

Base class for all templates supporting constraints.

Member Function Documentation

virtual CSLConstraint* AddConstraint ( CSLConstraint::EConstraintType  in_ConstraintType  )  [pure virtual]

Adds a constraint to the constraint list

Parameters:
[in]  in_ConstraintType  Type of constraint to add
Returns:
Pointer to the newly added constraint

Implemented in CSLCamera, CSLLight, and CSLModel.

SI_Error RemoveConstraint ( SI_Int  in_nIndex  ) 

Removes a constraint from the constraint list

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

SI_Error RemoveConstraint ( CSLConstraint *  in_pToRemove  ) 

Removes a constraint from the constraint list

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

SI_Int GetConstraintCount (  ) 

Returns the total number of constraints in the constraints list

Returns:
Number of constraints

CSLConstraint** GetConstraintList (  ) 

Returns a pointer to the internally-stored constraint pointer list

Returns:
Pointer to the list

SI_Error ClearConstraints (  ) 

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

Returns:
Whether or not removal was a success

CSLConstraint* ConnectConstraint ( CSLConstraint *  in_pNewConstraint  ) 

Adds a reference to an existing constraint

Parameters:
[in]  in_pNewConstraint  Pointer to the new object to refer to
Returns:
Pointer to the new reference

The documentation for this class was generated from the following file: