Public Types | Public Member Functions | Public Attributes

FBHUD Class Reference

This reference page is linked to from the following overview topics: MotionBuilder 2013.


Search for all occurrences

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.

Definition at line 290 of file fbhud.h.

#include <fbhud.h>

Inheritance diagram for FBHUD:
Inheritance graph
[legend]

List of all members.

Public Types

enum   EStockElement { eRecordLight, eFlashElement, eTextElement, eRectElement }

Public Member Functions

  FBHUD (const char *pName, HIObject pObject=NULL)
  Constructor.
  FBHUD (const FBHUD &)
  Disabled copy constructor.
FBHUD operator= (const FBHUD &)
  Disabled assignment operator.
FBHUDElement CreateElement (EStockElement pType, const char *pName)

Public Attributes

FBPropertyBool  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 Enumeration Documentation

Enumerator:
eRecordLight 

Record light.

eFlashElement 
eTextElement 
eRectElement 

Definition at line 314 of file fbhud.h.


Constructor & Destructor Documentation

FBHUD ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pName Name of new HUD.
pObject For internal use only. This parameter does not need to be specified by the developer.
FBHUD ( const FBHUD )

Disabled copy constructor.

Voluntarily making the copy constructor unavailable.


Member Function Documentation

FBHUD& operator= ( const FBHUD )

Disabled assignment operator.

Voluntarily making the assignment operator unavailable.

FBHUDElement* CreateElement ( EStockElement  pType,
const char *  pName 
)

Member Data Documentation

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

Definition at line 324 of file fbhud.h.

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

Definition at line 325 of file fbhud.h.

//!< List: Elements present in the HUD.

Definition at line 326 of file fbhud.h.


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

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