FBHUDTextElement Class Reference


Detailed Description

Heads Up display.

Text element. Render text with a background rectangle to the HUD.

Examples
Tasks/HUD.py, Samples/HUD/HUDElements.py, Samples/HUD/HUDTextElement.py
Inheritance diagram for FBHUDTextElement:

List of all members.

Public Member Functions

 __init__ (str pName, object pObject=None)
 Constructor.
FBStringList GetFontList ()
 Returns a list of supported fonts.

Public Attributes

FBPropertyString Content
 Read Write Property: C like format to display like in printf.
FBPropertyString Font
 Read Write Property: Specifies the font.
FBPropertyBase Color
 Read Write Property: Text color.
FBPropertyBase BackgroundColor
 Read Write Property: Background text color.
FBPropertyBase ForceTimeCodeDisplay
 Read Write Property: Specifies if the display of time-related reference property will be in timecode format.
FBPropertyBase AdjustWidthToFitText
 Read Write Property: If On it it will adjust the width of a text element so that a text character's aspect ratio does not change as the content grows or shrinks.

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)

Constructor.

Parameters:
pNameName of new HUD text element.
pObjectFor internal use only. This parameter does not need to be specified by the developer.
Examples
Tasks/HUD.py, Samples/HUD/HUDElements.py, Samples/HUD/HUDTextElement.py

Reimplemented from FBHUDElement.

FBStringList GetFontList ( )

Returns a list of supported fonts.


Member Data Documentation

Read Write Property: C like format to display like in printf.

Read Write Property: Specifies the font.

FBPropertyBase Color

Read Write Property: Text color.

FBPropertyBase BackgroundColor

Read Write Property: Background text color.

FBPropertyBase ForceTimeCodeDisplay

Read Write Property: Specifies if the display of time-related reference property will be in timecode format.

FBPropertyBase AdjustWidthToFitText

Read Write Property: If On it it will adjust the width of a text element so that a text character's aspect ratio does not change as the content grows or shrinks.


FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement
FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement FBHUDTextElement