|
Python Reference Guide
|
|
|
Python Reference Guide
|
|
Heads Up display. More...
#include <pyfbsdk.h>
Public Member Functions | |
| FBHUDFlashElement (str pName) | |
| Constructor. | |
 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 | |
| str | FilePath |
| Read Write Property: Path to load the swf file from | |
| Public Attributes inherited from FBHUDElement | |
| float | 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. | |
| FBHUDElementHAlignment | HorizontalDock |
| Read Write Property: Specifies if the HUD element will be horizontally docked to the Left, Right, or Center. | |
| FBHUDElementHAlignment | Justification |
| Read Write Property: Specifies if the justification of the HUD element is Left, Right, or Center. | |
| bool | 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. | |
| bool | 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. | |
| bool | ScaleUniformly |
| Read Write Property: Specifies whether the width and height of HUD element will be scaled uniformly according to the initial aspect ratio. | |
| bool | Show |
| Read Write Property: Specifies if the HUD element will be displayed or not. | |
| FBHUDElementVAlignment | VerticalDock |
| Read Write Property: Specifies if the HUD element will be vertically docked to the Bottom, Top, or Center. | |
| float | 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. | |
| float | X |
| Read Write Property: Specifies the horizontal position of the HUD element, relative to dock position and justification. | |
| float | Y |
| Read Write Property: Specifies the vertical position of the HUD element, relative to dock position and justification. | |
| 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. | |
Heads Up display.
Flash HUD element. Display a flash (swf) file rendered on the HUD.
| FBHUDFlashElement | ( | str | pName | ) |
Constructor.
| pName | Name of new HUD flash element. |
| str FilePath |
Read Write Property: Path to load the swf file from
1.9.6