|
Open Reality Reference Guide
|
|
|
Open Reality Reference Guide
|
|
Heads Up display. More...
#include <fbhud.h>
Public Member Functions | |
| FBHUDTextElement (const char *pName, HIObject pObject=NULL) | |
| Constructor. More... | |
| FBStringList * | GetFontList () |
| Returns a list of supported fonts. More... | |
 Public Member Functions inherited from FBHUDElement | |
| virtual void | GetIntrinsicDimension (FBViewingOptions *pViewingOptins, int &pWidth, int &pHeight) |
| Callback for getting HUD element intrinsic dimension which is opposed to the actual display dimension. More... | |
| virtual void | DrawElement (FBViewingOptions *pViewingOption, Rect &pRect) |
| Callback for drawing HUD element. More... | |
| virtual bool | FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override |
| Store function that can be overloaded. More... | |
| virtual bool | FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override |
| Retrieve function that can be overloaded. More... | |
| Public Member Functions inherited from FBBox | |
| FBBox (const char *pName, HIObject pObject=NULL) | |
| Constructor. More... | |
| virtual FBAnimationNode * | AnimationNodeInCreate (kReference pUserId, const char *pName, const char *pDataType, bool pIsPublic=false, double *pMin=NULL, double *pMax=NULL, bool pUserData=false) |
| Creation of IN/OUT Animation Nodes. More... | |
| virtual FBAnimationNode * | AnimationNodeOutCreate (kReference pUserId, const char *pName, const char *pDataType, bool pIsPublic=false, double *pMin=NULL, double *pMax=NULL, bool pUserData=false) |
| virtual bool | EvaluateAnimationNodes (FBEvaluateInfo *pEvaluateInfo) |
| Evaluation of non TRS nodes that needs to be evaluated. More... | |
| virtual bool | AnimationNodeNotify (FBAnimationNode *pAnimationNode, FBEvaluateInfo *pEvaluateInfo) |
| Notification function for animation thread. More... | |
| virtual bool | ResolveCandidate (FBAnimationNode *pAnimationNode, FBEvaluateInfo *pEvaluateInfo) |
| Function is call when candidate needs to be resolved (like global to local). More... | |
| virtual ECandidateAction | SetGlobalCandidate (FBAnimationNode *pAnimationNode, double *pData, FBEvaluateInfo *pEvaluateInfo) |
| Function is call when a global candidate is set on an animation node. More... | |
| virtual ECandidateAction | SetStdCandidate (FBAnimationNode *pAnimationNode, double *pData, FBEvaluateInfo *pEvaluateInfo) |
| Function is call when a non-global candidate is set on an animation node. More... | |
| virtual bool | AnimationNodeDestroy (FBAnimationNode *pAnimationNode) |
| Destroy an animation node. More... | |
| virtual bool | AnimationNodeIsUserData (FBAnimationNode *pAnimationNode) |
| Is the animation node user data? More... | |
| virtual void | AnimationNodesOutDisableIfNotWritten (FBEvaluateInfo *pEvaluateInfo) |
| This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo. More... | |
| virtual FBAnimationNode * | AnimationNodeInGet () |
| Get the (IN/OUT) animation node for this box. More... | |
| virtual FBAnimationNode * | AnimationNodeOutGet () |
| virtual const char * | FbxGetObjectType () |
| Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'. More... | |
| virtual const char * | FbxGetObjectSubType () |
| Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'. More... | |
| IObject_Declare (override) | |
| virtual int | GetOutConnectorCount () const |
| Get the number of animation node outputs for this box. More... | |
| virtual int | GetInConnectorCount () const |
| Get the number of animation node inputs for this box. More... | |
| virtual FBAnimationNode * | GetOutConnector (int pIndex) const |
| Get the animation node output associated with the given index. More... | |
| virtual FBAnimationNode * | GetInConnector (int pIndex) const |
| Get the animation node input associated with the given index. More... | |
| Public Member Functions inherited from FBComponent | |
| FBComponent (HIObject pObject) | |
| Constructor. More... | |
| virtual | ~FBComponent () |
| Destructor. More... | |
| virtual bool | FBCreate () |
| Open Reality Creation function. More... | |
| virtual void | FBDestroy () |
| Open Reality destruction function. More... | |
| virtual void | FBDelete () override |
| Open Reality deletion function. More... | |
| virtual bool | SetHIObject (HIObject pObject, bool pSDKComponent) override |
| Assign component to an internal pointer. More... | |
| virtual int | PropertyAdd (FBProperty *pProperty) |
| Add a property to the component's property manager. More... | |
| bool | PropertyAddReferenceProperty (FBProperty *pReferenceProperty) |
| Add a reference property to the component's property manager. More... | |
| void | PropertyRemove (FBProperty *pProperty) |
| Remove a Property from the component's Property manager. More... | |
| void | PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags) |
| Get list of properties which have been modified since last loading. More... | |
| FBProperty * | PropertyCreate (const char *pName, FBPropertyType pType, const char *pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL) |
| Create user or dynamic property. More... | |
| FBObjectFlag | GetObjectFlags () |
| Get all Object Flags (concatenated). More... | |
| void | SetObjectFlags (FBObjectFlag pFlags) |
| SetObjectFlags. More... | |
| bool | HasObjectFlags (FBObjectFlag pFlags) |
| Check whether a specific object flag is enabled. More... | |
| void | EnableObjectFlags (FBObjectFlag pFlags) |
| Enable a specific Object Flags. More... | |
| void | DisableObjectFlags (FBObjectFlag pFlags) |
| Disable a specific Object Flags. More... | |
| void | SetObjectStatus (FBObjectStatus pStatus, bool pValue) |
| Enable/Disable a specific Object Status. More... | |
| bool | GetObjectStatus (FBObjectStatus pStatus) |
| Check to see if an object status is enabled. More... | |
| bool | ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true) |
| ProcessNamespaceHierarchy. More... | |
| bool | ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true) |
| ProcessObjectNamespace. More... | |
| virtual const char * | ClassName () override |
| Get the class name. More... | |
| virtual bool | UseCustomPropertyViewSet () const |
| Use the custom property viewSet or not. More... | |
| const char * | GetFullName (void) |
| Get the full name. More... | |
| void | SetOwnerNamespace (FBNamespace *pOwnerNSObj) |
| Set the owner Namespace object. More... | |
| FBNamespace * | GetOwnerNamespace (void) |
| Get the owner Namespace object. More... | |
| FBFileReference * | GetOwnerFileReference (void) |
| Get the owner FileReference object. More... | |
| void | HardSelect () |
| HardSelect. More... | |
| virtual bool | Is (int pTypeId) override |
| Returns true if object is of type TypeId. More... | |
| virtual int | GetTypeId () override |
| GetTypeId( int pTypeId ) More... | |
| Public Member Functions inherited from FBWrapperHolder | |
| FBScriptWrapper * | GetWrapper () |
| Return the wrapper interface of this FBObject. More... | |
| void | AddWrapper (FBScriptWrapper *) |
| void | RemoveWrapper (FBScriptWrapper *) |
Public Attributes | |
| FBPropertyString | Content |
| Read Write Property: C like format to display like in printf. More... | |
| FBPropertyString | Font |
| Read Write Property: Specifies the font. More... | |
| FBPropertyColorAndAlpha | Color |
| Read Write Property: Text color. More... | |
| FBPropertyColorAndAlpha | BackgroundColor |
| Read Write Property: Background text color. More... | |
| FBPropertyBool | ForceTimeCodeDisplay |
| Read Write Property: Specifies if the display of time-related reference property will be in timecode format. More... | |
| FBPropertyBool | AdjustWidthToFitText |
| Read Write Property: If On it it will adjust the width of a text element so that a text character's aspect ratio does not change as the content grows or shrinks. More... | |
| Public Attributes inherited from FBHUDElement | |
| FBPropertyBool | Visibility |
| FBPropertyBool | Show |
| Read Write Property: Specifies if the HUD element will be displayed or not. More... | |
| FBPropertyHUDElementHAlignment | Justification |
| Read Write Property: Specifies if the justification of the HUD element is Left, Right, or Center. More... | |
| FBPropertyHUDElementHAlignment | HorizontalDock |
| Read Write Property: Specifies if the HUD element will be horizontally docked to the Left, Right, or Center. More... | |
| FBPropertyHUDElementVAlignment | VerticalDock |
| Read Write Property: Specifies if the HUD element will be vertically docked to the Bottom, Top, or Center. More... | |
| FBPropertyDouble | X |
| Read Write Property: Specifies the horizontal position of the HUD element, relative to dock position and justification. More... | |
| FBPropertyDouble | Y |
| Read Write Property: Specifies the vertical position of the HUD element, relative to dock position and justification. More... | |
| FBPropertyBool | 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. More... | |
| FBPropertyBool | 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. More... | |
| FBPropertyDouble | 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. More... | |
| FBPropertyDouble | 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. More... | |
| FBPropertyBool | ScaleUniformly |
| Read Write Property: Specifies whether the width and height of HUD element will be scaled uniformly according to the initial aspect ratio. More... | |
| Public Attributes inherited from FBBox | |
| const char * | UniqueName |
| internal Unique name. More... | |
| FBPropertyBool | Animatable |
| Read Write Property: Is the box animatable. More... | |
| FBPropertyBool | Live |
| Read Write Property: Is live? More... | |
| FBPropertyBool | RecordMode |
| Read Write Property: Is recording? More... | |
| Public Attributes inherited from FBComponent | |
| FBPropertyManager | PropertyList |
| Read Only Property: Manages all of the properties for the component. More... | |
| FBPropertyListComponent | Components |
| List: List of components. More... | |
| FBPropertyListComponent | Parents |
| List: Parents. More... | |
| FBPropertyBool | Selected |
| Read Write Property: Selected property. More... | |
| FBPropertyString | Name |
| Read Write Property: Unique name of object. More... | |
| FBPropertyString | LongName |
| Read Write Property: Name and namespace for object. More... | |
| FBPropertyFolder | Folder |
| Read Write Property: The folder that contain this component. More... | |
Additional Inherited Members | |
| Public Types inherited from FBBox | |
| enum | ECandidateAction { eCandidateAccept , eCandidateIntercept , eCandidateInterceptAfterEvaluation } |
| Resolving action for candidates. More... | |
| Static Public Member Functions inherited from FBComponent | |
| static int | GetInternalClassId () |
| static void | FBComponentSetName (FBComponent *pObject, const char *pName) |
| static const char * | FBComponentGetName (FBComponent *pObject) |
| static void | FBComponentSetLongName (FBComponent *pObject, const char *pName) |
| static const char * | FBComponentGetLongName (FBComponent *pObject) |
| Static Public Attributes inherited from FBComponent | |
| static int | TypeInfo |
| Contains the Type information of the object. More... | |
| Protected Member Functions inherited from FBHUDElement | |
| FBHUDElement (const char *pName, HIObject pObject=NULL) | |
| Constructor. More... | |
| Protected Member Functions inherited from FBPlug | |
| bool | IsSDKComponent () |
| Return whether or not item is an SDK component. More... | |
| bool | ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
| Add a source connection. More... | |
| bool | ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
| Add a destination connection. More... | |
| bool | ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
| Add a source connection. More... | |
| bool | ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
| Add a destination connection. More... | |
| bool | DisconnectDst (FBPlug *pDst) |
| Remove a destination connection. More... | |
| bool | DisconnectSrc (FBPlug *pSrc) |
| Remove a source connection. More... | |
| void | DisconnectAllSrc () |
| Remove all source connections. More... | |
| void | DisconnectAllDst () |
| Remove all destination connections. More... | |
| bool | DisconnectDstAt (int pIndex) |
| Remove a destination connection at a specified index. More... | |
| bool | DisconnectSrcAt (int pIndex) |
| Remove a source connection at a specified index. More... | |
| bool | ReplaceDstAt (int pIndex, FBPlug *pDst) |
| Replace a destination connection at a specified index. More... | |
| bool | ReplaceSrcAt (int pIndex, FBPlug *pSrc) |
| Replace a source connection at a specified index. More... | |
| bool | SwapSrc (int pIndexA, int pIndexB) |
| Swap source connection at index A with source connection at index B. More... | |
| bool | MoveSrcAt (int pIndex, int pAtIndex) |
| Move source connection at pIndex to pAtIndex. More... | |
| bool | MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc) |
| Move source connection pSrc to the position of pAtSrc. More... | |
| int | GetSrcCount () |
| Get source connection count. More... | |
| FBPlug * | GetSrc (int pIndex) |
| Get a source connection's plug at specified index. More... | |
| FBConnectionType | GetSrcType (int pIndex) |
| Get a source connection's type at specified index. More... | |
| int | GetDstCount () |
| Get destination connection count. More... | |
| FBPlug * | GetDst (int pIndex) |
| Get a destination connection's plug at specified index. More... | |
| FBConnectionType | GetDstType (int pIndex) |
| Get a destination connection's type at specified index. More... | |
| bool | BeginChange () |
| Begins a change on multiple plugs. More... | |
| void | EndChange () |
| Ends a change on multiple plugs. More... | |
| void | SetSelfModified (FBPlugModificationFlag pFlag, bool pBool) |
| Set the plug's self modification flag. More... | |
| bool | GetSelfModified (FBPlugModificationFlag pFlag) |
| Tell if the plug's self has changed. More... | |
| void | SetContentModified (FBPlugModificationFlag pFlag, bool pBool) |
| Set the plug's owned property/object's modification flag. More... | |
| bool | GetContentModified (FBPlugModificationFlag pFlag) |
| Tell if the plug's content has changed. More... | |
| int | GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove) |
| Get plug's modified src/dst property/object connection added/removed List. More... | |
| bool | RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask) |
| Revert the plug's modification to original status. More... | |
| void | SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue) |
| Set the plug's status flag. More... | |
| bool | GetStatusFlag (FBPlugStatusFlag pStatus) const |
| Tell if the plug's status has changed. More... | |
| FBPlug * | GetOwner () |
| Get the owner of this plug. More... | |
| FBPlug * | GetOwned (int pIndex) |
| Get the owned plug at specified index. More... | |
| int | GetOwnedCount () |
| Get the owned plug count. More... | |
| virtual bool | PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0) |
| PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More... | |
| virtual bool | PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0) |
| PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More... | |
| virtual bool | PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL) |
| PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More... | |
| Static Protected Member Functions inherited from FBPlug | |
| static int | GetInternalClassId () |
| Internal class Id. More... | |
| Protected Attributes inherited from FBPlug | |
| bool | mAllocated |
| Contain the Allocation State of the Component. More... | |
| HIObject | mObject |
| Handle on the Plug. More... | |
| bool | mSDKComponent |
| bool Plug is an SDK component. More... | |
| Static Protected Attributes inherited from FBPlug | |
| static const char * | ClassGroupName |
| ClassGroupName of the object. More... | |
| static int | TypeInfo |
| TypeInfo. More... | |
| static int | mGlobalTypeInfo |
| Represente the Type Index. More... | |
Heads Up display.
Text element. Render text with a background rectangle to the HUD.
| FBHUDTextElement | ( | const char * | pName, |
| HIObject | pObject = NULL |
||
| ) |
Constructor.
| pName | Name of new HUD text element. |
| pObject | For internal use only. This parameter does not need to be specified by the developer. |
| FBStringList* GetFontList | ( | ) |
Returns a list of supported fonts.
| FBPropertyBool AdjustWidthToFitText |
| FBPropertyColorAndAlpha BackgroundColor |
| FBPropertyColorAndAlpha Color |
| FBPropertyString Content |
| FBPropertyString Font |
| FBPropertyBool ForceTimeCodeDisplay |
1.9.1