Player control. More...

#include <fbplayercontrol.h>

Inheritance diagram for FBPlayerControl:

[legend]

Public Member Functions
	FBPlayerControl (HIObject pObject=NULL)
	Constructor. More...

bool	Play (bool pUseMarkers=false)
	Play button. More...

bool	PlayReverse (bool pUseMarkers=false)
	Play Reverse button. More...

void	SetPlaySpeedMode (FBTransportPlaySpeed pPlaySpeedMode)
	Set Play Speed Mode. More...

void	SetPlaySpeed (double pSpeed)
	Set Play Speed. More...

FBTransportPlaySpeed	GetPlaySpeedMode ()
	Get Play Speed Mode. More...

double	GetPlaySpeed ()
	Get Play Speed . More...

bool	Stop ()
	Stop button. More...

bool	GotoStart ()
	GotoStart button (Rewind). More...

bool	GotoEnd ()
	GotoEnd button (FastForward). More...

bool	Goto (FBTime pTime)
	Goto a time specified by `pTime`. More...

bool	StepForward ()
	Step one frame ahead. More...

bool	StepBackward ()
	Step one frame backward. More...

bool	Record (bool pOverrideTake=false, bool pCopyData=true)
	Begin recording. More...

void	LockTransport (bool pLock)
	Lock the transport control. More...

bool	IsLocked ()
	Return the current locking state of the transport. More...

FBTransportMode	GetTransportMode ()
	Get Transport Mode. More...

void	SetTransportFps (FBTimeMode pTimeMode, double pCustom=0.0)
	Set the system frame rate use for display. More...

FBTimeMode	GetTransportFps ()
	Get the UI frame rate use for display configure in the system. More...

double	GetTransportFpsValue (FBTimeMode pTimeMode=kFBTimeModeDefault)
	Get the UI frame rate value. More...

void	Key ()
	Key default data. More...

void	GotoNextKey ()
	Go to the next key. More...

void	GotoPreviousKey ()
	Go to the previous key. More...

void	EvaluationPause ()
	Pause device evaluation thread. More...

void	EvaluationResume ()
	Resume device evaluation thread. More...

bool	Goto (FBTime, FBTimeReferential)
	Goto a time specified by pTime. More...

bool	GotoStart (FBTimeReferential)
	GotoStart button (Rewind). More...

bool	GotoEnd (FBTimeReferential)
	GotoEnd button (FastForward). More...

bool	StepForward (FBTimeReferential)
	Step one frame ahead. More...

bool	StepBackward (FBTimeReferential)
	Step one frame backward. More...

FBTimeReferential	GetTimeReferential ()
	Get Time Referential. More...

void	SetTimeReferential (FBTimeReferential pTimeReferential)
	Set Time Referential. More...

FBTime	GetEditCurrentTime ()
	Get Edit Current Time. More...

FBTime	GetEditStart ()
	Get Edit Start. More...

void	SetEditStart (FBTime pTime)
	Set Edit Start. More...

FBTime	GetEditStop ()
	Get Edit Stop. More...

void	SetEditStop (FBTime pTime)
	Set Edit Stop. More...

FBTime	GetEditZoomStart ()
	Get Edit Zoom Start. More...

void	SetEditZoomStart (FBTime pTime)
	Set Edit Zoom Start. More...

FBTime	GetEditZoomStop ()
	Get Edit Zoom Stop. More...

void	SetEditZoomStop (FBTime pTime)
	Set Edit Zoom Stop. More...

int	AddGlobalTimeMark (FBTime pTime, const char *pName=NULL)
	Add a global time mark. More...

bool	DeleteGlobalTimeMark (int pIndex)
	Delete a global time mark. More...

void	DeleteAllGlobalTimeMarks ()
	Delete all global time marks. More...

int	GetGlobalTimeMarkCount ()
	Returns the number of global time marks. More...

FBTime	GetGlobalTimeMarkTime (int pIndex)
	Returns the time associated with a global time mark. More...

int	SetGlobalTimeMarkTime (int pIndex, FBTime pTime)
	Sets a new time for an existing global time mark. More...

const char *	GetGlobalTimeMarkName (int pIndex)
	Returns the name associated with a global time mark. More...

bool	SetGlobalTimeMarkName (int pIndex, const char *pName)
	Sets a new name for an existing global time mark. More...

FBTimeMarkAction	GetGlobalTimeMarkAction (int pIndex)
	Returns the action associated with a global time mark. More...

bool	SetGlobalTimeMarkAction (int pIndex, FBTimeMarkAction pAction)
	Sets a new action for an existing global time mark. More...

FBColor	GetGlobalTimeMarkColor (int pIndex)
	Returns the color associated with a global time mark. More...

bool	SetGlobalTimeMarkColor (int pIndex, FBColor pColor)
	Sets a new color for an existing global time mark. More...

int	GetNextGlobalTimeMarkIndex ()
	Returns the next global time mark index, based on the current local time. More...

int	GetPreviousGlobalTimeMarkIndex ()
	Returns the previous global time mark index, based on the current local time. More...

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor. More...

virtual	~FBComponent ()
	Destructor. More...

virtual bool	FBCreate ()
	Open Reality Creation function. More...

virtual void	FBDestroy ()
	Open Reality destruction function. More...

virtual void	FBDelete () override
	Open Reality deletion function. More...

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer. More...

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager. More...

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager. More...

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading. More...

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property. More...

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated). More...

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags. More...

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled. More...

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags. More...

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags. More...

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status. More...

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled. More...

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace. More...

virtual const char *	ClassName () override
	Get the class name. More...

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not. More...

const char *	GetFullName (void)
	Get the full name. More...

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object. More...

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object. More...

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object. More...

void	HardSelect ()
	HardSelect. More...

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId. More...

virtual int	GetTypeId () override
	GetTypeId( int pTypeId ) More...

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Static Public Member Functions
static FBPlayerControl &	TheOne ()
	Get the global object for this class. More...

Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Public Attributes
FBPropertyBool	LoopActive
	Read Write Property: Is looping active? More...

FBPropertyTransportLoopMode	LoopMode
	Read Write Property: Loop mode. More...

FBPropertyTime	LoopStart
	Read Write Property: Loop begin time. More...

FBPropertyTime	LoopStop
	Read Write Property: Loop end time. More...

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

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

FBPropertyTime	NextMarker
	Read Only Property: Next marked time. More...

FBPropertyTime	PreviousMarker
	Read Only Property: Previous marked time. More...

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

FBPropertyBool	IsPlaying
	Read Only Property: Is the transport control playing? More...

FBPropertyBool	IsPlotting
	Read Only Property: Is there a plotting in progress? More...

FBPropertyTransportSnapMode	SnapMode
	Read Write Property: Set the transport control snap mode. More...

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

FBPropertyTime	RecordingSamplingPeriod
	Read Write Property: Sampling period for the model recording. More...

FBPropertyTime	PlotSamplingPeriod
	Read Write Property: Sampling period for the model plotting. More...

FBPropertyEvent	OnChange
	Event Property: Fired when something in the player control has changed. (see FBEventPlayerControlChange) More...

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyListComponent	Components
	List: List of components. More...

FBPropertyListComponent	Parents
	List: Parents. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

FBPropertyString	Name
	Read Write Property: Unique name of object. More...

FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component. More...

Additional Inherited Members
Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object. More...

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component. More...

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection. More...

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection. More...

void	DisconnectAllSrc ()
	Remove all source connections. More...

void	DisconnectAllDst ()
	Remove all destination connections. More...

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index. More...

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index. More...

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B. More...

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex. More...

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc. More...

int	GetSrcCount ()
	Get source connection count. More...

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index. More...

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index. More...

int	GetDstCount ()
	Get destination connection count. More...

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index. More...

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index. More...

bool	BeginChange ()
	Begins a change on multiple plugs. More...

void	EndChange ()
	Ends a change on multiple plugs. More...

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed. More...

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status. More...

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag. More...

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed. More...

FBPlug *	GetOwner ()
	Get the owner of this plug. More...

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index. More...

int	GetOwnedCount ()
	Get the owned plug count. More...

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id. More...

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component. More...

HIObject	mObject
	Handle on the Plug. More...

bool	mSDKComponent
	bool Plug is an SDK component. More...

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object. More...

static int	TypeInfo
	TypeInfo. More...

static int	mGlobalTypeInfo
	Represente the Type Index. More...

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 169 of file fbplayercontrol.h.

Constructor & Destructor Documentation

◆ FBPlayerControl()

FBPlayerControl ( HIObject pObject = NULL )

Constructor.

Parameters

pObject Internal parent object(default=NULL).

Member Function Documentation

◆ AddGlobalTimeMark()

int AddGlobalTimeMark	(	FBTime	pTime,
		const char *	pName = `NULL`
	)

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.

Parameters

pTime	Time where to add the time mark.
pName	Name of the time mark to add.

Returns: The index of the time mark added if the operation is successful, -1 otherwise.

◆ DeleteAllGlobalTimeMarks()

void DeleteAllGlobalTimeMarks ( )

Delete all global time marks.

◆ DeleteGlobalTimeMark()

bool DeleteGlobalTimeMark ( int pIndex )

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.

Parameters

pIndex Index of the time mark to delete.

Returns: True if the operation is successful, false otherwise.

◆ EvaluationPause()

void EvaluationPause ( )

Pause device evaluation thread.

◆ EvaluationResume()

void EvaluationResume ( )

Resume device evaluation thread.

◆ GetEditCurrentTime()

FBTime GetEditCurrentTime ( )

Get Edit Current Time.

Returns: The current time, in the edit time referential.

◆ GetEditStart()

FBTime GetEditStart ( )

Get Edit Start.

Returns: Start value for the edit time range.

◆ GetEditStop()

FBTime GetEditStop ( )

Get Edit Stop.

Returns: Stop value for the edit time range.

◆ GetEditZoomStart()

FBTime GetEditZoomStart ( )

Get Edit Zoom Start.

Returns: Start value for the edit zoom window.

◆ GetEditZoomStop()

FBTime GetEditZoomStop ( )

Get Edit Zoom Stop.

Returns: Stop value for the edit zoom window.

◆ GetGlobalTimeMarkAction()

FBTimeMarkAction GetGlobalTimeMarkAction ( int pIndex )

Returns the action associated with a global time mark.

Parameters

pIndex Index of the time mark.

Returns: The action associated with the time mark.

◆ GetGlobalTimeMarkColor()

FBColor GetGlobalTimeMarkColor ( int pIndex )

Returns the color associated with a global time mark.

Parameters

pIndex Index of the time mark.

Returns: The color associated with the time mark.

◆ GetGlobalTimeMarkCount()

int GetGlobalTimeMarkCount ( )

Returns the number of global time marks.

Returns: The number of global time marks.

◆ GetGlobalTimeMarkName()

const char* GetGlobalTimeMarkName ( int pIndex )

Returns the name associated with a global time mark.

Parameters

pIndex Index of the time mark.

Returns: The name associated with the time mark.

◆ GetGlobalTimeMarkTime()

FBTime GetGlobalTimeMarkTime ( int pIndex )

Returns the time associated with a global time mark.

Parameters

pIndex Index of the time mark.

Returns: The time associated with the time mark.

◆ GetNextGlobalTimeMarkIndex()

int GetNextGlobalTimeMarkIndex ( )

Returns the next global time mark index, based on the current local time.

Returns: The next global time mark index, -1 if any next time mark is available.

◆ GetPlaySpeed()

double GetPlaySpeed ( )

Get Play Speed .

Returns: transport current playback speed.

◆ GetPlaySpeedMode()

FBTransportPlaySpeed GetPlaySpeedMode ( )

Get Play Speed Mode.

Returns: transport current playback speed mode, including kFBSpeed_Custom mode.

◆ GetPreviousGlobalTimeMarkIndex()

int GetPreviousGlobalTimeMarkIndex ( )

Returns the previous global time mark index, based on the current local time.

Returns: The previous global time mark index, -1 if any previous time mark is available.

◆ GetTimeReferential()

FBTimeReferential GetTimeReferential ( )

Get Time Referential.

Returns: Current time referential.

◆ GetTransportFps()

FBTimeMode GetTransportFps ( )

Get the UI frame rate use for display configure in the system.

Returns: current FrameRate selected for the system.

◆ GetTransportFpsValue()

double GetTransportFpsValue ( FBTimeMode pTimeMode = kFBTimeModeDefault )

Get the UI frame rate value.

Parameters

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

◆ GetTransportMode()

FBTransportMode GetTransportMode ( )

Get Transport Mode.

Returns: Current mode of the transport controls.

◆ Goto() [1/2]

bool Goto ( FBTime pTime )

Goto a time specified by pTime.

Parameters

pTime Time to jump to.

Returns: true if successful.

◆ Goto() [2/2]

bool Goto	(	FBTime	,
		FBTimeReferential
	)

Goto a time specified by pTime.

Parameters

pTime	Time to jump to.
pTimeReferential	Time referential to use. kFBTimeReferentialAction or kFBTimeReferentialEdit

Returns: true if successful.

◆ GotoEnd() [1/2]

bool GotoEnd ( )

GotoEnd button (FastForward).

Returns: true if successful.

◆ GotoEnd() [2/2]

bool GotoEnd ( FBTimeReferential )

GotoEnd button (FastForward).

Parameters

pTimeReferential Time referential to use. kFBTimeReferentialAction or kFBTimeReferentialEdit

Returns: true if successful.

◆ GotoNextKey()

void GotoNextKey ( )

Go to the next key.

◆ GotoPreviousKey()

void GotoPreviousKey ( )

Go to the previous key.

◆ GotoStart() [1/2]

bool GotoStart ( )

GotoStart button (Rewind).

Returns: true if successful.

◆ GotoStart() [2/2]

bool GotoStart ( FBTimeReferential )

GotoStart button (Rewind).

Parameters

pTimeReferential Time referential to use. kFBTimeReferentialAction or kFBTimeReferentialEdit

Returns: true if successful.

◆ IsLocked()

bool IsLocked ( )

Return the current locking state of the transport.

◆ Key()

void Key ( )

Key default data.

Key all selected data.

◆ LockTransport()

void LockTransport ( bool pLock )

Lock the transport control.

Parameters

pLock boolean value that indicates the new locked state of the transport.

◆ Play()

bool Play ( bool pUseMarkers = false )

Play button.

Parameters

pUseMarkers Play until next marker if true, ignore markers otherwise.

Returns: true if successful.

◆ PlayReverse()

bool PlayReverse ( bool pUseMarkers = false )

Play Reverse button.

Parameters

pUseMarkers Play until next marker if true, ignore markers otherwise.

Returns: true if successful.

◆ Record()

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.

◆ SetEditStart()

void SetEditStart ( FBTime pTime )

Set Edit Start.

Parameters

pTime The new start value for the edit time range.

◆ SetEditStop()

void SetEditStop ( FBTime pTime )

Set Edit Stop.

Parameters

pTime The new stop value for the edit time range.

◆ SetEditZoomStart()

void SetEditZoomStart ( FBTime pTime )

Set Edit Zoom Start.

Parameters

pTime The new start value for the edit zoom window.

◆ SetEditZoomStop()

void SetEditZoomStop ( FBTime pTime )

Set Edit Zoom Stop.

Parameters

pTime The new stop value for the edit zoom window.

◆ SetGlobalTimeMarkAction()

bool SetGlobalTimeMarkAction	(	int	pIndex,
		FBTimeMarkAction	pAction
	)

Sets a new action for an existing global time mark.

Parameters

pIndex	Index of the time mark.
pAction	The new action for the time mark.

Returns: True if the operation is successful, false otherwise.

◆ SetGlobalTimeMarkColor()

bool SetGlobalTimeMarkColor	(	int	pIndex,
		FBColor	pColor
	)

Sets a new color for an existing global time mark.

Parameters

pIndex	Index of the time mark.
pColor	The new color for the time mark.

Returns: True if the operation is successful, false otherwise.

◆ SetGlobalTimeMarkName()

bool SetGlobalTimeMarkName	(	int	pIndex,
		const char *	pName
	)

Sets a new name for an existing global time mark.

Parameters

pIndex	Index of the time mark.
pName	The new name for the time mark.

Returns: True if the operation is successful, false otherwise.

◆ SetGlobalTimeMarkTime()

int SetGlobalTimeMarkTime	(	int	pIndex,
		FBTime	pTime
	)

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.

Parameters

pIndex	Index of the time mark.
pTime	The new time for the time mark.

Returns: The new index of the modified time mark.

◆ SetPlaySpeed()

void SetPlaySpeed ( double pSpeed )

Set Play Speed.

Parameters

pPlaySpeed 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()

void SetPlaySpeedMode ( FBTransportPlaySpeed pPlaySpeedMode )

Set Play Speed Mode.

Parameters

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()

void SetTimeReferential ( FBTimeReferential pTimeReferential )

Set Time Referential.

Parameters

pTimeReferential The new time referential. Only kFBTimeReferentialAction and kFBTimeReferentialEdit are supported

◆ SetTransportFps()

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.

◆ StepBackward() [1/2]

bool StepBackward ( )

Step one frame backward.

Returns: true if successful.

◆ StepBackward() [2/2]

bool StepBackward ( FBTimeReferential )

Step one frame backward.

Parameters

pTimeReferential Time referential to use. kFBTimeReferentialAction or kFBTimeReferentialEdit

Returns: true if successful.

◆ StepForward() [1/2]

bool StepForward ( )

Step one frame ahead.

Returns: true if successful.

◆ StepForward() [2/2]

bool StepForward ( FBTimeReferential )

Step one frame ahead.

Parameters

pTimeReferential Time referential to use. kFBTimeReferentialAction or kFBTimeReferentialEdit

Returns: true if successful.

◆ Stop()

bool Stop ( )

Stop button.

Returns: true if successful.

◆ TheOne()

static FBPlayerControl& TheOne ( )

static

Get the global object for this class.

Returns: the global object.

Member Data Documentation

◆ IsPlaying

FBPropertyBool IsPlaying

Read Only Property: Is the transport control playing?

Definition at line 314 of file fbplayercontrol.h.

◆ IsPlotting

FBPropertyBool IsPlotting

Read Only Property: Is there a plotting in progress?

Definition at line 315 of file fbplayercontrol.h.

◆ IsRecording

FBPropertyBool IsRecording

Read Only Property: Is there a recording in progress?

Definition at line 313 of file fbplayercontrol.h.

◆ LoopActive

FBPropertyBool LoopActive

Read Write Property: Is looping active?

Deprecated:: Use the LoopMode property instead.

Definition at line 302 of file fbplayercontrol.h.

◆ LoopMode

FBPropertyTransportLoopMode LoopMode

Read Write Property: Loop mode.

Definition at line 303 of file fbplayercontrol.h.

◆ LoopStart

FBPropertyTime LoopStart

Read Write Property: Loop begin time.

Definition at line 304 of file fbplayercontrol.h.

◆ LoopStop

FBPropertyTime LoopStop

Read Write Property: Loop end time.

Definition at line 305 of file fbplayercontrol.h.

◆ NextMarker

FBPropertyTime NextMarker

Read Only Property: Next marked time.

Definition at line 310 of file fbplayercontrol.h.

◆ OnChange

FBPropertyEvent OnChange

Event Property: Fired when something in the player control has changed. (see FBEventPlayerControlChange)

Definition at line 324 of file fbplayercontrol.h.

◆ PlotSamplingPeriod

FBPropertyTime PlotSamplingPeriod

Read Write Property: Sampling period for the model plotting.

Definition at line 322 of file fbplayercontrol.h.

◆ PreviousMarker

FBPropertyTime PreviousMarker

Read Only Property: Previous marked time.

Definition at line 311 of file fbplayercontrol.h.

◆ RecordingSamplingPeriod

FBPropertyTime RecordingSamplingPeriod

Read Write Property: Sampling period for the model recording.

Definition at line 321 of file fbplayercontrol.h.

◆ SnapMode

FBPropertyTransportSnapMode SnapMode

Read Write Property: Set the transport control snap mode.

Definition at line 317 of file fbplayercontrol.h.

◆ TransportTimeFormat

FBPropertyTransportTimeFormat TransportTimeFormat

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

Definition at line 319 of file fbplayercontrol.h.

◆ ZoomWindowStart

FBPropertyTime ZoomWindowStart

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

Definition at line 307 of file fbplayercontrol.h.

◆ ZoomWindowStop

FBPropertyTime ZoomWindowStop

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

Definition at line 308 of file fbplayercontrol.h.

The documentation for this class was generated from the following file:

fbplayercontrol.h

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBPlayerControl()

Member Function Documentation

◆ AddGlobalTimeMark()

◆ DeleteAllGlobalTimeMarks()

◆ DeleteGlobalTimeMark()

◆ EvaluationPause()

◆ EvaluationResume()

◆ GetEditCurrentTime()

◆ GetEditStart()

◆ GetEditStop()

◆ GetEditZoomStart()

◆ GetEditZoomStop()

◆ GetGlobalTimeMarkAction()

◆ GetGlobalTimeMarkColor()

◆ GetGlobalTimeMarkCount()

◆ GetGlobalTimeMarkName()

◆ GetGlobalTimeMarkTime()

◆ GetNextGlobalTimeMarkIndex()

◆ GetPlaySpeed()

◆ GetPlaySpeedMode()

◆ GetPreviousGlobalTimeMarkIndex()

◆ GetTimeReferential()

◆ GetTransportFps()

◆ GetTransportFpsValue()

◆ GetTransportMode()

◆ Goto() [1/2]

◆ Goto() [2/2]

◆ GotoEnd() [1/2]

◆ GotoEnd() [2/2]

◆ GotoNextKey()

◆ GotoPreviousKey()

◆ GotoStart() [1/2]

◆ GotoStart() [2/2]

◆ IsLocked()

◆ Key()

◆ LockTransport()

◆ Play()

◆ PlayReverse()

◆ Record()

◆ SetEditStart()

◆ SetEditStop()

◆ SetEditZoomStart()

◆ SetEditZoomStop()

◆ SetGlobalTimeMarkAction()

◆ SetGlobalTimeMarkColor()

◆ SetGlobalTimeMarkName()

◆ SetGlobalTimeMarkTime()

◆ SetPlaySpeed()

◆ SetPlaySpeedMode()

◆ SetTimeReferential()

◆ SetTransportFps()

◆ StepBackward() [1/2]

◆ StepBackward() [2/2]

◆ StepForward() [1/2]

◆ StepForward() [2/2]

◆ Stop()

◆ TheOne()

Member Data Documentation

◆ IsPlaying

◆ IsPlotting

◆ IsRecording

◆ LoopActive

◆ LoopMode

◆ LoopStart

◆ LoopStop

◆ NextMarker

◆ OnChange

◆ PlotSamplingPeriod

◆ PreviousMarker

◆ RecordingSamplingPeriod

◆ SnapMode

◆ TransportTimeFormat

◆ ZoomWindowStart

◆ ZoomWindowStop