FBCycleCreator Class Reference

See sample: CycleCreator.py. More...

#include <pyfbsdk.h>

Inheritance diagram for FBCycleCreator:

Public Member Functions
	FBCycleCreator ()
	Constructor.
bool	CreateCycle (FBTime pStartTime, FBTime pEndTime, FBCharacter pChar=None, bool pMoveStartToZero=False, bool pAddZeroKey=True, str pNewTakeName="", FBModel pReferencedIK=None, bool pPasteTx=True, bool pPasteTy=False, bool pPasteTz=True, bool pPasteR=True, bool pPasteG=True)
	Create animation cycle for current character if pChar is NULL, else for the character assigned by pChar; during the time scope between pStartTime and pEndTime.
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.

Additional Inherited Members
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

See sample: CycleCreator.py.

Constructor & Destructor Documentation

FBCycleCreator()

FBCycleCreator

(

)

Constructor.

Member Function Documentation

CreateCycle()

bool CreateCycle	(	FBTime	pStartTime,
		FBTime	pEndTime,
		FBCharacter	pChar = None,
		bool	pMoveStartToZero = False,
		bool	pAddZeroKey = True,
		str	pNewTakeName = "",
		FBModel	pReferencedIK = None,
		bool	pPasteTx = True,
		bool	pPasteTy = False,
		bool	pPasteTz = True,
		bool	pPasteR = True,
		bool	pPasteG = True
	)

Create animation cycle for current character if pChar is NULL, else for the character assigned by pChar; during the time scope between pStartTime and pEndTime.

Parameters

pStartTime	Start time of the cycle
pEndTime	End time of the cycle
pChar	Target character, if it is NULL, try to use current character
pMoveStartToZero	Whether move start time to zero time
pAddZeroKey	Whether add zero key
pNewTakeName	The name used to create the new take.
pReferencedIK	The IK that used as referenced object in pose pasting.
pPasteTx	Whether consider Translation X on referenced IK when doing pose pasting
pPasteTy	Whether consider Translation Y on referenced IK when doing pose pasting
pPasteTz	Whether consider Translation Z on referenced IK when doing pose pasting
pPasteR	Whether consider Rotation on referenced IK when doing pose pasting
pPasteG	Whether respect Gravity when doing pose pasting (Translation = Global XZ / Rotation = Global Y). Note: if G is true then Ty will be forced changed to false.

Returns

true if successful.