FBHUD Class Reference


Detailed Description

Heads Up display.

Display scene related information to the screen. This information will also be present in the rendered frames when creating AVIs or QuickTime files.

Examples
Tasks/HUD.py, Samples/HUD/BloopSlate.py, Samples/HUD/HUDElements.py, Samples/HUD/HUDTextElement.py, Samples/HUD/RecordLight.py, Samples/HUD/Timeline.py
Inheritance diagram for FBHUD:

List of all members.

Public Member Functions

 __init__ (str pName, object pObject=None)
 Constructor.
FBHUDElement CreateElement (EStockElement pType, str pName)

Public Attributes

FBPropertyBase Visibility
 Read Write Property: Indicate if the information will be displayed or not.
FBPropertyEvent OnDisplay
 Event: Callback just before HUD is displayed to update custom values.
FBPropertyListHUDElement Elements
 List: Elements present in the HUD.

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)

Constructor.

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

Reimplemented from FBBox.

FBHUDElement CreateElement ( EStockElement  pType,
str  pName 
)

Member Data Documentation

FBPropertyBase Visibility

Read Write Property: Indicate if the information will be displayed or not.

FBPropertyEvent OnDisplay

Event: Callback just before HUD is displayed to update custom values.

List: Elements present in the HUD.


FBHUD FBHUD FBHUD FBHUD FBHUD FBHUD FBHUD FBHUD FBHUD FBHUD
FBHUD FBHUD FBHUD FBHUD FBHUD FBHUD FBHUD FBHUD FBHUD FBHUD