This reference page is linked to from the following overview topics: MotionBuilder 2014, MotionBuilder 2013, Updated Objects.
Heads Up display.
Display scene related information on a camera output. Rendered on video out, output renderings.
#include <fbhud.h>
Classes | |
struct | Rect |
HUD element rectangle for drawing in the view. More... | |
Public Member Functions | |
virtual void | GetIntrinsicDimension (FBViewingOptions *pViewingOptins, int &pWidth, int &pHeight) |
Callback for getting HUD element intrinsic dimension which is opposed to the actual display dimension. | |
virtual void | DrawElement (FBViewingOptions *pViewingOption, Rect &pRect) |
Callback for drawing HUD element. | |
virtual bool | FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) |
Store function that can be overloaded. | |
virtual bool | FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) |
Retrieve function that can be overloaded. | |
Public Attributes | |
FBPropertyBool | Visibility |
FBPropertyBool | 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. | |
FBPropertyDouble | X |
Read Write Property: Specifies the horizontal position of the HUD element, relative to dock position and justification. | |
FBPropertyDouble | Y |
Read Write Property: Specifies the vertical position of the HUD element, relative to dock position and justification. | |
FBPropertyBool | PositionByPercent |
Read Write Property: When set to true, X and Y position values are in percentage, relative to the corresponding camera view dimension. | |
FBPropertyBool | ScaleByPercent |
Read Write Property: When set to true, Scale is in percentage, relative to the corresponding camera view dimension. | |
FBPropertyDouble | Width |
Read Write Property: Specifies the width of HUD element on the screen. | |
FBPropertyDouble | Height |
Read Write Property: Specifies the height of HUD element on the screen. | |
FBPropertyBool | 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 | |
FBHUDElement (const char *pName, HIObject pObject=NULL) | |
Constructor. |
FBHUDElement | ( | const char * | pName, |
HIObject | pObject = NULL |
||
) | [protected] |
Constructor.
pName | Name of new FBHUDElement. |
pObject | For internal use only. This parameter does not need to be specified by the developer. |
virtual void GetIntrinsicDimension | ( | FBViewingOptions * | pViewingOptins, |
int & | pWidth, | ||
int & | pHeight | ||
) | [virtual] |
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. |
virtual void DrawElement | ( | FBViewingOptions * | pViewingOption, |
Rect & | pRect | ||
) | [virtual] |
Callback for drawing HUD element.
pViewingOption | Viewing Options. |
pRect | HUD element display dimension. |
virtual bool FbxStore | ( | FBFbxObject * | pFbxObject, |
kFbxObjectStore | pStoreWhat | ||
) | [virtual] |
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.
virtual bool FbxRetrieve | ( | FBFbxObject * | pFbxObject, |
kFbxObjectStore | pStoreWhat | ||
) | [virtual] |
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.
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.
Read Write Property: Specifies the horizontal position of the HUD element, relative to dock position and justification.
Read Write Property: Specifies the vertical position of the HUD element, relative to dock position and justification.
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.
Read Write Property: When set to true, Scale is in percentage, relative to the corresponding camera view dimension.
Otherwise, it is an absolute value.
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.
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.
Read Write Property: Specifies whether the width and height of HUD element will be scaled uniformly according to the initial aspect ratio.