Class Description

A structure that sets up the mapping between the coordinate system used in the Gameware Navigation Engine and the game engine.

Public Member Functions
void	AddMapping (BlobFieldsMapping &mapping)

void	Init (KyFloat32 oneMeterInClientUnits, CoordSystemClientAxis clientAxisForNavigationX, CoordSystemClientAxis clientAxisForNavigationY, CoordSystemClientAxis clientAxisForNavigationZ)

void	Init_Zup (KyFloat32 oneMeterInClientUnits)

bool	operator!= (const CoordSystemConfig &other) const

bool	operator== (const CoordSystemConfig &other) const

Public Attributes
KyUInt32	m_clientAxisForNavigationX

KyUInt32	m_clientAxisForNavigationY

KyUInt32	m_clientAxisForNavigationZ

KyFloat32	m_oneMeterInClientUnits

Member Function Documentation

void Kaim::CoordSystemConfig::AddMapping ( BlobFieldsMapping & mapping )

For internal use.

void Kaim::CoordSystemConfig::Init	(	KyFloat32	oneMeterInClientUnits,
		CoordSystemClientAxis	clientAxisForNavigationX,
		CoordSystemClientAxis	clientAxisForNavigationY,
		CoordSystemClientAxis	clientAxisForNavigationZ
	)

inline

Sets up an instance of this class with any required components and configuration parameters.

Parameters

oneMeterInClientUnits	Sets the value of m_oneMeterInClientUnits.
clientAxisForNavigationX	Sets the value of m_clientAxisForNavigationX.
clientAxisForNavigationY	Sets the value of m_clientAxisForNavigationY.
clientAxisForNavigationZ	Sets the value of m_clientAxisForNavigationZ.

void Kaim::CoordSystemConfig::Init_Zup ( KyFloat32 oneMeterInClientUnits )

inline

Initialize the CoordSystemConfig to use a standard Z-up coordinate system in Gameware Navigation.

bool Kaim::CoordSystemConfig::operator!= ( const CoordSystemConfig & other ) const

inline

Returns true if at least one data member in the specified CoordSystemConfig does not match the corresponding data member in this object.

bool Kaim::CoordSystemConfig::operator== ( const CoordSystemConfig & other ) const

inline

Returns true if all data members in the specified CoordSystemConfig match all data members in this object.

KyUInt32 Kaim::CoordSystemConfig::m_clientAxisForNavigationX

The axis in the game engine coordinate system that should be mapped to the X axis within the Gameware Navigation coordinate system.

KyUInt32 Kaim::CoordSystemConfig::m_clientAxisForNavigationY

The axis in the game engine coordinate system that should be mapped to the Y axis within the Gameware Navigation coordinate system.

KyUInt32 Kaim::CoordSystemConfig::m_clientAxisForNavigationZ

The axis in the game engine coordinate system that should be mapped to the Z axis within the Gameware Navigation coordinate system.

KyFloat32 Kaim::CoordSystemConfig::m_oneMeterInClientUnits

The number of world units in the game engine that add up to one meter in length.

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