FBPlayerControl Class Reference
 
 
 
FBPlayerControl Class Reference

This reference page is linked to from the following overview topics: Takes, Optical devices, Utility Classes, FBCamera - Cameras, FBPose - Poses, Animation.


#include <mobu-python-api.h>


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

Inheritance diagram for FBPlayerControl:
FBComponent FBPlug FBPythonWrapper

Public Member Functions

def  __reduce__ ()
def  GetPlaySpeed ()
def  __init__ ()
def  GetTransportFps ()
def  GetTransportFpsValue ()
def  GetTransportMode ()
def  Goto ()
def  GotoEnd ()
def  GotoNextKey ()
def  GotoPreviousKey ()
def  GotoStart ()
def  Key ()
def  Play ()
def  PlayReverse ()
def  Record ()
def  SetPlaySpeed ()
def  SetTransportFps ()
def  StepBackward ()
def  StepForward ()
def  Stop ()
def  LockTransport ()
def  IsLocked ()
def  EvaluationPause ()
def  EvaluationResume ()
def  PropertyGetModifiedList ()
def  ClassName ()
def  DisableObjectFlags ()
def  EnableObjectFlags ()
def  FBCreate ()
def  FBDelete ()
def  FBDestroy ()
def  GetObjectFlags ()
def  GetObjectStatus ()
def  HasObjectFlags ()
def  Is ()
def  ProcessNamespaceHierarchy ()
def  ProcessObjectNamespace ()
def  PropertyAdd ()
def  PropertyAddReferenceProperty ()
def  PropertyCreate ()
def  PropertyRemove ()
def  SetObjectFlags ()
def  SetObjectStatus ()
def  HardSelect ()
def  GetOwnerFileReference ()
def  BeginChange ()
def  ConnectDst ()
def  ConnectDstAt ()
def  ConnectSrc ()
def  ConnectSrcAt ()
def  DisconnectAllDst ()
def  DisconnectAllSrc ()
def  DisconnectDst ()
def  DisconnectDstAt ()
def  DisconnectSrc ()
def  DisconnectSrcAt ()
def  EndChange ()
def  GetDst ()
def  GetDstCount ()
def  GetDstType ()
def  GetOwned ()
def  GetOwnedCount ()
def  GetOwner ()
def  GetSrc ()
def  GetSrcCount ()
def  GetSrcType ()
def  IsSDKComponent ()
def  MoveSrcAt ()
def  ReplaceDstAt ()
def  ReplaceSrcAt ()
def  SwapSrc ()
def  SetSelfModified ()
def  GetSelfModified ()
def  SetContentModified ()
def  GetContentModified ()
def  GetPlugConnectionModifiedList ()
def  RevertModification ()
def  PrintClassDefinitions ()

Public Attributes

FBPropertyBool  IsPlaying
FBPropertyBool  IsRecording
FBPropertyBool  IsPlotting
FBPropertyBool  LoopActive
FBPropertyTime  LoopStart
FBPropertyTime  LoopStop
FBPropertyTime  NextMarker
FBPropertyTime  PreviousMarker
FBPropertyTransportSnapMode  SnapMode
FBPropertyTransportTimeFormat  TransportTimeFormat
FBPropertyTime  ZoomWindowStart
FBPropertyTime  ZoomWindowStop
FBPropertyTime  RecordingSamplingPeriod
FBPropertyTime  PlotSamplingPeriod
object  OwnerNamespace
FBPropertyListComponent  Components
FBPropertyString  Name
FBPropertyString  LongName
object  FullName
FBPropertyListComponent  Parents
FBPropertyManager  PropertyList
FBPropertyBool  Selected
object  OnUnbind

Member Function Documentation

def __reduce__ ( )
def GetPlaySpeed ( )

Python Docstring:

GetPlaySpeed( (FBPlayerControl)arg1) -> FBTransportPlaySpeed 

C++ Signature:

FBTransportPlaySpeed GetPlaySpeed() 

Get Play Speed .

Returns:
transport current playback speed.
def __init__ ( )

Python Docstring:

__init__( (object)arg1) -> None 

C++ Signature:

 FBPlayerControl(HIObject pObject = NULL) 

Constructor.

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

Reimplemented from FBComponent.

def GetTransportFps ( )

Python Docstring:

GetTransportFps( (FBPlayerControl)arg1) -> FBTimeMode 

C++ Signature:

FBTimeMode GetTransportFps() 

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

Returns:
current FrameRate selected for the system.
def GetTransportFpsValue ( )

Python Docstring:

GetTransportFpsValue( (FBPlayerControl)arg1 [, (FBTimeMode)arg2]) -> float 

C++ Signature:

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.
def GetTransportMode ( )

Python Docstring:

GetTransportMode( (FBPlayerControl)arg1) -> FBTransportMode 

C++ Signature:

FBTransportMode GetTransportMode() 

Get Transport Mode.

Returns:
Current mode of the transport controls.
def Goto ( )

Python Docstring:

Goto( (FBPlayerControl)arg1, (FBTime)arg2) -> bool 

C++ Signature:

bool Goto(FBTime pTime) 

Goto a time specified by pTime.

Parameters:
pTime Time to jump to.
Returns:
true if successful.
def GotoEnd ( )

Python Docstring:

GotoEnd( (FBPlayerControl)arg1) -> bool 

C++ Signature:

bool GotoEnd() 

GotoEnd button (FastForward).

Returns:
true if successful.
def GotoNextKey ( )

Python Docstring:

GotoNextKey( (FBPlayerControl)arg1) -> None 

C++ Signature:

void GotoNextKey() 

Go to the next key.

def GotoPreviousKey ( )

Python Docstring:

GotoPreviousKey( (FBPlayerControl)arg1) -> None 

C++ Signature:

void GotoPreviousKey() 

Go to the previous key.

def GotoStart ( )

Python Docstring:

GotoStart( (FBPlayerControl)arg1) -> bool 

C++ Signature:

bool GotoStart() 

GotoStart button (Rewind).

Returns:
true if successful.
def Key ( )

Python Docstring:

Key( (FBPlayerControl)arg1) -> None 

C++ Signature:

void Key() 

Key default data. Key all selected data.

def Play ( )

Python Docstring:

Play( (FBPlayerControl)arg1 [, (object)arg2]) -> bool 

C++ Signature:

bool Play(bool pUseMarkers = false) 

Play button.

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

Python Docstring:

PlayReverse( (FBPlayerControl)arg1 [, (object)arg2]) -> bool 

C++ Signature:

bool PlayReverse(bool pUseMarkers = false) 

Play Reverse button.

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

Python Docstring:

Record( (FBPlayerControl)arg1 [, (object)arg2 [, (object)arg3]]) -> bool 

C++ Signature:

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.
def SetPlaySpeed ( )

Python Docstring:

SetPlaySpeed( (FBPlayerControl)arg1, (FBTransportPlaySpeed)arg2) -> None 

C++ Signature:

void SetPlaySpeed(FBTransportPlaySpeed pPlaySpeed) 

Set Play Speed .

Parameters:
pPlaySpeed indicate the play speed when a play command occur.
def SetTransportFps ( )

Python Docstring:

SetTransportFps( (FBPlayerControl)arg1, (FBTimeMode)arg2 [, (object)arg3]) -> None 

C++ Signature:

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.
def StepBackward ( )

Python Docstring:

StepBackward( (FBPlayerControl)arg1) -> bool 

C++ Signature:

bool StepBackward() 

Step one frame backward.

Returns:
true if successful.
def StepForward ( )

Python Docstring:

StepForward( (FBPlayerControl)arg1) -> bool 

C++ Signature:

bool StepForward() 

Step one frame ahead.

Returns:
true if successful.
def Stop ( )

Python Docstring:

Stop( (FBPlayerControl)arg1) -> bool 

C++ Signature:

bool Stop() 

Stop button.

Returns:
true if successful.
def LockTransport ( )

Python Docstring:

LockTransport( (FBPlayerControl)arg1, (object)arg2) -> None 

C++ Signature:

void LockTransport(bool pLock) 

Lock the transport control.

Parameters:
pLock boolean value that indicates the new locked state of the transport.
def IsLocked ( )

Python Docstring:

IsLocked( (FBPlayerControl)arg1) -> bool 

C++ Signature:

bool IsLocked() 

Return the current locking state of the transport.

def EvaluationPause ( )

Python Docstring:

EvaluationPause( (FBPlayerControl)arg1) -> None 

C++ Signature:

void EvaluationPause() 

Pause device evaluation thread.

def EvaluationResume ( )

Python Docstring:

EvaluationResume( (FBPlayerControl)arg1) -> None 

C++ Signature:

void EvaluationResume() 

Resume device evaluation thread.

def PropertyGetModifiedList ( ) [inherited]

Python Docstring:

PropertyGetModifiedList( (FBComponent)arg1, (FBPlugModificationFlag)arg2) -> FBPropertyList 

C++ Signature:

void PropertyGetModifiedList(FBArrayTemplate< FBProperty * > & pPropList, FBPlugModificationFlag pModificationFlags) 

Get list of properties which have been modified since last loading.

Parameters:
pPropList property list to hold the modified properties.
pModificationFlags type of modification to query.
def ClassName ( ) [inherited]

Python Docstring:

ClassName( (FBComponent)arg1) -> str 

C++ Signature:

const char * ClassName() 

Get the class name.

Returns:
The class name (i.e. "FBComponent").

Reimplemented from FBPlug.

def DisableObjectFlags ( ) [inherited]

Python Docstring:

DisableObjectFlags( (FBComponent)arg1, (FBObjectFlag)arg2) -> None 

C++ Signature:

void DisableObjectFlags(FBObjectFlag pFlags) 

Disable a specific Object Flags.

Parameters:
pFlags Flags to disable.
def EnableObjectFlags ( ) [inherited]

Python Docstring:

EnableObjectFlags( (FBComponent)arg1, (FBObjectFlag)arg2) -> None 

C++ Signature:

void EnableObjectFlags(FBObjectFlag pFlags) 

Enable a specific Object Flags.

Parameters:
pFlags Flags to enable.
def FBCreate ( ) [inherited]

Python Docstring:

FBCreate( (FBComponent)arg1) -> bool 

C++ Signature:

bool FBCreate() 

Open Reality Creation function.

Returns:
Outcome of creation (true/false).

Reimplemented in FBAssetFile, FBAssetFolder, FBDevice, and FBDeviceOptical.

def FBDelete ( ) [inherited]
def FBDestroy ( ) [inherited]

Python Docstring:

FBDestroy( (FBComponent)arg1) -> None 

C++ Signature:

void FBDestroy() 

Open Reality destruction function.

Reimplemented in FBAssetFile, FBAssetFolder, FBDevice, and FBDeviceOptical.

def GetObjectFlags ( ) [inherited]

Python Docstring:

GetObjectFlags( (FBComponent)arg1) -> FBObjectFlag 

C++ Signature:

FBObjectFlag GetObjectFlags() 

Get all Object Flags (concatenated).

Returns:
Get all object flags in one call. Flags can be concatenated.
def GetObjectStatus ( ) [inherited]

Python Docstring:

GetObjectStatus( (FBComponent)arg1, (FBObjectStatus)arg2) -> bool 

C++ Signature:

bool GetObjectStatus(FBObjectStatus pStatus) 

Check to see if an object status is enabled.

Parameters:
pStatus Status to query.
def HasObjectFlags ( ) [inherited]

Python Docstring:

HasObjectFlags( (FBComponent)arg1, (FBObjectFlag)arg2) -> bool 

C++ Signature:

bool HasObjectFlags(FBObjectFlag pFlags) 

Check whether a specific object flag is enabled.

Parameters:
pFlags Flags to check if they are present.
Returns:
True if all flags in pFlags are enabled.
def Is ( ) [inherited]

Python Docstring:

Is( (FBComponent)arg1, (object)arg2) -> bool 

C++ Signature:

bool Is(int pTypeId) 

Returns true if object is of type TypeId.

Parameters:
pTypeId TypeId to compare object to.
Returns:
Result of the comparison.

Reimplemented from FBPlug.

def ProcessNamespaceHierarchy ( ) [inherited]

Python Docstring:

ProcessNamespaceHierarchy( (FBComponent)arg1, (FBNamespaceAction)arg2, (str)arg3 [, (str)arg4 [, (object)arg5]]) -> bool 

C++ Signature:

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

ProcessNamespaceHierarchy. New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This recursive function goes through the whole hierarchy (children) to add/replace the prefix. If you need to work on a single object, use the ProcessObjectPrefix function.

Parameters:
pNamespaceAction Which operation to do on the hierarchy (children).
pNamespaceName The Namespace name on Add/Delete or the prefix to replace in case of replace.
pReplaceTo The new Namespace Name or NULL in case of add or delete.
pAddRight Whether to add the namespace on right-most or left-most side or other namespace.
Returns:
return true if process successful.
def ProcessObjectNamespace ( ) [inherited]

Python Docstring:

ProcessObjectNamespace( (FBComponent)arg1, (FBNamespaceAction)arg2, (str)arg3 [, (str)arg4 [, (object)arg5]]) -> bool 

C++ Signature:

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

ProcessObjectNamespace. New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This function is the same as ProcessNamespaceHierarchy except that it applies only on the current object and not to the object's children.

Parameters:
pNamespaceAction Which operation to do on the hierarchy (children).
pNamespaceName The Namespace name on Add/Delete or the prefix to replace in case of replace.
pReplaceTo The new Namespace Name or NULL in case of add or delete.
pAddRight Whether to add the namespace on right-most or left-most side or other namespace.
Returns:
return true if process successful.
def PropertyAdd ( ) [inherited]

Python Docstring:

PropertyAdd( (FBComponent)arg1, (FBProperty)arg2) -> int 

C++ Signature:

int PropertyAdd(FBProperty * pProperty) 

Add a property to the component's property manager.

Parameters:
pProperty The property to add to the property manager.
Returns:
Index in the property array where property was inserted.
def PropertyAddReferenceProperty ( ) [inherited]

Python Docstring:

PropertyAddReferenceProperty( (FBComponent)arg1, (FBProperty)arg2) -> bool 

C++ Signature:

bool PropertyAddReferenceProperty(FBProperty * pReferenceProperty) 

Add a reference property to the component's property manager.

Parameters:
pReferenceProperty The property to from an other object to add a reference to (property cannot be a custom ORSDK property).
Returns:
True if the reference property could be added.
def PropertyCreate ( ) [inherited]

Python Docstring:

PropertyCreate( (FBComponent)arg1, (str)arg2, (FBPropertyType)arg3, (str)arg4, (object)arg5, (object)arg6, (FBProperty)arg7) -> object 

C++ Signature:

FBProperty * PropertyCreate(const char * pName, FBPropertyType pType, const char * pDataType, bool pAnimatable, bool pIsUser = false, FBProperty * pReferenceSource = NULL) 

Create user or dynamic property.

Parameters:
pName The name of the property.
pType Type of the property. See enum FBPropertyType.
pDataType DataType of the property.
pAnimatable To specify if the property can be animated.
pIsUser To specify if the property is available as a custom property or dynamic and attached to the object.
pReferenceSource Specifies the property that a reference refers to.
def PropertyRemove ( ) [inherited]

Python Docstring:

PropertyRemove( (FBComponent)arg1, (FBProperty)arg2) -> None 

C++ Signature:

void PropertyRemove(FBProperty * pProperty) 

Remove a Property from the component's Property manager. If the property was dynamically allocated, it is deleted.

Parameters:
pProperty The property to remove from the property manager.
def SetObjectFlags ( ) [inherited]

Python Docstring:

SetObjectFlags( (FBComponent)arg1, (FBObjectFlag)arg2) -> None 

C++ Signature:

void SetObjectFlags(FBObjectFlag pFlags) 

SetObjectFlags.

Parameters:
pFlags Set flag values. Note: this function overwrites all flags with those passed in parameter.
def SetObjectStatus ( ) [inherited]

Python Docstring:

SetObjectStatus( (FBComponent)arg1, (FBObjectStatus)arg2, (object)arg3) -> None 

C++ Signature:

void SetObjectStatus(FBObjectStatus pStatus, bool pValue) 

Enable/Disable a specific Object Status.

Parameters:
pStatus Status to change.
pValue Value to change the status to.
def HardSelect ( ) [inherited]

Python Docstring:

HardSelect( (FBComponent)arg1) -> None 

C++ Signature:

void HardSelect() 

HardSelect. Selects the object, and emits a hard select event for UI update notification.

def GetOwnerFileReference ( ) [inherited]

Python Docstring:

GetOwnerFileReference( (FBComponent)arg1) -> object 

C++ Signature:

FBFileReference * GetOwnerFileReference(void ) 

Get the owner FileReference object.

Returns:
the owner FileReference object
def BeginChange ( ) [inherited]

Python Docstring:

BeginChange( (FBPlug)arg1) -> bool 

C++ Signature:

bool BeginChange() 

Begins a change on multiple plugs.

Returns:
A boolean indicating success (True) or failure (False).
def ConnectDst ( ) [inherited]

Python Docstring:

ConnectDst( (FBPlug)arg1, (FBPlug)arg2 [, (FBConnectionType)arg3]) -> bool 

C++ Signature:

bool ConnectDst(FBPlug * pDst, FBConnectionType pConnectionType = kFBConnectionTypeNone) 

Add a destination connection.

Parameters:
pDst Destination plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False)
def ConnectDstAt ( ) [inherited]

Python Docstring:

ConnectDstAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3 [, (FBConnectionType)arg4]) -> bool 

C++ Signature:

bool ConnectDstAt(int pSrc_DstIndex, FBPlug * pDst, FBConnectionType pConnectionType = kFBConnectionTypeNone) 

Add a destination connection.

Parameters:
pSrc_DstIndex Index that tells where to add this destination connection in the source's connection list. if index is out of bound, and this destination connection will be appended at the end.
pDst Destination plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
def ConnectSrc ( ) [inherited]

Python Docstring:

ConnectSrc( (FBPlug)arg1, (FBPlug)arg2 [, (FBConnectionType)arg3]) -> bool 

C++ Signature:

bool ConnectSrc(FBPlug * pSrc, FBConnectionType pConnectionType = kFBConnectionTypeNone) 

Add a source connection.

Parameters:
pSrc Source plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
def ConnectSrcAt ( ) [inherited]

Python Docstring:

ConnectSrcAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3 [, (FBConnectionType)arg4]) -> bool 

C++ Signature:

bool ConnectSrcAt(int pDst_SrcIndex, FBPlug * pSrc, FBConnectionType pConnectionType = kFBConnectionTypeNone) 

Add a source connection.

Parameters:
pDst_SrcIndex Index that tells where to add this source connection in the destination's connection list. if index is out of bound, and this source connection will be appended at the end.
pSrc Source plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
def DisconnectAllDst ( ) [inherited]

Python Docstring:

DisconnectAllDst( (FBPlug)arg1) -> None 

C++ Signature:

void DisconnectAllDst() 

Remove all destination connections.

def DisconnectAllSrc ( ) [inherited]

Python Docstring:

DisconnectAllSrc( (FBPlug)arg1) -> None 

C++ Signature:

void DisconnectAllSrc() 

Remove all source connections.

def DisconnectDst ( ) [inherited]

Python Docstring:

DisconnectDst( (FBPlug)arg1, (FBPlug)arg2) -> bool 

C++ Signature:

bool DisconnectDst(FBPlug * pDst) 

Remove a destination connection.

Parameters:
pDst Destination plug.
Returns:
A boolean indicating success (True) or failure (False).
def DisconnectDstAt ( ) [inherited]

Python Docstring:

DisconnectDstAt( (FBPlug)arg1, (object)arg2) -> bool 

C++ Signature:

bool DisconnectDstAt(int pIndex) 

Remove a destination connection at a specified index.

Parameters:
pIndex Destination plug index.
Returns:
A boolean indicating success (True) or failure (False).
def DisconnectSrc ( ) [inherited]

Python Docstring:

DisconnectSrc( (FBPlug)arg1, (FBPlug)arg2) -> bool 

C++ Signature:

bool DisconnectSrc(FBPlug * pSrc) 

Remove a source connection.

Parameters:
pSrc Source plug.
Returns:
A boolean indicating success (True) or failure (False).
def DisconnectSrcAt ( ) [inherited]

Python Docstring:

DisconnectSrcAt( (FBPlug)arg1, (object)arg2) -> bool 

C++ Signature:

bool DisconnectSrcAt(int pIndex) 

Remove a source connection at a specified index.

Parameters:
pIndex Source plug index.
Returns:
A boolean indicating success (True) or failure (False).
def EndChange ( ) [inherited]

Python Docstring:

EndChange( (FBPlug)arg1) -> None 

C++ Signature:

void EndChange() 

Ends a change on multiple plugs.

def GetDst ( ) [inherited]

Python Docstring:

GetDst( (FBPlug)arg1, (object)arg2) -> object 

C++ Signature:

FBPlug * GetDst(int pIndex) 

Get a destination connection's plug at specified index.

Parameters:
pIndex Index of the destination connection's plug.
Returns:
Destination plug at specified index.
def GetDstCount ( ) [inherited]

Python Docstring:

GetDstCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetDstCount() 

Get destination connection count.

Returns:
Total destinations connections count.
def GetDstType ( ) [inherited]

Python Docstring:

GetDstType( (FBPlug)arg1, (object)arg2) -> FBConnectionType 

C++ Signature:

FBConnectionType GetDstType(int pIndex) 

Get a destination connection's type at specified index.

Parameters:
pIndex Index of the destination connection's type.
Returns:
Destination connection's type at specified index.
def GetOwned ( ) [inherited]

Python Docstring:

GetOwned( (FBPlug)arg1, (object)arg2) -> object 

C++ Signature:

FBPlug * GetOwned(int pIndex) 

Get the owned plug at specified index.

Parameters:
pIndex Index of the owned plug to get.
Returns:
The owned plug at specified index.
def GetOwnedCount ( ) [inherited]

Python Docstring:

GetOwnedCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetOwnedCount() 

Get the owned plug count.

Returns:
The owned plug count.
def GetOwner ( ) [inherited]

Python Docstring:

GetOwner( (FBPlug)arg1) -> object 

C++ Signature:

FBPlug * GetOwner() 

Get the owner of this plug. Very useful for properties since they are plugs too.

Returns:
The owner of this plug.
def GetSrc ( ) [inherited]

Python Docstring:

GetSrc( (FBPlug)arg1, (object)arg2) -> object 

C++ Signature:

FBPlug * GetSrc(int pIndex) 

Get a source connection's plug at specified index.

Parameters:
pIndex Index of the source connection's plug.
Returns:
Source plug at specified index.
def GetSrcCount ( ) [inherited]

Python Docstring:

GetSrcCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetSrcCount() 

Get source connection count.

Returns:
Total sources connections count.
def GetSrcType ( ) [inherited]

Python Docstring:

GetSrcType( (FBPlug)arg1, (object)arg2) -> FBConnectionType 

C++ Signature:

FBConnectionType GetSrcType(int pIndex) 

Get a source connection's type at specified index.

Parameters:
pIndex Index of the source connection's type.
Returns:
Source connection's type at specified index.
def IsSDKComponent ( ) [inherited]

Python Docstring:

IsSDKComponent( (FBPlug)arg1) -> bool 

C++ Signature:

bool IsSDKComponent() 

Return whether or not item is an SDK component.

def MoveSrcAt ( ) [inherited]

Python Docstring:

MoveSrcAt( (FBPlug)arg1, (object)arg2, (object)arg3) -> bool

MoveSrcAt( (FBPlug)arg1, (FBPlug)arg2, (FBPlug)arg3) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool MoveSrcAt(int pIndex, int pAtIndex)
bool MoveSrcAt(FBPlug * pSrc, FBPlug * pAtSrc)
def ReplaceDstAt ( ) [inherited]

Python Docstring:

ReplaceDstAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3) -> bool 

C++ Signature:

bool ReplaceDstAt(int pIndex, FBPlug * pDst) 

Replace a destination connection at a specified index.

Parameters:
pIndex Destination plug index.
pDst Plug that will replace the other at index.
Returns:
A boolean indicating success (True) or failure (False).
def ReplaceSrcAt ( ) [inherited]

Python Docstring:

ReplaceSrcAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3) -> bool 

C++ Signature:

bool ReplaceSrcAt(int pIndex, FBPlug * pSrc) 

Replace a source connection at a specified index.

Parameters:
pIndex Source plug index.
pSrc Plug that will replace the other at index.
Returns:
A boolean indicating success (True) or failure (False).
def SwapSrc ( ) [inherited]

Python Docstring:

SwapSrc( (FBPlug)arg1, (object)arg2, (object)arg3) -> bool 

C++ Signature:

bool SwapSrc(int pIndexA, int pIndexB) 

Swap source connection at index A with source connection at index B.

Parameters:
pIndexA Plug index.
pIndexB Other plug index.
Returns:
A boolean indicating success (True) or failure (False).
def SetSelfModified ( ) [inherited]

Python Docstring:

SetSelfModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2, (object)arg3) -> None 

C++ Signature:

void SetSelfModified(FBPlugModificationFlag pFlag, bool pBool) 

Set the plug's self modification flag.

Parameters:
pFlag bitwise AND of self modification flags.
pBool true if self changed.
def GetSelfModified ( ) [inherited]

Python Docstring:

GetSelfModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2) -> bool 

C++ Signature:

bool GetSelfModified(FBPlugModificationFlag pFlag) 

Tell if the plug's self has changed.

Parameters:
pFlag bitwise AND of self modification flags.
Returns:
true if self changed
def SetContentModified ( ) [inherited]

Python Docstring:

SetContentModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2, (object)arg3) -> None 

C++ Signature:

void SetContentModified(FBPlugModificationFlag pFlag, bool pBool) 

Set the plug's owned property/object's modification flag.

Parameters:
pFlag bitwise AND of content modification flags.
pBool true if content has modification.
def GetContentModified ( ) [inherited]

Python Docstring:

GetContentModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2) -> bool 

C++ Signature:

bool GetContentModified(FBPlugModificationFlag pFlag) 

Tell if the plug's content has changed.

Parameters:
pFlag bitwise AND of content modification flags.
Returns:
true if content connection changed.
def GetPlugConnectionModifiedList ( ) [inherited]

Python Docstring:

GetPlugConnectionModifiedList( (FBPlug)arg1, (FBPlugList)arg2, (FBPlugModificationFlag)arg3, (object)arg4) -> int 

C++ Signature:

int GetPlugConnectionModifiedList(FBArrayTemplate & pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove) 

Get plug's modified src/dst property/object connection added/removed List.

Parameters:
pPlugList plug list to fill up.
pConnectionModificatonFlag Src/Dst Property/Object connection modification flag.
pAddRemove Ask for the added list if true, removed list if false.
Returns:
count of list;
def RevertModification ( ) [inherited]

Python Docstring:

RevertModification( (FBPlug)arg1 [, (FBPlugModificationFlag)arg2]) -> bool 

C++ Signature:

bool RevertModification(FBPlugModificationFlag pFlag = kFBAllModifiedMask) 

Revert the plug's modification to original status.

Parameters:
pFlag the type of modification to be reverted.
Returns:
true if revert successfully.
def PrintClassDefinitions ( ) [inherited]

Python Docstring:

staticmethod(function) -> method

Convert a function to be a static method.

A static method does not receive an implicit first argument.
To declare a static method, use this idiom:

     class C:
     def f(arg1, arg2, ...): ...
     f = staticmethod(f)

It can be called either on the class (e.g. C.f()) or on an instance
(e.g. C().f()).  The instance is ignored except for its class.

Static methods in Python are similar to those found in Java or C++.
For a more advanced concept, see the classmethod builtin. 

C++ Signature:

void PrintClassDefinitions() 

Print out internal Class (ID) Definition table. For internal debug purpose only.


Member Data Documentation

Read Only Property: Is the transport control playing?

Read Only Property: Is there a recording in progress?

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.

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

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

Read Write Property: Sampling period for the model recording.

Read Write Property: Sampling period for the model plotting.

List: List of components.

Reimplemented in FBScene.

FBPropertyString Name [inherited]

Read Write Property: Unique name of object.

Reimplemented in FBAssetMng.

Read Write Property: Name and namespace for object.

Read Only Property: Manages all of the properties for the component.

FBPropertyBool Selected [inherited]

Read Write Property: Selected property.

Reimplemented in FBModel.