Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLCoordinateSystem Class Reference

Specifies the coordinate system in which transformations are expressed. More...

#include <CoordinateSystem.h>

Inheritance diagram for CSLCoordinateSystem::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Specifies the coordinate system in which transformations are expressed.


Member Enumeration Documentation

enum CSLCoordinateSystem::EAxisOrientation
 

This enum list the possible X, Y & Z axis orientation for the coordinate system.

Enumeration values:
SI_RIGHT  Positive X goes right.
SI_LEFT  Positive X goes left.
SI_UP  Positive Y goes up.
SI_DOWN  Positive Y goes down.
SI_IN  Positive Z goes in.
SI_OUT  Positive Z goes out.

enum CSLCoordinateSystem::ECoordinateSystemStyle
 

This enum list all coordinate system style the class can recognize.

enum CSLCoordinateSystem::EHandRotation
 

This enum list the possible hand rotation for the coordinate system.

Enumeration values:
SI_LEFT_HANDED  Left handed coordinate system.
SI_RIGHT_HANDED  Right handed coordinate system.

enum CSLCoordinateSystem::EUOrientation
 

This enum list the possible U axis orientation for the coordinate system.

Enumeration values:
SI_RIGHT_U  Positive U goes right.
SI_LEFT_U  Positive U goes left.

enum CSLCoordinateSystem::EVOrientation
 

This enum list the possible V axis orientation for the coordinate system.

Enumeration values:
SI_DOWN_V  Positive V goes down.
SI_UP_V  Positive V goes up.


Constructor & Destructor Documentation

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

Constructor

Parameters:
in_pScene  Pointer to the scene containing the coordinate system
in_pModel  Pointer to the model containing the coordinate system
in_pTemplate  Pointer to the CdotXSITemplate containing the coordinate system
Returns:
an instance of CSLCoordinateSystem

CSLCoordinateSystem::~CSLCoordinateSystem   [virtual]
 

Destructor


Member Function Documentation

EHandRotation CSLCoordinateSystem::GetHandRotation   [inline]
 

Return the hand rotation of the coordinate system.

Returns:
EHandRotation Hand rotation.

EUOrientation CSLCoordinateSystem::GetUAxisOrientation   [inline]
 

Return the orientation of the U axis for texture coordinates.

Returns:
EUOrientation Orientation of the U axis.

EVOrientation CSLCoordinateSystem::GetVAxisOrientation   [inline]
 

Return the orientation of the V axis for texture coordinates.

Returns:
EVOrientation Orientation of the V axis.

EAxisOrientation CSLCoordinateSystem::GetXAxisOrientation   [inline]
 

Return the orientation of the X axis in the coordinate system.

Returns:
EAxisOrientation Orientation of the X axis.

EAxisOrientation CSLCoordinateSystem::GetYAxisOrientation   [inline]
 

Return the orientation of the Y axis in the coordinate system.

Returns:
EAxisOrientation Orientation of the Y axis.

EAxisOrientation CSLCoordinateSystem::GetZAxisOrientation   [inline]
 

Return the orientation of the Z axis in the coordinate system.

Returns:
EAxisOrientation Orientation of the Z axis.

SI_Void CSLCoordinateSystem::SetCoordinateSystemStyle ECoordinateSystemStyle    in_Style
 

Change the coordinate system to reflect a certain 3D environment.

Parameters:
ECoordinateSystemStyle  New coordinate system style.
Returns:
SI_Void

SI_Void CSLCoordinateSystem::SetHandRotation EHandRotation    in_Type [inline]
 

Change the hand rotation of the coordinate system.

Parameters:
in_Type  New hand rotation.
Returns:
SI_Void

SI_Void CSLCoordinateSystem::SetUAxisOrientation EUOrientation    in_Type [inline]
 

Change the orientation of the U axis for texture coordinates.

Parameters:
in_Type  New orientation of the U axis.
Returns:
SI_Void

SI_Void CSLCoordinateSystem::SetVAxisOrientation EVOrientation    in_Type [inline]
 

Change the orientation of the V axis for texture coordinates.

Parameters:
in_Type  New orientation of the V axis.
Returns:
SI_Void

SI_Void CSLCoordinateSystem::SetXAxisOrientation EAxisOrientation    in_Type [inline]
 

Change the orientation of the X axis in the coordinate system.

Parameters:
in_Type  New orientation of the X axis.
Returns:
SI_Void

SI_Void CSLCoordinateSystem::SetYAxisOrientation EAxisOrientation    in_Type [inline]
 

Change the orientation of the Y axis in the coordinate system.

Parameters:
in_Type  New orientation of the Y axis.
Returns:
SI_Void

SI_Void CSLCoordinateSystem::SetZAxisOrientation EAxisOrientation    in_Type [inline]
 

Change the orientation of the Z axis in the coordinate system.

Parameters:
in_Type  New orientation of the Z axis.
Returns:
SI_Void

virtual ETemplateType CSLCoordinateSystem::Type   [inline, virtual]
 

Get the template type

Returns:
ETemplateType the template type of the coordinate system

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.