FBMotionFileOptions Class Reference

#include <mobu-python-api.h>

Class Description

Customize motion file loading.

See the C++ reference

Inheritance diagram for FBMotionFileOptions:

Public Member Functions
	__reduce__ ()
	__init__ (object arg1, FBStringList arg2)
	Constructor. More...
int	GetTakeCount (FBMotionFileOptions arg1)
	Return the take count in the file to be loaded. More...
bool	GetTakeSelect (FBMotionFileOptions arg1, object arg2)
	Return true if the take will be loaded. More...
	SetTakeSelect (FBMotionFileOptions arg1, object arg2, object arg3)
	Indicate if the take will be loaded. More...
str	GetTakeName (FBMotionFileOptions arg1, object arg2)
	Get the take name. More...
	SetTakeName (FBMotionFileOptions arg1, object arg2, str arg3)
	Set the take name. More...
FBTime	GetTakeStart (FBMotionFileOptions arg1, object arg2)
	Return the Take Start time. More...
	SetTakeStart (FBMotionFileOptions arg1, object arg2, FBTime arg3)
	Set the Take Start time. More...
FBTime	GetTakeStop (FBMotionFileOptions arg1, object arg2)
	Return the Take Stop time. More...
	SetTakeStop (FBMotionFileOptions arg1, object arg2, FBTime arg3)
	Set the Take Stop time. More...
int	GetTakeSamples (FBMotionFileOptions arg1, object arg2)
	Return the number of samples. More...
	SetTakeSamples (FBMotionFileOptions arg1, object arg2, object arg3)
	Set the number of samples for a particular take. More...
float	GetTakeSamplingRate (FBMotionFileOptions arg1, object arg2)
	Return the actual sampling rate as a double, useful when you have a custom sampling rate. More...
FBTimeMode	GetTakeSamplingRateMode (FBMotionFileOptions arg1, object arg2)
	Return the sampling rate mode. More...
	SetTakeSamplingRate (FBMotionFileOptions arg1, object arg2, FBTimeMode arg3, object arg4)
	Set the sampling rate for a particular take. More...
Public Member Functions inherited from FBComponent
	__reduce__ ()
FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...
str	ClassName (FBComponent arg1)
	Get the class name. More...
	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...
	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...
bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...
	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...
	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...
FBObjectFlag	GetObjectFlags (FBComponent arg1)
	Get all Object Flags (concatenated). More...
bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...
bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...
bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...
bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...
bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...
int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...
bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...
object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...
	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...
	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...
	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...
	HardSelect (FBComponent arg1)
	HardSelect. More...
object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...
	__init__ (...)
	Constructor. More...
Public Member Functions inherited from FBPlug
	__reduce__ ()
bool	BeginChange (FBPlug arg1)
	Begins a change on multiple plugs. More...
str	ClassName (FBPlug arg1)
	internal System vars. More...
bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...
bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...
bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...
bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...
	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...
	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...
bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...
bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...
bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...
bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...
	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...
object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...
int	GetDstCount (FBPlug arg1)
	Get destination connection count. More...
FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...
object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...
int	GetOwnedCount (FBPlug arg1)
	Get the owned plug count. More...
object	GetOwner (FBPlug arg1)
	Get the owner of this plug. More...
object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...
int	GetSrcCount (FBPlug arg1)
	Get source connection count. More...
FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...
bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...
bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...
	MoveSrcAt (...)
bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...
bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...
bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...
	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...
bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...
	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...
bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...
int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...
bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...
	__init__ (...)
method	staticmethod (function)
Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()
	__init__ (...)

Public Attributes
FBPropertyBool	CreateInsteadOfMerge
	Read Write Property: If set to true, the motion will imported/models will be created in the scene, if set to false, the motion will be merged. More...
FBPropertyModelSelection	ModelSelection
	Common settings when merging, unused with the CreateInsteadOfMerge property is set to true. More...
FBPropertyTakeSpanOnLoad	TakeStartEnd
	Read Write Property: Indicates how the start/end value of the take will be modified. More...
FBPropertyBool	IgnoreModelType
	Read Write Property: If set to true, model type will not be considered when finding a matching model in the scene. More...
FBPropertyBool	CreateUnmatchedModels
	Read Write Property: If set to true, nodes will be created to match the hierarchical structure of the imported file. More...
FBPropertyBool	ImportScaling
	Read Write Property: If set to true, scaling values will be imported. More...
FBPropertyBool	ImportDOF
	Read Write Property: If set to true, the DOF value will be imported from the file. More...
FBPropertyBool	CreateReferenceNode
	Settings based on file type. More...
FBPropertyBool	KeepDummyNode
	Read Write Property: If set to true, dummy bones from the file are not removed. More...
FBPropertyBool	SetLimits
	Read Write Property: If set to true, use motion limits. More...
FBPropertyBool	BaseTranslationOnRotationOffset
	Read Write Property: If set to true, the base translation will be imported as Rotation Pivot offset. More...
FBPropertyBool	BaseRotationOnPreRotation
	Read Write Property: If set to true, the base rotation will be imported as Pre Rotation. More...
FBPropertyBool	CreateOpticalSegments
	Read Write Property: If set to true, optical segments will be created. More...
FBPropertyBool	CreateUnusedOpticalSegments
	Read Write Property: If set to true, unused optical segments will be created. More...
FBPropertyBool	SetOccludedToLastValidPosition
	Read Write Property: If set to true, occluded segments will be set to their last valid position. More...
FBPropertyBool	KeepActorPrefix
	Read Write Property: If set to true, the Actor prefix will be kept when naming each optical marker. More...
Public Attributes inherited from FBComponent
object	OwnerNamespace
ORSDK2018::FBPropertyListComponent	Components
	List: List of components. More...
ORSDK2018::FBPropertyString	Name
	Read Write Property: Unique name of object. More...
ORSDK2018::FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...
object	FullName
ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...
ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...
FBPropertyBool	Selected
	Read Write Property: Selected property. More...
Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__	(	object	arg1,
		FBStringList	arg2
	)

Constructor.

Python Docstring:

__init__( (object)arg1, (FBStringList)arg2) -> None 

C++ Signature:

 FBMotionFileOptions(ORSDK2018::FBStringList * pStringList, HIObject pObject = ((void *) 0)) 

Create a FBMotionFileOptions to be used when importing a motion file. Pass file paths to get the appropriate information about those files, modify the options and then call the file import process. Not all options are usable at the same time, some of them are for specific motion type. You can see the valid configuration by looking at the motion file dialog (accessible from File/Motion File Import...).

Parameters

pObject	For internal use only.
pStringList	The client needs to pass a list of files path to load to collect the motion file information.

See the C++ reference

__reduce__

(

)

int GetTakeCount

(

FBMotionFileOptions

arg1

)

Return the take count in the file to be loaded.

Python Docstring:

GetTakeCount( (FBMotionFileOptions)arg1) -> int 

C++ Signature:

int GetTakeCount() 

Warning

You need to use an appropriate constructor with the file path to be able to get the take information.

Returns

Take count

See the C++ reference

str GetTakeName	(	FBMotionFileOptions	arg1,
		object	arg2
	)

Get the take name.

Python Docstring:

GetTakeName( (FBMotionFileOptions)arg1, (object)arg2) -> str 

C++ Signature:

const char * GetTakeName(int pTakeIndex) 

Parameters

pTakeIndex

Index of take to get the name.

Returns

Take name

See the C++ reference

int GetTakeSamples	(	FBMotionFileOptions	arg1,
		object	arg2
	)

Return the number of samples.

Python Docstring:

GetTakeSamples( (FBMotionFileOptions)arg1, (object)arg2) -> int 

C++ Signature:

int GetTakeSamples(int pTakeIndex) 

Parameters

pTakeIndex

Index of take to get the samples count.

Returns

Number of samples

See the C++ reference

float GetTakeSamplingRate	(	FBMotionFileOptions	arg1,
		object	arg2
	)

Return the actual sampling rate as a double, useful when you have a custom sampling rate.

Python Docstring:

GetTakeSamplingRate( (FBMotionFileOptions)arg1, (object)arg2) -> float 

C++ Signature:

double GetTakeSamplingRate(int pTakeIndex) 

Parameters

pTakeIndex

Index of take to get the sampling rate

Returns

Sample rate

See the C++ reference

FBTimeMode GetTakeSamplingRateMode	(	FBMotionFileOptions	arg1,
		object	arg2
	)

Return the sampling rate mode.

Python Docstring:

GetTakeSamplingRateMode( (FBMotionFileOptions)arg1, (object)arg2) -> FBTimeMode 

C++ Signature:

FBTimeMode GetTakeSamplingRateMode(int pTakeIndex) 

Parameters

pTakeIndex

Index of take to get the sampling rate mode

Returns

Sample rate mode

Remarks

Use GetTakeSamplingRate if you have a custom sampling rate to get the actual rate.

See the C++ reference

bool GetTakeSelect	(	FBMotionFileOptions	arg1,
		object	arg2
	)

Return true if the take will be loaded.

Python Docstring:

GetTakeSelect( (FBMotionFileOptions)arg1, (object)arg2) -> bool 

C++ Signature:

bool GetTakeSelect(int pTakeIndex) 

Parameters

pTakeIndex

Index of take.

Returns

True is the take will be loaded

See the C++ reference

FBTime GetTakeStart	(	FBMotionFileOptions	arg1,
		object	arg2
	)

Return the Take Start time.

Python Docstring:

GetTakeStart( (FBMotionFileOptions)arg1, (object)arg2) -> FBTime 

C++ Signature:

ORSDK2018::FBTime GetTakeStart(int pTakeIndex) 

Parameters

pTakeIndex

Index of take to get the start time.

Returns

Start time of the take

See the C++ reference

FBTime GetTakeStop	(	FBMotionFileOptions	arg1,
		object	arg2
	)

Return the Take Stop time.

Python Docstring:

GetTakeStop( (FBMotionFileOptions)arg1, (object)arg2) -> FBTime 

C++ Signature:

ORSDK2018::FBTime GetTakeStop(int pTakeIndex) 

Parameters

pTakeIndex

Index of take to get the stop time.

Returns

Stop time of the take

See the C++ reference

SetTakeName	(	FBMotionFileOptions	arg1,
		object	arg2,
		str	arg3
	)

Set the take name.

Python Docstring:

SetTakeName( (FBMotionFileOptions)arg1, (object)arg2, (str)arg3) -> None 

C++ Signature:

void SetTakeName(int pTakeIndex, const char * pName) 

Parameters

pTakeIndex	Index of take to set.
pName	Take name to set

See the C++ reference

SetTakeSamples	(	FBMotionFileOptions	arg1,
		object	arg2,
		object	arg3
	)

Set the number of samples for a particular take.

Python Docstring:

SetTakeSamples( (FBMotionFileOptions)arg1, (object)arg2, (object)arg3) -> None 

C++ Signature:

void SetTakeSamples(int pTakeIndex, int pSamplesCount) 

Parameters

pTakeIndex	Index of take to set.
pSamplesCount	Number of samples

Remarks

Must be set to a value bigger than 0 and smaller than the number of samples in the file. The stop time of the motion will be changed based on the new samples count.

See the C++ reference

SetTakeSamplingRate	(	FBMotionFileOptions	arg1,
		object	arg2,
		FBTimeMode	arg3,
		object	arg4
	)

Set the sampling rate for a particular take.

Python Docstring:

SetTakeSamplingRate( (FBMotionFileOptions)arg1, (object)arg2, (FBTimeMode)arg3 [, (object)arg4]) -> None 

C++ Signature:

void SetTakeSamplingRate(int pTakeIndex, FBTimeMode pTimeMode, double pCustomSamplingRate = 30.0) 

Parameters

pTakeIndex	Index of take to set.
pTimeMode	Time mode to set.
pCustomSamplingRate	Custom sampling rate if pTimeMode is set to kFBTimeModeCustom, unused otherwise (default is 30.0)

Remarks

Changing the sampling rate will change the stop time of the motion.

See the C++ reference

SetTakeSelect	(	FBMotionFileOptions	arg1,
		object	arg2,
		object	arg3
	)

Indicate if the take will be loaded.

Python Docstring:

SetTakeSelect( (FBMotionFileOptions)arg1, (object)arg2, (object)arg3) -> None 

C++ Signature:

void SetTakeSelect(int pTakeIndex, bool pSelect) 

Parameters

pTakeIndex	Index of take to set.
pSelect	Set to true if the take should be loaded.

See the C++ reference

SetTakeStart	(	FBMotionFileOptions	arg1,
		object	arg2,
		FBTime	arg3
	)

Set the Take Start time.

Python Docstring:

SetTakeStart( (FBMotionFileOptions)arg1, (object)arg2, (FBTime)arg3) -> None 

C++ Signature:

void SetTakeStart(int pTakeIndex, ORSDK2018::FBTime pStartTime) 

Parameters

pTakeIndex	Index of take to set.
pStartTime	Time of the first frame of the take

Remarks

Changing the start time of the take will also change the stop time, since the duration is constant. Please change the samples count to change the length of the motion.

See the C++ reference

SetTakeStop	(	FBMotionFileOptions	arg1,
		object	arg2,
		FBTime	arg3
	)

Set the Take Stop time.

Python Docstring:

SetTakeStop( (FBMotionFileOptions)arg1, (object)arg2, (FBTime)arg3) -> None 

C++ Signature:

void SetTakeStop(int pTakeIndex, ORSDK2018::FBTime pStopTime) 

Parameters

pTakeIndex	Index of take to set.
pStopTime	Time of the last frame of the take

Remarks

Changing the stop time of the take will also change the start time, since the duration is constant. Please change the samples count to change the length of the motion.

See the C++ reference

Member Data Documentation

FBPropertyBool BaseRotationOnPreRotation

Read Write Property: If set to true, the base rotation will be imported as Pre Rotation.

Used for htr, asf/amc files.

See the C++ reference

FBPropertyBool BaseTranslationOnRotationOffset

Read Write Property: If set to true, the base translation will be imported as Rotation Pivot offset.

Used for htr, asf/amc

See the C++ reference

FBPropertyBool CreateInsteadOfMerge

Read Write Property: If set to true, the motion will imported/models will be created in the scene, if set to false, the motion will be merged.

See the C++ reference

FBPropertyBool CreateOpticalSegments

Read Write Property: If set to true, optical segments will be created.

Used for trc, c3d files.

See the C++ reference

FBPropertyBool CreateReferenceNode

Settings based on file type.

Read Write Property: If set to true, a reference node will be created. Used for asf/amc, bvh, htr files.

See the C++ reference

FBPropertyBool CreateUnmatchedModels

Read Write Property: If set to true, nodes will be created to match the hierarchical structure of the imported file.

See the C++ reference

FBPropertyBool CreateUnusedOpticalSegments

Read Write Property: If set to true, unused optical segments will be created.

Used for trc, c3d files.

See the C++ reference

FBPropertyBool IgnoreModelType

Read Write Property: If set to true, model type will not be considered when finding a matching model in the scene.

See the C++ reference

FBPropertyBool ImportDOF

Read Write Property: If set to true, the DOF value will be imported from the file.

See the C++ reference

FBPropertyBool ImportScaling

Read Write Property: If set to true, scaling values will be imported.

See the C++ reference

FBPropertyBool KeepActorPrefix

Read Write Property: If set to true, the Actor prefix will be kept when naming each optical marker.

Used with c3d files.

See the C++ reference

FBPropertyBool KeepDummyNode

Read Write Property: If set to true, dummy bones from the file are not removed.

Used for asf/amc files.

See the C++ reference

FBPropertyModelSelection ModelSelection

Common settings when merging, unused with the CreateInsteadOfMerge property is set to true.

Read Write Property: Indicates if we create the models or how we try to match the models from the motion file to those in the scene.

See the C++ reference

FBPropertyBool SetLimits

Read Write Property: If set to true, use motion limits.

Used for asf/amc files.

See the C++ reference

FBPropertyBool SetOccludedToLastValidPosition

Read Write Property: If set to true, occluded segments will be set to their last valid position.

Used for trc, c3d files.

See the C++ reference

FBPropertyTakeSpanOnLoad TakeStartEnd

Read Write Property: Indicates how the start/end value of the take will be modified.

See the C++ reference