Orientation

Detailed Description

class Orientation

This class represents the positioning information necessary to display a piece of text associated with an Entity. It is essentially a modelling matrix. The X, Y, Z and Origin components describe the plane in which the text lies. The X component is the direction in which the text will be written, the Y component describes the vertical orientation along X, the Z component describes the normal of the plane defined by X and Y, and the origin component specifies the exact plane in which the text should be inserted.

Public Functions

Orientation()
Orientation(Orientation const &that)
~Orientation()
void Set(Orientation const &that)
Orientation const &operator=(Orientation const &that)
void GetXComponent(Point &out_component) const

Gets the X component. Returned to the user.

void GetXComponent(float &out_x, float &out_y, float &out_z) const

Gets the X component. Returned to the user.

void SetXComponent(Point const &in_component)

Sets the X component. This will replace an existing X component.

void SetXComponent(float in_x, float in_y, float in_z)

Sets the X component. This will replace an existing X component.

void GetYComponent(Point &out_component) const

Gets the Y component. Returned to the user.

void GetYComponent(float &out_x, float &out_y, float &out_z) const

Gets the Y component. Returned to the user.

void SetYComponent(Point const &in_component)

Sets the Y component. This will replace an existing Y component.

void SetYComponent(float in_x, float in_y, float in_z)

Sets the Y component. This will replace an existing Y component.

void GetZComponent(Point &out_component) const

Gets the Z component. Returned to the user.

void GetZComponent(float &out_x, float &out_y, float &out_z) const

Gets the Z component. Returned to the user.

void SetZComponent(Point const &in_component)

Sets the Z component. This will replace an existing Z component.

void SetZComponent(float in_x, float in_y, float in_z)

Sets the Z component. This will replace an existing Z component.

void GetOriginComponent(Point &out_component) const

Gets the Origin component. Returned to the user.

void GetOriginComponent(float &out_x, float &out_y, float &out_z) const

Gets the Origin component. Returned to the user.

void SetOriginComponent(Point const &in_component)

Sets the Origin component. This will replace an existing Origin component.

void SetOriginComponent(float in_x, float in_y, float in_z)

Sets the Origin component. This will replace an existing Origin component.

void GetMatrix(float out_matrix[16]) const

Gets the matrix representing the Orientation. Returned to the user.

void SetMatrix(float const in_matrix[16])

Sets the matrix representing the Orientation. This will replace all existing components.