Heads Up display.
Display scene related information on a camera output. Rendered on video out, output renderings.
Public Member Functions | |
GetIntrinsicDimension (FBViewingOptions pViewingOptins, int pWidth, int pHeight) | |
Callback for getting HUD element intrinsic dimension which is opposed to the actual display dimension. | |
DrawElement (FBViewingOptions pViewingOption, Rect pRect) | |
Callback for drawing HUD element. | |
bool | FbxStore (FBFbxObject pFbxObject, kFbxObjectStore pStoreWhat) |
Store function that can be overloaded. | |
bool | FbxRetrieve (FBFbxObject pFbxObject, kFbxObjectStore pStoreWhat) |
Retrieve function that can be overloaded. | |
Public Attributes | |
FBPropertyBase | Visibility |
FBPropertyBase | Show |
Read Write Property: Specifies if the HUD element will be displayed or not. | |
FBPropertyHUDElementHAlignment | Justification |
Read Write Property: Specifies if the justification of the HUD element is Left, Right, or Center. | |
FBPropertyHUDElementHAlignment | HorizontalDock |
Read Write Property: Specifies if the HUD element will be horizontally docked to the Left, Right, or Center. | |
FBPropertyHUDElementVAlignment | VerticalDock |
Read Write Property: Specifies if the HUD element will be vertically docked to the Bottom, Top, or Center. | |
FBPropertyBase | X |
Read Write Property: Specifies the horizontal position of the HUD element, relative to dock position and justification. | |
FBPropertyBase | Y |
Read Write Property: Specifies the vertical position of the HUD element, relative to dock position and justification. | |
FBPropertyBase | PositionByPercent |
Read Write Property: When set to true, X and Y position values are in percentage, relative to the corresponding camera view dimension. | |
FBPropertyBase | ScaleByPercent |
Read Write Property: When set to true, Scale is in percentage, relative to the corresponding camera view dimension. | |
FBPropertyBase | Width |
Read Write Property: Specifies the width of HUD element on the screen. | |
FBPropertyBase | Height |
Read Write Property: Specifies the height of HUD element on the screen. | |
FBPropertyBase | ScaleUniformly |
Read Write Property: Specifies whether the width and height of HUD element will be scaled uniformly according to the initial aspect ratio. | |
Protected Member Functions | |
__init__ (str pName, object pObject=None) | |
Constructor. |
Constructor.
pName | Name of new FBHUDElement. |
pObject | For internal use only. This parameter does not need to be specified by the developer. |
Reimplemented from FBBox.
Reimplemented in FBHUDFlashElement, FBHUDRectElement, FBHUDTextElement, and FBHUDTextureElement.
GetIntrinsicDimension | ( | FBViewingOptions | pViewingOptins, |
int | pWidth, | ||
int | pHeight | ||
) |
Callback for getting HUD element intrinsic dimension which is opposed to the actual display dimension.
pViewingOptins | Viewing Options. |
pWidth | intrinsic width value, return by reference. |
pHeight | intrinsic height value, return by reference. |
DrawElement | ( | FBViewingOptions | pViewingOption, |
Rect | pRect | ||
) |
Callback for drawing HUD element.
pViewingOption | Viewing Options. |
pRect | HUD element display dimension. |
bool FbxStore | ( | FBFbxObject | pFbxObject, |
kFbxObjectStore | pStoreWhat | ||
) |
Store function that can be overloaded.
pFbxObject | FBX Object that is used to communicate I/O operations. |
pStoreWhat | Which attributes are currently stored/retrieved. |
Reimplemented from FBBox.
bool FbxRetrieve | ( | FBFbxObject | pFbxObject, |
kFbxObjectStore | pStoreWhat | ||
) |
Retrieve function that can be overloaded.
pFbxObject | FBX Object that is used to communicate I/O operations. |
pStoreWhat | Which attributes are currently stored/retrieved. |
Reimplemented from FBBox.
FBPropertyBase Visibility |
FBPropertyBase Show |
Read Write Property: Specifies if the HUD element will be displayed or not.
FBPropertyHUDElementHAlignment Justification |
Read Write Property: Specifies if the justification of the HUD element is Left, Right, or Center.
FBPropertyHUDElementHAlignment HorizontalDock |
Read Write Property: Specifies if the HUD element will be horizontally docked to the Left, Right, or Center.
FBPropertyHUDElementVAlignment VerticalDock |
Read Write Property: Specifies if the HUD element will be vertically docked to the Bottom, Top, or Center.
FBPropertyBase X |
Read Write Property: Specifies the horizontal position of the HUD element, relative to dock position and justification.
FBPropertyBase Y |
Read Write Property: Specifies the vertical position of the HUD element, relative to dock position and justification.
FBPropertyBase PositionByPercent |
Read Write Property: When set to true, X and Y position values are in percentage, relative to the corresponding camera view dimension.
Otherwise, they are absolute pixel values.
FBPropertyBase ScaleByPercent |
Read Write Property: When set to true, Scale is in percentage, relative to the corresponding camera view dimension.
Otherwise, it is an absolute value.
FBPropertyBase Width |
Read Write Property: Specifies the width of HUD element on the screen.
It's in pixel when ScaleByPercent is false and percentage when ScaleByPercent is true.
FBPropertyBase Height |
Read Write Property: Specifies the height of HUD element on the screen.
It's in pixel when ScaleByPercent is false and percentage when ScaleByPercent is true.
FBPropertyBase ScaleUniformly |
Read Write Property: Specifies whether the width and height of HUD element will be scaled uniformly according to the initial aspect ratio.