Python Reference Guide
 
Loading...
Searching...
No Matches
FBHUD Class Reference

Heads Up display. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBHUD:

Public Member Functions

 FBHUD (str pName)
 Constructor.
 
FBHUDElement CreateCustomElement (str pHUDElementClassName, str pName)
 Creates a custom HUD Element.
 
FBHUDElement CreateElement (EStockElement pType, str pName)
 Creates a stock HUD Element.
 
- Public Member Functions inherited from FBBox
 FBBox (str pName)
 Constructor.
 
bool AnimationNodeDestroy (FBAnimationNode pAnimationNode)
 Destroy an animation node.
 
FBAnimationNode AnimationNodeInGet ()
 Get the (IN/OUT) animation node for this box.
 
bool AnimationNodeIsUserData (FBAnimationNode pAnimationNode)
 Is the animation node user data?
 
FBAnimationNode AnimationNodeOutGet ()
 
str FbxGetObjectSubType ()
 Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.
 
str FbxGetObjectType ()
 Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.
 
FBAnimationNode GetInConnector (int pIndex)
 Get the animation node input associated with the given index.
 
int GetInConnectorCount ()
 Get the number of animation node inputs for this box.
 
FBAnimationNode GetOutConnector (int pIndex)
 Get the animation node output associated with the given index.
 
int GetOutConnectorCount ()
 Get the number of animation node outputs for this box.
 
- Public Member Functions inherited from FBComponent
 FBComponent ()
 Constructor.
 
str ClassName ()
 Get the class name.
 
 DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags.
 
 EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags.
 
bool FBCreate ()
 Open Reality Creation function.
 
 FBDelete ()
 Open Reality deletion function.
 
 FBDestroy ()
 Open Reality destruction function.
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated).
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled.
 
FBFileReference GetOwnerFileReference (p0)
 Get the owner FileReference object.
 
 HardSelect ()
 HardSelect.
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled.
 
bool Is (int pTypeId)
 Returns true if object is of type TypeId.
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessNamespaceHierarchy.
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessObjectNamespace.
 
int PropertyAdd (FBProperty pProperty)
 Add a property to the component's property manager.
 
bool PropertyAddReferenceProperty (FBProperty pReferenceProperty)
 Add a reference property to the component's property manager.
 
FBProperty PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
 Create user or dynamic property.
 
 PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading.
 
 PropertyRemove (FBProperty pProperty)
 Remove a Property from the component's Property manager.
 
 SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags.
 
 SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status.
 

Public Attributes

FBListHUDElement Elements
 List: Elements present in the HUD.

 
FBListHUD HUDs
 List: HUDS attached to this HUD.

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

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

 
- Public Attributes inherited from FBBox
bool Animatable
 Read Write Property: Is the box animatable.

 
bool Live
 Read Write Property: Is live?

 
bool RecordMode
 Read Write Property: Is recording?

 
str UniqueName
 internal Unique name.

 
- Public Attributes inherited from FBComponent
FBListComponent Components
 List: List of components.

 
str LongName
 Read Write Property: Name and namespace for object.

 
str Name
 Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
 
FBListComponent Parents
 List: Parents.

 
FBManager PropertyList
 Read Only Property: Manages all of the properties for the component.

 
bool Selected
 Read Write Property: Selected property.

 
int TypeInfo
 Contains the Type information of the object.

 
- Public Attributes inherited from FBPlug
str ClassGroupName
 ClassGroupName of the object.

 
int TypeInfo
 TypeInfo.

 

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.

See samples: BloopSlate.py, HUDElements.py, HUDTextElement.py, RecordLight.py, Timeline.py, HUD.py.

Constructor & Destructor Documentation

◆ FBHUD()

FBHUD ( str  pName)

Constructor.

Parameters
pNameName of new HUD.

Member Function Documentation

◆ CreateCustomElement()

FBHUDElement CreateCustomElement ( str  pHUDElementClassName,
str  pName 
)

Creates a custom HUD Element.

Parameters
pHUDElementClassNameThe HUD Element class name (mainly, the ClassName parameter of the FBStorableCustomHUDElementImplementation macro).
pNameName for the custom HUD Element to create.
Returns
The created custom HUD Element.

◆ CreateElement()

FBHUDElement CreateElement ( EStockElement  pType,
str  pName 
)

Creates a stock HUD Element.

Parameters
pTypeView to be called for expose.
pNameName for the HUD Element to create.
Returns
The created HUD Element.

Member Data Documentation

◆ Elements

FBListHUDElement Elements

List: Elements present in the HUD.

◆ HUDs

FBListHUD HUDs

List: HUDS attached to this HUD.

◆ OnDisplay

FBEvent OnDisplay

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

◆ Visibility

bool Visibility

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