FBPlayerControl Class Reference


Detailed Description

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.

Examples
Tasks/MirrorPoseOverTime.py, Tasks/MultiLayerKeying.py, Tasks/StartDevice.py, Tasks/StopDevice.py, Tasks/TimeCodeKeying.py, Samples/Profiling/CreateProfilingEventsLog.py, Samples/HUD/BloopSlate.py, Samples/HUD/RecordLight.py, Samples/HUD/Timeline.py, Samples/Camera/CameraSwitcher.py, Rendering/RenderLayers.py, ComplexTools/ShotTrackSetupTool.py
Inheritance diagram for FBPlayerControl:

List of all members.

Public Member Functions

 __init__ (object pObject=None)
 Constructor.
bool Play (bool pUseMarkers=False)
 Play button.
bool PlayReverse (bool pUseMarkers=False)
 Play Reverse button.
 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.
 LockTransport (bool pLock)
 Lock the transport control.
bool IsLocked ()
 Return the current locking state of the transport.
FBTransportMode GetTransportMode ()
 Get Transport Mode.
 SetTransportFps (FBTimeMode pTimeMode, float 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.
float GetTransportFpsValue (FBTimeMode pTimeMode=kFBTimeModeDefault)
 Get the UI frame rate value.
 Key ()
 Key default data.
 GotoNextKey ()
 Go to the next key.
 GotoPreviousKey ()
 Go to the previous key.
 EvaluationPause ()
 Pause device evaluation thread.
 EvaluationResume ()
 Resume device evaluation thread.
FBPlayerControl TheOne ()
 Get the global object for this class.

Public Attributes

FBPropertyBase LoopActive
 Read Write Property: Is looping active?.
FBPropertyBase LoopStart
 Read Write Property: Loop begin time.
FBPropertyBase LoopStop
 Read Write Property: Loop end time.
FBPropertyBase ZoomWindowStart
 Read Write Property: Starting time of the transport control zoom window.
FBPropertyBase ZoomWindowStop
 Read Write Property: Stopping time of the transport control zoom window.
FBPropertyBase NextMarker
 Read Only Property: Next marked time.
FBPropertyBase PreviousMarker
 Read Only Property: Previous marked time.
FBPropertyBase IsRecording
 Read Only Property: Is there a recording in progress?.
FBPropertyBase IsPlaying
 Read Only Property: Is the transport control playing?.
FBPropertyBase 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.
FBPropertyBase RecordingSamplingPeriod
 Read Write Property: Sampling period for the model recording.
FBPropertyBase PlotSamplingPeriod
 Read Write Property: Sampling period for the model plotting.

Member Function Documentation

bool Play ( bool  pUseMarkers = False)

Play button.

Parameters:
pUseMarkersPlay until next marker if true, ignore markers otherwise.
Returns:
true if successful.
bool PlayReverse ( bool  pUseMarkers = False)

Play Reverse button.

Parameters:
pUseMarkersPlay until next marker if true, ignore markers otherwise.
Returns:
true if successful.
SetPlaySpeed ( FBTransportPlaySpeed  pPlaySpeed)

Set Play Speed .

Parameters:
pPlaySpeedindicate the play speed when a play command occur.
FBTransportPlaySpeed GetPlaySpeed ( )

Get Play Speed .

Returns:
transport current playback speed.
bool Stop ( )

Stop button.

Returns:
true if successful.
bool GotoStart ( )

GotoStart button (Rewind).

Returns:
true if successful.
bool GotoEnd ( )

GotoEnd button (FastForward).

Returns:
true if successful.
bool Goto ( FBTime  pTime)

Goto a time specified by pTime.

Parameters:
pTimeTime to jump to.
Returns:
true if successful.
bool StepForward ( )

Step one frame ahead.

Returns:
true if successful.
bool StepBackward ( )

Step one frame backward.

Returns:
true if successful.
bool Record ( bool  pOverrideTake = False,
bool  pCopyData = True 
)

Begin recording.

Parameters:
pOverrideTakeWrite over current take?(default=false)
pCopyDataUnused. Necessary for compatibility(default=true).
Returns:
true if successful.
LockTransport ( bool  pLock)

Lock the transport control.

Parameters:
pLockboolean value that indicates the new locked state of the transport.
bool IsLocked ( )

Return the current locking state of the transport.

FBTransportMode GetTransportMode ( )

Get Transport Mode.

Returns:
Current mode of the transport controls.
SetTransportFps ( FBTimeMode  pTimeMode,
float  pCustom = 0.0 
)

Set the system frame rate use for display.

Parameters:
pTimeModeIndicate the frame rate value to use base on the FBTimeMode values enum.(kFBTimeModeDefault will be stored in fps)
pCustomShould 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.

Returns:
current FrameRate selected for the system.
float GetTransportFpsValue ( FBTimeMode  pTimeMode = kFBTimeModeDefault)

Get the UI frame rate value.

Parameters:
pTimeModethe time mode whose frame rate will be returned
Returns:
Frame rate of the input time mode or system time mode when pTimeMode is not provided.
Key ( )

Key default data.

Key all selected data.

GotoNextKey ( )

Go to the next key.

GotoPreviousKey ( )

Go to the previous key.

EvaluationPause ( )

Pause device evaluation thread.

EvaluationResume ( )

Resume device evaluation thread.

FBPlayerControl TheOne ( )

Get the global object for this class.

Returns:
the global object.

Member Data Documentation

FBPropertyBase LoopActive

Read Write Property: Is looping active?.

FBPropertyBase LoopStart

Read Write Property: Loop begin time.

FBPropertyBase LoopStop

Read Write Property: Loop end time.

FBPropertyBase ZoomWindowStart

Read Write Property: Starting time of the transport control zoom window.

FBPropertyBase ZoomWindowStop

Read Write Property: Stopping time of the transport control zoom window.

FBPropertyBase NextMarker

Read Only Property: Next marked time.

FBPropertyBase PreviousMarker

Read Only Property: Previous marked time.

FBPropertyBase IsRecording

Read Only Property: Is there a recording in progress?.

FBPropertyBase IsPlaying

Read Only Property: Is the transport control playing?.

FBPropertyBase 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.

FBPropertyBase RecordingSamplingPeriod

Read Write Property: Sampling period for the model recording.

FBPropertyBase PlotSamplingPeriod

Read Write Property: Sampling period for the model plotting.


FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl
FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl