FBPlayerControl Class Reference

#include <fbsystem.h>
FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl FBPlayerControl
Inheritance diagram for FBPlayerControl:
Inheritance graph
[legend]

List of all members.

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.

Definition at line 702 of file 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.
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 ()
  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.

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.

Constructor & Destructor Documentation

FBPlayerControl ( HIObject  pObject = NULL  ) 

Constructor.

Parameters:
pObject  Internal parent object(default=NULL).

Member Function Documentation

bool Play ( bool  pUseMarkers = false  ) 

Play button.

Parameters:
pUseMarkers  Play until next marker if true, ignore markers otherwise.
Returns:
true if successful.

bool PlayReverse ( bool  pUseMarkers = false  ) 

Play Reverse button.

Parameters:
pUseMarkers  Play until next marker if true, ignore markers otherwise.
Returns:
true if successful.

void SetPlaySpeed ( FBTransportPlaySpeed  pPlaySpeed  ) 

Set Play Speed .

Parameters:
pPlaySpeed  indicate 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:
pTime  Time 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:
pOverrideTake  Write over current take?(default=false)
pCopyData  Unused. Necessary for compatibility(default=true).
Returns:
true if successful.

FBTransportMode GetTransportMode (  ) 

Get Transport Mode.

Returns:
Current mode of the transport controls.

void SetTransportFps ( FBTimeMode  pTimeMode,
double  pCustom = 0.0  
)

Set the system frame rate use for display.

Parameters:
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.

Returns:
current FrameRate selected for the system.

double GetTransportFpsValue (  ) 

Get the UI frame rate value.

Returns:
current FrameRate value based on the selected FBTimeMode for the system.

void Key (  ) 

Key default data.

Key all selected 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.

Member Data Documentation

FBPropertyBool LoopActive

Read Write Property: Is looping active?

Definition at line 813 of file fbsystem.h.

FBPropertyTime LoopStart

Read Write Property: Loop begin time.

Definition at line 814 of file fbsystem.h.

FBPropertyTime LoopStop

Read Write Property: Loop end time.

Definition at line 815 of file fbsystem.h.

FBPropertyTime ZoomWindowStart

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

Definition at line 817 of file fbsystem.h.

FBPropertyTime ZoomWindowStop

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

Definition at line 818 of file fbsystem.h.

FBPropertyTime NextMarker

Read Only Property: Next marked time.

Definition at line 820 of file fbsystem.h.

FBPropertyTime PreviousMarker

Read Only Property: Previous marked time.

Definition at line 821 of file fbsystem.h.

FBPropertyBool IsRecording

Read Only Property: Is there a recording in progress?

Definition at line 823 of file fbsystem.h.

FBPropertyBool IsPlaying

Read Only Property: Is the transport control playing?

Definition at line 824 of file fbsystem.h.

FBPropertyBool IsPlotting

Read Only Property: Is there a plotting in progress?

Definition at line 825 of file fbsystem.h.

FBPropertyTransportSnapMode SnapMode

Read Write Property: Set the transport control snap mode.

Definition at line 827 of file fbsystem.h.

FBPropertyTransportTimeFormat TransportTimeFormat

Read Write Property: Current Time Mode of the transport controls.

Definition at line 829 of file fbsystem.h.

FBPropertyTime RecordingSamplingPeriod

Read Write Property: Sampling period for the model recording.

Definition at line 831 of file fbsystem.h.

FBPropertyTime PlotSamplingPeriod

Read Write Property: Sampling period for the model plotting.

Definition at line 832 of file fbsystem.h.

Please send us your comments about this page.