Player control. More...
#include <pyfbsdk_generated.h>
Public Member Functions | |
FBPlayerControl () | |
Constructor. | |
int | AddGlobalTimeMark (FBTime pTime, str pName=None) |
Add a global time mark. | |
DeleteAllGlobalTimeMarks () | |
Delete all global time marks. | |
bool | DeleteGlobalTimeMark (int pIndex) |
Delete a global time mark. | |
EvaluationPause () | |
Pause device evaluation thread. | |
EvaluationResume () | |
Resume device evaluation thread. | |
FBTime | GetEditCurrentTime () |
Get Edit Current Time. | |
FBTime | GetEditStart () |
Get Edit Start. | |
FBTime | GetEditStop () |
Get Edit Stop. | |
FBTime | GetEditZoomStart () |
Get Edit Zoom Start. | |
FBTime | GetEditZoomStop () |
Get Edit Zoom Stop. | |
FBTimeMarkAction | GetGlobalTimeMarkAction (int pIndex) |
Returns the action associated with a global time mark. | |
FBColor | GetGlobalTimeMarkColor (int pIndex) |
Returns the color associated with a global time mark. | |
int | GetGlobalTimeMarkCount () |
Returns the number of global time marks. | |
bool | GetGlobalTimeMarkLock (int pIndex) |
Returns the lock status associated with a global time mark. | |
str | GetGlobalTimeMarkName (int pIndex) |
Returns the name associated with a global time mark. | |
FBTime | GetGlobalTimeMarkTime (int pIndex) |
Returns the time associated with a global time mark. | |
int | GetNextGlobalTimeMarkIndex () |
Returns the next global time mark index, based on the current local time. | |
float | GetPlaySpeed () |
Get Play Speed . | |
FBTransportPlaySpeed | GetPlaySpeedMode () |
Get Play Speed Mode. | |
int | GetPreviousGlobalTimeMarkIndex () |
Returns the previous global time mark index, based on the current local time. | |
FBTimeReferential | GetTimeReferential () |
Get Time Referential. | |
FBTimeMode | GetTransportFps () |
Get the UI frame rate use for display configure in the system. | |
float | GetTransportFpsValue (FBTimeMode pTimeMode=kFBTimeModeDefault) |
Get the UI frame rate value. | |
FBTransportMode | GetTransportMode () |
Get Transport Mode. | |
bool | Goto (FBTime pTime) |
Goto a time specified by pTime. | |
bool | Goto (FBTime p0, FBTimeReferential p1) |
Goto a time specified by pTime. | |
bool | GotoEnd () |
GotoEnd button (FastForward). | |
bool | GotoEnd (FBTimeReferential p0) |
GotoEnd button (FastForward). | |
GotoNextKey () | |
Go to the next key. | |
GotoPreviousKey () | |
Go to the previous key. | |
bool | GotoStart () |
GotoStart button (Rewind). | |
bool | GotoStart (FBTimeReferential p0) |
GotoStart button (Rewind). | |
bool | IsLocked () |
Return the current locking state of the transport. | |
Key () | |
Key default data. | |
LockTransport (bool pLock) | |
Lock the transport control. | |
bool | Play (bool pUseMarkers=False) |
Play button. | |
bool | PlayReverse (bool pUseMarkers=False) |
Play Reverse button. | |
bool | Record (bool pOverrideTake=False, bool pCopyData=True) |
Begin recording. | |
bool | SetAllGlobalTimeMarkLock (bool pLock) |
Sets the new lock status for all existing global time marks. | |
SetEditStart (FBTime pTime) | |
Set Edit Start. | |
SetEditStop (FBTime pTime) | |
Set Edit Stop. | |
SetEditZoomStart (FBTime pTime) | |
Set Edit Zoom Start. | |
SetEditZoomStop (FBTime pTime) | |
Set Edit Zoom Stop. | |
bool | SetGlobalTimeMarkAction (int pIndex, FBTimeMarkAction pAction) |
Sets a new action for an existing global time mark. | |
bool | SetGlobalTimeMarkColor (int pIndex, FBColor pColor) |
Sets a new color for an existing global time mark. | |
bool | SetGlobalTimeMarkLock (int pIndex, bool pLock) |
Sets a new lock status for an existing global time mark. | |
bool | SetGlobalTimeMarkName (int pIndex, str pName) |
Sets a new name for an existing global time mark. | |
int | SetGlobalTimeMarkTime (int pIndex, FBTime pTime) |
Sets a new time for an existing global time mark. | |
SetPlaySpeed (float pSpeed) | |
Set Play Speed. | |
SetPlaySpeedMode (FBTransportPlaySpeed pPlaySpeedMode) | |
Set Play Speed Mode. | |
SetTimeReferential (FBTimeReferential pTimeReferential) | |
Set Time Referential. | |
SetTransportFps (FBTimeMode pTimeMode, float pCustom=0.0) | |
Set the system frame rate use for display. | |
bool | StepBackward () |
Step one frame backward. | |
bool | StepBackward (FBTimeReferential p0) |
Step one frame backward. | |
bool | StepForward () |
Step one frame ahead. | |
bool | StepForward (FBTimeReferential p0) |
Step one frame ahead. | |
bool | Stop () |
Stop button. | |
![]() | |
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 | |
bool | IsPlaying |
Read Only Property: Is the transport control playing? | |
bool | IsPlotting |
Read Only Property: Is there a plotting in progress? | |
bool | IsRecording |
Read Only Property: Is there a recording in progress? | |
FBTransportLoopMode | LoopMode |
Read Write Property: Loop mode. | |
FBTime | LoopStart |
Read Write Property: Loop begin time. | |
FBTime | LoopStop |
Read Write Property: Loop end time. | |
FBTime | NextMarker |
Read Only Property: Next marked time. | |
FBEvent | OnChange |
Event Property: Fired when something in the player control has changed. (see FBEventPlayerControlChange) | |
FBTime | PlotSamplingPeriod |
Read Write Property: Sampling period for the model plotting. | |
FBTime | PreviousMarker |
Read Only Property: Previous marked time. | |
FBTime | RecordingSamplingPeriod |
Read Write Property: Sampling period for the model recording. | |
FBTransportSnapMode | SnapMode |
Read Write Property: Set the transport control snap mode. | |
FBTransportTimeFormat | TransportTimeFormat |
Read Write Property: Current Time Mode of the transport controls. | |
FBTime | ZoomWindowStart |
Read Write Property: Starting time of the transport control zoom window. | |
FBTime | ZoomWindowStop |
Read Write Property: Stopping time of the transport control zoom window. | |
![]() | |
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. | |
![]() | |
str | ClassGroupName |
ClassGroupName of the object. | |
int | TypeInfo |
TypeInfo. | |
Player control.
Interface to use the transport controls (play, stop, etc.) The following Python snippet shows its basic playback operation
Keys can also be set and used with Key(), GotoNextKey(), and GotoPreviousKey(). All actions are performed by default on the current take. The is the MotionBuilder default take, unless you have multiple takes in your scene. To switch between takes, use FBTake. To change the current reference time (e.g.: Local time, System time), use FBReferenceTime.
See samples: ShotTrackSetupTool.py, RenderLayers.py, CameraSwitcher.py, BloopSlate.py, RecordLight.py, Timeline.py, CreateProfilingEventsLog.py, MirrorPoseOverTime.py, MultiLayerKeying.py, StartDevice.py, StopDevice.py, TimeCodeKeying.py.
FBPlayerControl | ( | ) |
Constructor.
Add a global time mark.
It doesn't allow creating a time mark at the same time of another time mark. Note: Internally, the global time marks are stored in time order. Adding a time mark before other existing time marks will modify the index of these other time marks.
pTime | Time where to add the time mark. |
pName | Name of the time mark to add. |
DeleteAllGlobalTimeMarks | ( | ) |
Delete all global time marks.
Delete a global time mark.
Note: Internally, the global time marks are stored in time order. Deleting a time mark will modify the index of time marks laying after the deleted time mark.
pIndex | Index of the time mark to delete. |
EvaluationPause | ( | ) |
Pause device evaluation thread.
EvaluationResume | ( | ) |
Resume device evaluation thread.
FBTime GetEditCurrentTime | ( | ) |
Get Edit Current Time.
FBTime GetEditStart | ( | ) |
Get Edit Start.
FBTime GetEditStop | ( | ) |
Get Edit Stop.
FBTime GetEditZoomStart | ( | ) |
Get Edit Zoom Start.
FBTime GetEditZoomStop | ( | ) |
Get Edit Zoom Stop.
FBTimeMarkAction GetGlobalTimeMarkAction | ( | int | pIndex | ) |
Returns the action associated with a global time mark.
pIndex | Index of the time mark. |
Returns the color associated with a global time mark.
pIndex | Index of the time mark. |
int GetGlobalTimeMarkCount | ( | ) |
Returns the number of global time marks.
Returns the lock status associated with a global time mark.
pIndex | Index of the time mark. |
Returns the name associated with a global time mark.
pIndex | Index of the time mark. |
Returns the time associated with a global time mark.
pIndex | Index of the time mark. |
int GetNextGlobalTimeMarkIndex | ( | ) |
Returns the next global time mark index, based on the current local time.
float GetPlaySpeed | ( | ) |
Get Play Speed .
FBTransportPlaySpeed GetPlaySpeedMode | ( | ) |
Get Play Speed Mode.
int GetPreviousGlobalTimeMarkIndex | ( | ) |
Returns the previous global time mark index, based on the current local time.
FBTimeReferential GetTimeReferential | ( | ) |
Get Time Referential.
FBTimeMode GetTransportFps | ( | ) |
Get the UI frame rate use for display configure in the system.
float GetTransportFpsValue | ( | FBTimeMode | pTimeMode = kFBTimeModeDefault | ) |
Get the UI frame rate value.
pTimeMode | the time mode whose frame rate will be returned |
FBTransportMode GetTransportMode | ( | ) |
Get Transport Mode.
bool Goto | ( | FBTime | p0, |
FBTimeReferential | p1 | ||
) |
Goto a time specified by pTime.
p0 | Time to jump to. |
p1 | Time referential to use. kFBTimeReferentialAction or kFBTimeReferentialEdit |
Goto a time specified by pTime.
pTime | Time to jump to. |
bool GotoEnd | ( | ) |
GotoEnd button (FastForward).
bool GotoEnd | ( | FBTimeReferential | p0 | ) |
GotoEnd button (FastForward).
p0 | Time referential to use. kFBTimeReferentialAction or kFBTimeReferentialEdit |
GotoNextKey | ( | ) |
Go to the next key.
GotoPreviousKey | ( | ) |
Go to the previous key.
bool GotoStart | ( | ) |
GotoStart button (Rewind).
bool GotoStart | ( | FBTimeReferential | p0 | ) |
GotoStart button (Rewind).
p0 | Time referential to use. kFBTimeReferentialAction or kFBTimeReferentialEdit |
bool IsLocked | ( | ) |
Return the current locking state of the transport.
Key | ( | ) |
Key default data.
Key all selected data.
LockTransport | ( | bool | pLock | ) |
Lock the transport control.
pLock | boolean value that indicates the new locked state of the transport. |
Play button.
pUseMarkers | Play until next marker if true, ignore markers otherwise. |
Play Reverse button.
pUseMarkers | Play until next marker if true, ignore markers otherwise. |
Begin recording.
pOverrideTake | Write over current take?(default=false) |
pCopyData | Unused. Necessary for compatibility(default=true). |
Sets the new lock status for all existing global time marks.
pLock | The new lock status for all the time marks. |
SetEditStart | ( | FBTime | pTime | ) |
Set Edit Start.
pTime | The new start value for the edit time range. |
SetEditStop | ( | FBTime | pTime | ) |
Set Edit Stop.
pTime | The new stop value for the edit time range. |
SetEditZoomStart | ( | FBTime | pTime | ) |
Set Edit Zoom Start.
pTime | The new start value for the edit zoom window. |
SetEditZoomStop | ( | FBTime | pTime | ) |
Set Edit Zoom Stop.
pTime | The new stop value for the edit zoom window. |
bool SetGlobalTimeMarkAction | ( | int | pIndex, |
FBTimeMarkAction | pAction | ||
) |
Sets a new action for an existing global time mark.
pIndex | Index of the time mark. |
pAction | The new action for the time mark. |
Sets a new color for an existing global time mark.
pIndex | Index of the time mark. |
pColor | The new color for the time mark. |
Sets a new lock status for an existing global time mark.
pIndex | Index of the time mark. |
pLock | The new lock status for the time mark. |
Sets a new name for an existing global time mark.
pIndex | Index of the time mark. |
pName | The new name for the time mark. |
Sets a new time for an existing global time mark.
Note: Internally, the global time marks are stored in time order. Modifying the time of a time mark may modify the index of all time marks.
pIndex | Index of the time mark. |
pTime | The new time for the time mark. |
SetPlaySpeed | ( | float | pSpeed | ) |
Set Play Speed.
pSpeed | set customized speed. It will automatically convert to one of pre-defined play speed mode if it is equal to the pre-defined speed. |
SetPlaySpeedMode | ( | FBTransportPlaySpeed | pPlaySpeedMode | ) |
Set Play Speed Mode.
pPlaySpeedMode | a pre-defined play speed mode. Don't make sense to input kFBSpeed_Custom. To set the custom speed, use SetPlaySpeed() function directly. |
SetTimeReferential | ( | FBTimeReferential | pTimeReferential | ) |
Set Time Referential.
pTimeReferential | The new time referential. Only kFBTimeReferentialAction and kFBTimeReferentialEdit are supported |
SetTransportFps | ( | FBTimeMode | pTimeMode, |
float | pCustom = 0.0 |
||
) |
Set the system frame rate use for display.
pTimeMode | Indicate the frame rate value to use base on the FBTimeMode values enum.(kFBTimeModeDefault will be stored in fps) |
pCustom | Should the time mode be kFBTimeModeCustom, this is used to specify the custom framerate. |
bool StepBackward | ( | ) |
Step one frame backward.
bool StepBackward | ( | FBTimeReferential | p0 | ) |
Step one frame backward.
p0 | Time referential to use. kFBTimeReferentialAction or kFBTimeReferentialEdit |
bool StepForward | ( | ) |
Step one frame ahead.
bool StepForward | ( | FBTimeReferential | p0 | ) |
Step one frame ahead.
p0 | Time referential to use. kFBTimeReferentialAction or kFBTimeReferentialEdit |
bool Stop | ( | ) |
Stop button.
bool IsPlaying |
Read Only Property: Is the transport control playing?
bool IsPlotting |
Read Only Property: Is there a plotting in progress?
bool IsRecording |
Read Only Property: Is there a recording in progress?
FBTransportLoopMode LoopMode |
Read Write Property: Loop mode.
FBTime LoopStart |
Read Write Property: Loop begin time.
FBTime LoopStop |
Read Write Property: Loop end time.
FBTime NextMarker |
Read Only Property: Next marked time.
FBEvent OnChange |
Event Property: Fired when something in the player control has changed. (see FBEventPlayerControlChange)
FBTime PlotSamplingPeriod |
Read Write Property: Sampling period for the model plotting.
FBTime PreviousMarker |
Read Only Property: Previous marked time.
FBTime RecordingSamplingPeriod |
Read Write Property: Sampling period for the model recording.
FBTransportSnapMode SnapMode |
Read Write Property: Set the transport control snap mode.
FBTransportTimeFormat TransportTimeFormat |
Read Write Property: Current Time Mode of the transport controls.
FBTime ZoomWindowStart |
Read Write Property: Starting time of the transport control zoom window.
FBTime ZoomWindowStop |
Read Write Property: Stopping time of the transport control zoom window.