|
Python Reference Guide
|
|
|
Python Reference Guide
|
|
Video clip image media class. More...
Public Member Functions | |
| FBVideoClipImage (str pName) | |
| Constructor. More... | |
 Public Member Functions inherited from FBVideoClip | |
| FBVideoClip (str pName) | |
| Constructor. More... | |
| DrawImage (int pX=0, int pY=0, int pW=-1, int pH=-1, int pFrame=-1) | |
| Draw a frame of the image to the current view. More... | |
| FBDelete () | |
| Open Reality deletion function. More... | |
| bool | GetEmbeddedTimecode (int pFrame, FBTimeCode pTimeCode) |
| Get the embedded timecode associated to a video clip frame. More... | |
| int | GetTextureID () |
| Get the texture ID. More... | |
| bool | IsValid () |
| Verifies the validity of the FBVideo object. More... | |
| Public Member Functions inherited from FBVideo | |
| FBVideo (str pName) | |
| Constructor. More... | |
| Public Member Functions inherited from FBBox | |
| FBBox (str pName) | |
| Constructor. More... | |
| bool | AnimationNodeDestroy (FBAnimationNode pAnimationNode) |
| Destroy an animation node. More... | |
| FBAnimationNode | AnimationNodeInGet () |
| Get the (IN/OUT) animation node for this box. More... | |
| bool | AnimationNodeIsUserData (FBAnimationNode pAnimationNode) |
| Is the animation node user data? More... | |
| 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'. More... | |
| str | FbxGetObjectType () |
| Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'. More... | |
| FBAnimationNode | GetInConnector (int pIndex) |
| Get the animation node input associated with the given index. More... | |
| int | GetInConnectorCount () |
| Get the number of animation node inputs for this box. More... | |
| FBAnimationNode | GetOutConnector (int pIndex) |
| Get the animation node output associated with the given index. More... | |
| int | GetOutConnectorCount () |
| Get the number of animation node outputs for this box. More... | |
| Public Member Functions inherited from FBComponent | |
| FBComponent () | |
| Constructor. More... | |
| str | ClassName () |
| Get the class name. More... | |
| DisableObjectFlags (FBObjectFlag pFlags) | |
| Disable a specific Object Flags. More... | |
| EnableObjectFlags (FBObjectFlag pFlags) | |
| Enable a specific Object Flags. More... | |
| bool | FBCreate () |
| Open Reality Creation function. More... | |
| FBDelete () | |
| Open Reality deletion function. More... | |
| FBDestroy () | |
| Open Reality destruction function. More... | |
| FBObjectFlag | GetObjectFlags () |
| Get all Object Flags (concatenated). More... | |
| bool | GetObjectStatus (FBObjectStatus pStatus) |
| Check to see if an object status is enabled. More... | |
| FBFileReference | GetOwnerFileReference (p0) |
| Get the owner FileReference object. More... | |
| HardSelect () | |
| HardSelect. More... | |
| bool | HasObjectFlags (FBObjectFlag pFlags) |
| Check whether a specific object flag is enabled. More... | |
| bool | Is (int pTypeId) |
| Returns true if object is of type TypeId. More... | |
| bool | ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
| ProcessNamespaceHierarchy. More... | |
| bool | ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
| ProcessObjectNamespace. More... | |
| 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... | |
| FBProperty | PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None) |
| Create user or dynamic property. More... | |
| PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags) | |
| Get list of properties which have been modified since last loading. More... | |
| PropertyRemove (FBProperty pProperty) | |
| Remove a Property from the component's Property manager. More... | |
| SetObjectFlags (FBObjectFlag pFlags) | |
| SetObjectFlags. More... | |
| SetObjectStatus (FBObjectStatus pStatus, bool pValue) | |
| Enable/Disable a specific Object Status. More... | |
Public Attributes | |
| bool | ImageSequence |
| Read Write Property: Clip is an image sequence? More... | |
| FBVideoResolution | MaxMipMapResolution |
| Read Write Property: Maximum MipMap resolution will be loaded into GPU. More... | |
| bool | UseSystemFrameRate |
| Read Write Property: Clip is using system frame rate? More... | |
| Public Attributes inherited from FBVideoClip | |
| int | CurrentFrame |
| Read Write Property: Current frame. More... | |
| FBTime | CurrentFrameTime |
| Read Write Property: Current time in clip. More... | |
| FBTime | CurrentFrameTimeCode |
| Read Only Property: Embedded timecode from current frame in clip. Use the method GetEmbeddedTimecode to get the timecode of a different frame than the current frame. More... | |
| str | Filename |
| Read Write Property: Filename of media. More... | |
| FBVideoFormat | Format |
| Read Only Property: Video format. More... | |
| float | FrameRate |
| Read Write Property: Frame rate. More... | |
| FBTime | FrameTime |
| Read Only Property: Inverse of FPS, time per frame More... | |
| bool | FreeRunning |
| Read Write Property: Is free Running on? More... | |
| int | Height |
| Read Only Property: Height of image. More... | |
| FBVideoInterlaceMode | InterlaceMode |
| Read Write Property: Interlace mode. More... | |
| int | LastFrame |
| Read Only Property: Last frame in clip. More... | |
| FBTime | LastFrameTime |
| Read Only Property: Time of last frame More... | |
| bool | Loop |
| Read Write Property: Loop video clip? More... | |
| float | PlaySpeed |
| Read Write Property: Playback speed. More... | |
| int | PowerOfTwoHeight |
| Read Only Property: Closest power of two value superior to height of image. More... | |
| int | PowerOfTwoWidth |
| Read Only Property: Closest power of two value superior to width of image. More... | |
| FBVideoProxyMode | ProxyMode |
| Read Write Property: Proxy mode. More... | |
| str | RelativePath |
| Read Only Property: Relative path of media. More... | |
| int | StartFrame |
| Read Write Property: Frame to begin video playback from. More... | |
| int | StopFrame |
| Read Write Property: Frame to end video playback at. More... | |
| FBVideoStorageMode | StorageMode |
| Read Write Property: Storage mode. More... | |
| FBTime | TimeOffset |
| Read Write Property: Temporal offset for beginning of video. More... | |
| int | Width |
| Read Only Property: Width of image. More... | |
| Public Attributes inherited from FBVideo | |
| bool | KeepOnGPU |
| Read Write Property: Don't auto flush from GPU if true. session runtime flag, won't be saved. More... | |
| Public Attributes inherited from FBBox | |
| bool | Animatable |
| Read Write Property: Is the box animatable. More... | |
| bool | Live |
| Read Write Property: Is live? More... | |
| bool | RecordMode |
| Read Write Property: Is recording? More... | |
| str | UniqueName |
| internal Unique name. More... | |
| Public Attributes inherited from FBComponent | |
| FBListComponent | Components |
| List: List of components. More... | |
| str | LongName |
| Read Write Property: Name and namespace for object. More... | |
| str | Name |
| Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py. More... | |
| FBListComponent | Parents |
| List: Parents. More... | |
| FBManager | PropertyList |
| Read Only Property: Manages all of the properties for the component. More... | |
| bool | Selected |
| Read Write Property: Selected property. More... | |
| int | TypeInfo |
| Contains the Type information of the object. More... | |
| Public Attributes inherited from FBPlug | |
| str | ClassGroupName |
| ClassGroupName of the object. More... | |
| int | TypeInfo |
| TypeInfo. More... | |
Video clip image media class.
Used for a variety of image types. For DDS images, use the FBVideoClipImageDDS instead.
| FBVideoClipImage | ( | str | pName | ) |
Constructor.
| pName | Name of image file. |
| bool ImageSequence |
Read Write Property: Clip is an image sequence?
| FBVideoResolution MaxMipMapResolution |
Read Write Property: Maximum MipMap resolution will be loaded into GPU.
| bool UseSystemFrameRate |
Read Write Property: Clip is using system frame rate?
1.9.1