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
enum   EHandRotation {
  SI_LEFT_HANDED,
  SI_RIGHT_HANDED
}
enum   EUOrientation {
  SI_RIGHT_U,
  SI_LEFT_U
}
enum   EVOrientation {
  SI_DOWN_V,
  SI_UP_V
}
enum   EAxisOrientation {
  SI_RIGHT,
  SI_LEFT,
  SI_UP,
  SI_DOWN,
  SI_IN,
  SI_OUT
}
enum   ECoordinateSystemStyle

Public Member Functions
  CSLCoordinateSystem (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLCoordinateSystem ()
EHandRotation  GetHandRotation ()
SI_Void  SetHandRotation (EHandRotation in_Type)
EUOrientation  GetUAxisOrientation ()
SI_Void  SetUAxisOrientation (EUOrientation in_Type)
EVOrientation  GetVAxisOrientation ()
SI_Void  SetVAxisOrientation (EVOrientation in_Type)
EAxisOrientation  GetXAxisOrientation ()
SI_Void  SetXAxisOrientation (EAxisOrientation in_Type)
EAxisOrientation  GetYAxisOrientation ()
SI_Void  SetYAxisOrientation (EAxisOrientation in_Type)
EAxisOrientation  GetZAxisOrientation ()
SI_Void  SetZAxisOrientation (EAxisOrientation in_Type)
SI_Void  SetCoordinateSystemStyle (ECoordinateSystemStyle in_Style)
virtual ETemplateType  Type ()

Detailed Description

Specifies the coordinate system in which transformations are expressed.

Member Enumeration Documentation

enum EHandRotation

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

Enumerator:
SI_LEFT_HANDED  Left handed coordinate system.
SI_RIGHT_HANDED  Right handed coordinate system.

enum EUOrientation

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

Enumerator:
SI_RIGHT_U  Positive U goes right.
SI_LEFT_U  Positive U goes left.

enum EVOrientation

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

Enumerator:
SI_DOWN_V  Positive V goes down.
SI_UP_V  Positive V goes up.

enum EAxisOrientation

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

Enumerator:
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 ECoordinateSystemStyle

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

Constructor & Destructor Documentation

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

virtual ~CSLCoordinateSystem (  )  [virtual]

Destructor

Member Function Documentation

EHandRotation GetHandRotation (  )  [inline]

Return the hand rotation of the coordinate system.

Returns:
EHandRotation Hand rotation.

SI_Void SetHandRotation ( EHandRotation  in_Type  )  [inline]

Change the hand rotation of the coordinate system.

Parameters:
in_Type  New hand rotation.
Returns:
SI_Void

EUOrientation GetUAxisOrientation (  )  [inline]

Return the orientation of the U axis for texture coordinates.

Returns:
EUOrientation Orientation of the U axis.

SI_Void 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

EVOrientation GetVAxisOrientation (  )  [inline]

Return the orientation of the V axis for texture coordinates.

Returns:
EVOrientation Orientation of the V axis.

SI_Void 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

EAxisOrientation GetXAxisOrientation (  )  [inline]

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

Returns:
EAxisOrientation Orientation of the X axis.

SI_Void 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

EAxisOrientation GetYAxisOrientation (  )  [inline]

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

Returns:
EAxisOrientation Orientation of the Y axis.

SI_Void 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

EAxisOrientation GetZAxisOrientation (  )  [inline]

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

Returns:
EAxisOrientation Orientation of the Z axis.

SI_Void 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

SI_Void SetCoordinateSystemStyle ( ECoordinateSystemStyle  in_Style  ) 

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

Parameters:
ECoordinateSystemStyle  New coordinate system style.
Returns:
SI_Void

virtual ETemplateType Type (  )  [inline, virtual]

Get the template type

Returns:
ETemplateType the template type of the coordinate system

Implements CSLTemplate.

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