Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLConstraint Class Reference

Describes a constraint. More...

#include <Constraint.h>

Inheritance diagram for CSLConstraint::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Describes a constraint.


Member Enumeration Documentation

enum CSLConstraint::EConstraintType
 

The EConstraintType enum contains possible types for a constraint

Enumeration values:
SI_SCALING  Scaling constraint.
SI_ORIENTATION  Orientation constraint.
SI_DIRECTION  Direction constraint.
SI_POSITION  Position constraint.
SI_INTEREST  Interest constraint.
SI_UP_VECTOR  Up Vector constraint.
SI_PREFERED_AXIS  Prefered Axis constraint.


Constructor & Destructor Documentation

CSLConstraint::CSLConstraint CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate,
EConstraintType    in_ConstraintType
 

Constructor

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

CSLConstraint::~CSLConstraint   [virtual]
 

Destructor


Member Function Documentation

SI_Error CSLConstraint::AddConstrainingObject CSLModel   in_pConstrainingObject
 

Add a new constraining object to the constraint.

Parameters:
in_pConstrainingObject  Pointer to the constraining object.
Returns:
SI_Error Error code.

SI_Error CSLConstraint::ClearConstrainingObjects  
 

Remove all constraining objects from the constraint.

Returns:
SI_Error Error code.

CSLModel * CSLConstraint::ConnectConstrainingObject CSLModel   in_pModel
 

Connects with a constraining object

Parameters:
in_pModel  the constraining object to connect to
Returns:
CSLModel* the constraining model

CSLConstraint * CSLConstraint::ConnectUpVector CSLConstraint *    in_pUpVector
 

Connects with an up vector constraint

Parameters:
in_pUpVector  the up vector constraint to connect to
Returns:
CSLConstraint* the up vector constraint

CSLModel ** CSLConstraint::ConstrainingObjects  
 

Return an array of all constraining objects in the constraint.

Returns:
CSLBaseMaterial** Array of pointers to model objects.

CSLConstraint * CSLConstraint::CreateUpVector  
 

Create a up vector constraint on the constraint.

Returns:
CSLConstraint* Newly creates constraint object.

SI_Error CSLConstraint::DestroyUpVector  
 

Destroy the up vector constraint of the constraint.

Returns:
SI_Error Error code.

SI_Int CSLConstraint::GetConstrainingObjectCount  
 

Return the number of constraining objects in the constraint.

Returns:
SI_Int Number of constraining objects.

CSLConstraint::EConstraintType CSLConstraint::GetConstraintType  
 

Return the type of the constraint.

Returns:
EConstraintType Type of constraint.

CSLModel * CSLConstraint::GetReference  
 

Return the reference model of the constraint.

Returns:
CSLModel* Pointer to the reference model.

SI_Error CSLConstraint::RemoveConstrainingObject CSLModel   in_pConstrainingObject
 

Remove a single constraining object from the constraint.

Parameters:
in_pConstrainingObject  Pointer to the constraining object (model) to remove.
Returns:
SI_Error Error code.

SI_Error CSLConstraint::RemoveConstrainingObject SI_Int    in_nIndex
 

Remove a single constraining object from the constraint.

Parameters:
in_nIndex  Index of the constraining object to remove.
Returns:
SI_Error Error code.

SI_Error CSLConstraint::Synchronize   [virtual]
 

Synchronizes this constraint instance with its IO layer representation

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

Reimplemented from CSLTemplate.

virtual ETemplateType CSLConstraint::Type   [inline, virtual]
 

Get the template type

Returns:
ETemplateType the template type of the constraint

Reimplemented from CSLTemplate.

CSLConstraint * CSLConstraint::UpVector  
 

Return the up vector constraint of the constraint.

Returns:
CSLConstraint* Pointer to a constraint object.


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.