FBReferenceTime Class Reference

Reference time class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBReferenceTime:

Public Member Functions
	FBReferenceTime ()
	Constructor.
int	Add (str pName)
	Add a reference time to list.
str	GetReferenceTimeName (int pID)
	Get the name of a time reference.
FBTime	GetTime (int pID, FBTime pSystem)
	Get a reference time.
	GetUniqueIDList (FBArrayTemplate< int > pIDArray)
	Get list of currently available IDs.
	Remove (int pID)
	Remove a reference time from the list.
	SetTime (int pID, FBTime pReferenceTime, FBTime pSystem)
	Set a reference time.
Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.
bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
int	CurrentTimeReferenceID
	Read Write Property: Current reference time ID
bool	UseRelativeLocalTime
	Read Write Property: True to show the relative local time, false otherwise. This will only be effective when displaying the Local Time, but the state can be changed even if not currently displaying the Local Time.
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

Reference time class.

Interface for the reference time used by MotionBuilder. By default, two reference times are available: the Local time (with ID: -1) and the System time (with ID: 0). For instance, to set the System time as the current reference time, simply set the CurrentTimeReferenceID property to value 0. The reference time are identified using unique ID. A unique ID is given when a reference time is added to the system with Add(). Instead of using a linear array to store the reference time, a map is used to link an ID to a reference time. The available IDs can be queried using GetUniqueIDList().

Constructor & Destructor Documentation

FBReferenceTime()

FBReferenceTime

(

)

Constructor.

Member Function Documentation

Add()

int Add

(

str

pName

)

Add a reference time to list.

Parameters

pName

Name of time to add the list.

Returns

Unique ID of the reference time, use this ID to access the reference time in the future.

GetReferenceTimeName()

str GetReferenceTimeName

(

int

pID

)

Get the name of a time reference.

Parameters

pID	ID of the time reference whose name will be returned.

Returns

Name of reference time with the pID.

GetTime()

FBTime GetTime	(	int	pID,
		FBTime	pSystem
	)

Get a reference time.

Parameters

pID	ID of reference to get.
pSystem	System time.

Returns

Reference time at pIndex.

GetUniqueIDList()

GetUniqueIDList

(

FBArrayTemplate< int >

pIDArray

)

Get list of currently available IDs.

Parameters

pIDArray

Array that will be filled with the requested IDs.

Remove()

Remove

(

int

pID

)

Remove a reference time from the list.

Parameters

pID	ID of reference time to remove.

SetTime()

SetTime	(	int	pID,
		FBTime	pReferenceTime,
		FBTime	pSystem
	)

Set a reference time.

Parameters

pID	ID of reference time set.
pReferenceTime	Time to use as reference time.
pSystem	System time.

Member Data Documentation

CurrentTimeReferenceID

int CurrentTimeReferenceID

Read Write Property: Current reference time ID

UseRelativeLocalTime

bool UseRelativeLocalTime

Read Write Property: True to show the relative local time, false otherwise. This will only be effective when displaying the Local Time, but the state can be changed even if not currently displaying the Local Time.