CSLCoordinateSystem Class Reference

This class represents an SI_CoordinateSystem template. 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

This class represents an SI_CoordinateSystem template.

Specifies the coordinate system in which transformations are expressed (see the SI_CoordinateSystem template reference).

Member Enumeration Documentation

enum EHandRotation

This enum lists 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 lists 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 lists 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 lists 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 lists all coordinate system style the class can recognize.

Constructor & Destructor Documentation

CSLCoordinateSystem ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate  
)

Constructor

Parameters:
[in]  in_pScene  Pointer to the scene containing the coordinate system
[in]  in_pModel  Pointer to the model containing the coordinate system
[in]  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]

Returns the hand rotation of the coordinate system.

Returns:
Hand rotation.

SI_Void SetHandRotation ( EHandRotation  in_Type  )  [inline]

Changes the hand rotation of the coordinate system.

Parameters:
[in]  in_Type  New hand rotation.

EUOrientation GetUAxisOrientation (  )  [inline]

Returns the orientation of the U axis for texture coordinates.

Returns:
Orientation of the U axis.

SI_Void SetUAxisOrientation ( EUOrientation  in_Type  )  [inline]

Changes the orientation of the U axis for texture coordinates.

Parameters:
[in]  in_Type  New orientation of the U axis.

EVOrientation GetVAxisOrientation (  )  [inline]

Returns the orientation of the V axis for texture coordinates.

Returns:
Orientation of the V axis.

SI_Void SetVAxisOrientation ( EVOrientation  in_Type  )  [inline]

Changes the orientation of the V axis for texture coordinates.

Parameters:
[in]  in_Type  New orientation of the V axis.

EAxisOrientation GetXAxisOrientation (  )  [inline]

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

Returns:
Orientation of the X axis.

SI_Void SetXAxisOrientation ( EAxisOrientation  in_Type  )  [inline]

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

Parameters:
[in]  in_Type  New orientation of the X axis.

EAxisOrientation GetYAxisOrientation (  )  [inline]

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

Returns:
Orientation of the Y axis.

SI_Void SetYAxisOrientation ( EAxisOrientation  in_Type  )  [inline]

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

Parameters:
[in]  in_Type  New orientation of the Y axis.

EAxisOrientation GetZAxisOrientation (  )  [inline]

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

Returns:
Orientation of the Z axis.

SI_Void SetZAxisOrientation ( EAxisOrientation  in_Type  )  [inline]

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

Parameters:
[in]  in_Type  New orientation of the Z axis.

SI_Void SetCoordinateSystemStyle ( ECoordinateSystemStyle  in_Style  ) 

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

Parameters:
[in]  in_Style  New coordinate system style.

virtual ETemplateType Type (  )  [inline, virtual]

Returns the template type of the coordinate system

Returns:
CSLTemplate::SI_COORDINATE_SYSTEM the template type

Implements CSLTemplate.

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