This reference page is linked to from the following overview topics: Utility Classes, Animation, Takes.

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 730 of file fbsystem.h.

#include <fbsystem.h>

Inheritance diagram for FBPlayerControl:

[legend]

List of all members.

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

Constructor & Destructor Documentation

FBPlayerControl ( HIObject pObject = NULL )

Constructor.

Parameters:

pObject Internal parent object(default=NULL).

Member Function Documentation

bool Play ( bool pUseMarkers = false )

bool Record	(	bool	pOverrideTake = `false`,
		bool	pCopyData = `true`
	)

pOverrideTake	Write over current take?(default=false)
pCopyData	Unused. Necessary for compatibility(default=true).

void SetTransportFps	(	FBTimeMode	pTimeMode,
		double	pCustom = `0.0`
	)

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.

FBPlayerControl Class Reference

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation