Torque3D Documentation / _generateds / GuiShapeNameHud

GuiShapeNameHud

Engine/source/T3D/fps/guiShapeNameHud.cpp

Displays name & damage above shape objects.

More...

Private Types

Parent 

Protected Functions

drawName(Point2I offset, const char * buf, F32 opacity)

Render object names.

Public Functions

DECLARE_CATEGORY("Gui Game" )
DECLARE_DESCRIPTION("Displays name and damage of <a href="/coding/class/classshapebase/">ShapeBase</a> objects in its <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">bounds.\n</a>" "Must be <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> child of <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> <a href="/coding/class/classguitsctrl/">GuiTSCtrl</a> and <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> server connection must be present." )
onRender(Point2I offset, const RectI & updateRect)

Core rendering method for this control.

Public Static Functions

Detailed Description

Displays name & damage above shape objects.

This control displays the name and damage value of all named ShapeBase objects on the client. The name and damage of objects within the control's display area are overlayed above the object.

This GUI control must be a child of a TSControl, and a server connection and control object must be present.

This is a stand-alone control and relies only on the standard base GuiControl.

Private Types

typedef GuiControl Parent 

Private Attributes

F32 mDistanceFade 
LinearColorF mFillColor 
LinearColorF mFrameColor 
LinearColorF mLabelFillColor 
LinearColorF mLabelFrameColor 
Point2I mLabelPadding 
bool mShowFill 
bool mShowFrame 
bool mShowLabelFill 
bool mShowLabelFrame 
LinearColorF mTextColor 
F32 mVerticalOffset 

Protected Functions

drawName(Point2I offset, const char * buf, F32 opacity)

Render object names.

Helper function for GuiShapeNameHud::onRender

Parameters:

offset

Screen coordinates to render name label. (Text is centered horizontally about this location, with bottom of text at specified y position.)

name

String name to display.

opacity

Opacity of name (a fraction).

Public Functions

GuiShapeNameHud()

DECLARE_CATEGORY("Gui Game" )

DECLARE_CONOBJECT(GuiShapeNameHud )

DECLARE_DESCRIPTION("Displays name and damage of <a href="/coding/class/classshapebase/">ShapeBase</a> objects in its <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">bounds.\n</a>" "Must be <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> child of <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> <a href="/coding/class/classguitsctrl/">GuiTSCtrl</a> and <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> server connection must be present." )

onRender(Point2I offset, const RectI & updateRect)

Reimplemented from: GuiControl

Public Static Functions

initPersistFields()