This reference page is linked to from the following overview topics: MotionBuilder 2014, Utility Classes, Animation, Takes.
Player control.
Interface to use the transport controls (play, stop, etc.) The following Python snippet shows its basic playback operation
lPlayer = FBPlayerControl() lPlayer.GotoStart() lPlayer.Play()
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.
Definition at line 915 of file fbsystem.h.
#include <fbsystem.h>
Public Member Functions | |
FBPlayerControl (HIObject pObject=NULL) | |
Constructor. | |
bool | Play (bool pUseMarkers=false) |
Play button. | |
bool | PlayReverse (bool pUseMarkers=false) |
Play Reverse button. | |
void | SetPlaySpeed (FBTransportPlaySpeed pPlaySpeed) |
Set Play Speed . | |
FBTransportPlaySpeed | GetPlaySpeed () |
Get Play Speed . | |
bool | Stop () |
Stop button. | |
bool | GotoStart () |
GotoStart button (Rewind). | |
bool | GotoEnd () |
GotoEnd button (FastForward). | |
bool | Goto (FBTime pTime) |
Goto a time specified by pTime . | |
bool | StepForward () |
Step one frame ahead. | |
bool | StepBackward () |
Step one frame backward. | |
bool | Record (bool pOverrideTake=false, bool pCopyData=true) |
Begin recording. | |
void | LockTransport (bool pLock) |
Lock the transport control. | |
bool | IsLocked () |
Return the current locking state of the transport. | |
FBTransportMode | GetTransportMode () |
Get Transport Mode. | |
void | SetTransportFps (FBTimeMode pTimeMode, double pCustom=0.0) |
Set the system frame rate use for display. | |
FBTimeMode | GetTransportFps () |
Get the UI frame rate use for display configure in the system. | |
double | GetTransportFpsValue (FBTimeMode pTimeMode=kFBTimeModeDefault) |
Get the UI frame rate value. | |
void | Key () |
Key default data. | |
void | GotoNextKey () |
Go to the next key. | |
void | GotoPreviousKey () |
Go to the previous key. | |
void | EvaluationPause () |
Pause device evaluation thread. | |
void | EvaluationResume () |
Resume device evaluation thread. | |
Static Public Member Functions | |
static FBPlayerControl & | TheOne () |
Get the global object for this class. | |
Public Attributes | |
FBPropertyBool | LoopActive |
Read Write Property: Is looping active? | |
FBPropertyTime | LoopStart |
Read Write Property: Loop begin time. | |
FBPropertyTime | LoopStop |
Read Write Property: Loop end time. | |
FBPropertyTime | ZoomWindowStart |
Read Write Property: Starting time of the transport control zoom window. | |
FBPropertyTime | ZoomWindowStop |
Read Write Property: Stopping time of the transport control zoom window. | |
FBPropertyTime | NextMarker |
Read Only Property: Next marked time. | |
FBPropertyTime | PreviousMarker |
Read Only Property: Previous marked time. | |
FBPropertyBool | IsRecording |
Read Only Property: Is there a recording in progress? | |
FBPropertyBool | IsPlaying |
Read Only Property: Is the transport control playing? | |
FBPropertyBool | IsPlotting |
Read Only Property: Is there a plotting in progress? | |
FBPropertyTransportSnapMode | SnapMode |
Read Write Property: Set the transport control snap mode. | |
FBPropertyTransportTimeFormat | TransportTimeFormat |
Read Write Property: Current Time Mode of the transport controls. | |
FBPropertyTime | RecordingSamplingPeriod |
Read Write Property: Sampling period for the model recording. | |
FBPropertyTime | PlotSamplingPeriod |
Read Write Property: Sampling period for the model plotting. |
FBPlayerControl | ( | HIObject | pObject = NULL | ) |
Constructor.
pObject | Internal parent object(default=NULL). |
bool Play | ( | bool | pUseMarkers = false | ) |
Play button.
pUseMarkers | Play until next marker if true, ignore markers otherwise. |
bool PlayReverse | ( | bool | pUseMarkers = false | ) |
Play Reverse button.
pUseMarkers | Play until next marker if true, ignore markers otherwise. |
void SetPlaySpeed | ( | FBTransportPlaySpeed | pPlaySpeed | ) |
Set Play Speed .
pPlaySpeed | indicate the play speed when a play command occur. |
FBTransportPlaySpeed GetPlaySpeed | ( | ) |
bool Stop | ( | ) |
bool GotoStart | ( | ) |
bool GotoEnd | ( | ) |
bool Goto | ( | FBTime | pTime | ) |
Goto a time specified by pTime
.
pTime | Time to jump to. |
bool StepForward | ( | ) |
bool StepBackward | ( | ) |
bool Record | ( | bool | pOverrideTake = false , |
bool | pCopyData = true |
||
) |
Begin recording.
pOverrideTake | Write over current take?(default=false) |
pCopyData | Unused. Necessary for compatibility(default=true). |
void LockTransport | ( | bool | pLock | ) |
Lock the transport control.
pLock | boolean value that indicates the new locked state of the transport. |
bool IsLocked | ( | ) |
Return the current locking state of the transport.
FBTransportMode GetTransportMode | ( | ) |
void SetTransportFps | ( | FBTimeMode | pTimeMode, |
double | 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. |
FBTimeMode GetTransportFps | ( | ) |
Get the UI frame rate use for display configure in the system.
double GetTransportFpsValue | ( | FBTimeMode | pTimeMode = kFBTimeModeDefault | ) |
Get the UI frame rate value.
pTimeMode | the time mode whose frame rate will be returned |
void Key | ( | ) |
void GotoNextKey | ( | ) |
Go to the next key.
void GotoPreviousKey | ( | ) |
Go to the previous key.
void EvaluationPause | ( | ) |
Pause device evaluation thread.
void EvaluationResume | ( | ) |
Resume device evaluation thread.
static FBPlayerControl& TheOne | ( | ) | [static] |
Read Write Property: Is looping active?
Definition at line 1038 of file fbsystem.h.
Read Write Property: Loop begin time.
Definition at line 1039 of file fbsystem.h.
Read Write Property: Loop end time.
Definition at line 1040 of file fbsystem.h.
Read Write Property: Starting time of the transport control zoom window.
Definition at line 1042 of file fbsystem.h.
Read Write Property: Stopping time of the transport control zoom window.
Definition at line 1043 of file fbsystem.h.
Read Only Property: Next marked time.
Definition at line 1045 of file fbsystem.h.
Read Only Property: Previous marked time.
Definition at line 1046 of file fbsystem.h.
Read Only Property: Is there a recording in progress?
Definition at line 1048 of file fbsystem.h.
Read Only Property: Is the transport control playing?
Definition at line 1049 of file fbsystem.h.
Read Only Property: Is there a plotting in progress?
Definition at line 1050 of file fbsystem.h.
FBPropertyTransportSnapMode SnapMode |
Read Write Property: Set the transport control snap mode.
Definition at line 1052 of file fbsystem.h.
FBPropertyTransportTimeFormat TransportTimeFormat |
Read Write Property: Current Time Mode of the transport controls.
Definition at line 1054 of file fbsystem.h.
Read Write Property: Sampling period for the model recording.
Definition at line 1056 of file fbsystem.h.
Read Write Property: Sampling period for the model plotting.
Definition at line 1057 of file fbsystem.h.