PMI::Orientation Class Reference

#include <HUtilityPMI.h>

Public Member Functions

void GetMatrix (float out_matrix[16]) const
 
void GetOriginComponent (Point &out_component) const
 
void GetOriginComponent (float &out_x, float &out_y, float &out_z) const
 
void GetXComponent (Point &out_component) const
 
void GetXComponent (float &out_x, float &out_y, float &out_z) const
 
void GetYComponent (Point &out_component) const
 
void GetYComponent (float &out_x, float &out_y, float &out_z) const
 
void GetZComponent (Point &out_component) const
 
void GetZComponent (float &out_x, float &out_y, float &out_z) const
 
Orientation const & operator= (Orientation const &that)
 
 Orientation (Orientation const &that)
 
void Set (Orientation const &that)
 
void SetMatrix (float const in_matrix[16])
 
void SetOriginComponent (Point const &in_component)
 
void SetOriginComponent (float in_x, float in_y, float in_z)
 
void SetXComponent (Point const &in_component)
 
void SetXComponent (float in_x, float in_y, float in_z)
 
void SetYComponent (Point const &in_component)
 
void SetYComponent (float in_x, float in_y, float in_z)
 
void SetZComponent (Point const &in_component)
 
void SetZComponent (float in_x, float in_y, float in_z)
 

Detailed Description

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.

Member Function Documentation

◆ GetMatrix()

void PMI::Orientation::GetMatrix ( float  out_matrix[16]) const

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

◆ GetOriginComponent() [1/2]

void PMI::Orientation::GetOriginComponent ( Point out_component) const

Gets the Origin component. Returned to the user.

◆ GetOriginComponent() [2/2]

void PMI::Orientation::GetOriginComponent ( float &  out_x,
float &  out_y,
float &  out_z 
) const

Gets the Origin component. Returned to the user.

◆ GetXComponent() [1/2]

void PMI::Orientation::GetXComponent ( Point out_component) const

Gets the X component. Returned to the user.

◆ GetXComponent() [2/2]

void PMI::Orientation::GetXComponent ( float &  out_x,
float &  out_y,
float &  out_z 
) const

Gets the X component. Returned to the user.

◆ GetYComponent() [1/2]

void PMI::Orientation::GetYComponent ( Point out_component) const

Gets the Y component. Returned to the user.

◆ GetYComponent() [2/2]

void PMI::Orientation::GetYComponent ( float &  out_x,
float &  out_y,
float &  out_z 
) const

Gets the Y component. Returned to the user.

◆ GetZComponent() [1/2]

void PMI::Orientation::GetZComponent ( Point out_component) const

Gets the Z component. Returned to the user.

◆ GetZComponent() [2/2]

void PMI::Orientation::GetZComponent ( float &  out_x,
float &  out_y,
float &  out_z 
) const

Gets the Z component. Returned to the user.

◆ SetMatrix()

void PMI::Orientation::SetMatrix ( float const  in_matrix[16])

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

◆ SetOriginComponent() [1/2]

void PMI::Orientation::SetOriginComponent ( Point const &  in_component)

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

◆ SetOriginComponent() [2/2]

void PMI::Orientation::SetOriginComponent ( float  in_x,
float  in_y,
float  in_z 
)

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

◆ SetXComponent() [1/2]

void PMI::Orientation::SetXComponent ( Point const &  in_component)

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

◆ SetXComponent() [2/2]

void PMI::Orientation::SetXComponent ( float  in_x,
float  in_y,
float  in_z 
)

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

◆ SetYComponent() [1/2]

void PMI::Orientation::SetYComponent ( Point const &  in_component)

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

◆ SetYComponent() [2/2]

void PMI::Orientation::SetYComponent ( float  in_x,
float  in_y,
float  in_z 
)

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

◆ SetZComponent() [1/2]

void PMI::Orientation::SetZComponent ( Point const &  in_component)

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

◆ SetZComponent() [2/2]

void PMI::Orientation::SetZComponent ( float  in_x,
float  in_y,
float  in_z 
)

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


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