My Project
Public Attributes | List of all members
ParaEngine::HeadOn3DData Struct Reference

It is the data structure that holds description data about the head on display. More...

#include <IHeadOn3D.h>

Public Attributes

string m_sText
 text to be displayed
 
string m_sUITemplateName
 which UI control the head on display will be used as a template for drawing the text it can be a single CGUIText Object or it can be a container with a direct children called "text" if this is "" or empty, the default UI template will be used. More...
 
DWORD m_dwTextColor
 the font color. More...
 
Vector3 m_vOffset
 offset from 3d object's head or origin. More...
 
float m_fNearZoomDist
 the camera to object distance where UI scaling is m_fMaxUIScaling
 
float m_fFarZoomDist
 the camera to object distance where UI scaling is m_fMinUIScaling
 
float m_fMinUIScaling
 the min UI scaling factor. More...
 
float m_fMaxUIScaling
 the max UI scaling factor. More...
 
float m_fAlphaFadePercentage
 within which the alpha will change from 1 to 0 at the far end. More...
 
float m_f3DTextFacing
 only used when 3d text is used. More...
 
bool m_bShow:1
 whether to render the head on display over 3d object. More...
 
bool m_bZEnable:1
 Enable z buffer test. More...
 
bool m_bEnable3DScaling:1
 Enable 3d scaling. More...
 
bool m_bUseGlobal3DScaling:1
 this is only used when m_bEnable3DScaling. More...
 
bool m_bRender3DText:1
 we will render the 3d text using the model's world transform. More...
 

Detailed Description

It is the data structure that holds description data about the head on display.

Member Data Documentation

§ m_bEnable3DScaling

bool ParaEngine::HeadOn3DData::m_bEnable3DScaling

Enable 3d scaling.

the text are scaled according to camera to object distance fScaling = g_fMaxUIScaling - (fDist - g_fNearZoomDist) / (g_fFarZoomDist - g_fNearZoomDist) * (g_fMaxUIScaling-g_fMinUIScaling);

§ m_bRender3DText

bool ParaEngine::HeadOn3DData::m_bRender3DText

we will render the 3d text using the model's world transform.

§ m_bShow

bool ParaEngine::HeadOn3DData::m_bShow

whether to render the head on display over 3d object.

Default it true.

§ m_bUseGlobal3DScaling

bool ParaEngine::HeadOn3DData::m_bUseGlobal3DScaling

this is only used when m_bEnable3DScaling.

if true, we will use parent SceneObject's parameter for 3d scaling, otherwise the local settings are employed

§ m_bZEnable

bool ParaEngine::HeadOn3DData::m_bZEnable

Enable z buffer test.

default to false.

§ m_dwTextColor

DWORD ParaEngine::HeadOn3DData::m_dwTextColor

the font color.

The default color is green.

§ m_f3DTextFacing

float ParaEngine::HeadOn3DData::m_f3DTextFacing

only used when 3d text is used.

§ m_fAlphaFadePercentage

float ParaEngine::HeadOn3DData::m_fAlphaFadePercentage

within which the alpha will change from 1 to 0 at the far end.

§ m_fMaxUIScaling

float ParaEngine::HeadOn3DData::m_fMaxUIScaling

the max UI scaling factor.

§ m_fMinUIScaling

float ParaEngine::HeadOn3DData::m_fMinUIScaling

the min UI scaling factor.

§ m_sUITemplateName

string ParaEngine::HeadOn3DData::m_sUITemplateName

which UI control the head on display will be used as a template for drawing the text it can be a single CGUIText Object or it can be a container with a direct children called "text" if this is "" or empty, the default UI template will be used.

The default UI template is an invisible CGUIText control called "_HeadOnDisplayText_" By default, "_HeadOnDisplayText_" uses horizontal text alignment and system font.

§ m_vOffset

Vector3 ParaEngine::HeadOn3DData::m_vOffset

offset from 3d object's head or origin.

Default it (0,0,0)


The documentation for this struct was generated from the following files: