Kaim::CoordSystemConfig Class Reference

Kaim::CoordSystemConfig Class Reference

#include <coordsystem.h>

Class Description

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

Public Member Functions

 CoordSystemConfig ()
 Initialize with NavX=ClientX, NavY=ClientY, NavZ=Up=ClientZ, ClientUnits = meters. More...
 
void Init_Zup (KyFloat32 oneMeterInClientUnits=1.0f)
 Initialize with NavX=ClientX, NavY=ClientY, NavZ=Up=ClientZ, custom oneMeterInClientUnits. More...
 
void Init_Yup (KyFloat32 oneMeterInClientUnits=1.0f)
 Initialize with NavX=ClientX, NavY=-ClientZ, NavZ=Up=ClientY, custom oneMeterInClientUnits. More...
 
bool operator== (const CoordSystemConfig &other) const
 For internal use. More...
 

Public Attributes

KyFloat32 m_oneMeterInClientUnits
 The number of world units in the game engine that add up to one meter in length. More...
 
KyUInt32 m_clientAxisForNavigationX
 The axis in the game engine coordinate system that should be mapped to the X axis within the Autodesk Navigation coordinate system. More...
 
KyUInt32 m_clientAxisForNavigationY
 The axis in the game engine coordinate system that should be mapped to the Y axis within the Autodesk Navigation coordinate system. More...
 
KyUInt32 m_clientAxisForNavigationZ
 The axis in the game engine coordinate system that should be mapped to the Z axis within the Autodesk Navigation coordinate system. More...
 

Constructor & Destructor Documentation

Kaim::CoordSystemConfig::CoordSystemConfig ( )
inline

Initialize with NavX=ClientX, NavY=ClientY, NavZ=Up=ClientZ, ClientUnits = meters.

Member Function Documentation

void Kaim::CoordSystemConfig::Init_Yup ( KyFloat32  oneMeterInClientUnits = 1.0f)
inline

Initialize with NavX=ClientX, NavY=-ClientZ, NavZ=Up=ClientY, custom oneMeterInClientUnits.

void Kaim::CoordSystemConfig::Init_Zup ( KyFloat32  oneMeterInClientUnits = 1.0f)
inline

Initialize with NavX=ClientX, NavY=ClientY, NavZ=Up=ClientZ, custom oneMeterInClientUnits.

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

For internal use.

Member Data Documentation

KyUInt32 Kaim::CoordSystemConfig::m_clientAxisForNavigationX

The axis in the game engine coordinate system that should be mapped to the X axis within the Autodesk 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 Autodesk 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 Autodesk 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.

m_oneMeterInClientUnits = 100.0f means that game engine coordinates are in centimeters.


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