FBPose Class Reference

Pose class. More...

#include <pyfbsdk.h>

Inheritance diagram for FBPose:

Public Member Functions
	FBPose (str pName)
	Constructor.
int	AddNode (FBModel pObject, FBMatrix pMatrix=None, bool pIsLocalMatrix=False)
	Add a new pose node.
	CreatePoseThumbnail ()
	Create an image thumbnail for the current pose.
int	Find (str pNodeName)
	Look in this pose if the given node is present.
int	GetNodeCount ()
	Returns the number of pose nodes stored.
FBMatrix	GetNodeMatrix (int pIndex)
	Get the pose node matrix.
str	GetNodeName (int pIndex)
	Get the pose node at specified index.
FBModel	GetNodeObject (int pIndex)
	Get the pose node object.
bool	IsNodeLocalMatrix (int pIndex)
	Get the type of the Matrix for a given node.
	RemoveNode (int pIndex)
	Remove the pose node at specified index.
	SetIsNodeLocalMatrix (int pIndex, bool pIsNodeLocalMatrix)
	Set the type of the Matrix for a given node.
	SetNodeMatrix (int pIndex, FBMatrix pMatrix)
	Set the pose node matrix.
	SetNodeObject (int pIndex, FBModel pObject)
	Set the pose node object.
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
FBPoseType	Type
	Read Only Property: Type of the pose (bind pose or rest pose)
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

Pose class.

Constructor & Destructor Documentation

FBPose()

FBPose

(

str

pName

)

Constructor.

Parameters

pName

Name of pose.

Member Function Documentation

AddNode()

int AddNode	(	FBModel	pObject,
		FBMatrix	pMatrix = None,
		bool	pIsLocalMatrix = False
	)

Add a new pose node.

Parameters

pObject	The object for which we are creating the pose information.
pMatrix	The transformation of the object we want to save.
pIsLocalMatrix	Is the matrix a local matrix?

CreatePoseThumbnail()

CreatePoseThumbnail

(

)

Create an image thumbnail for the current pose.

Find()

int Find

(

str

pNodeName

)

Look in this pose if the given node is present.

Parameters

pNodeName

Name of the node we are looking for.

Returns

-1 if the node is not in the list or it's position.

GetNodeCount()

int GetNodeCount

(

)

Returns the number of pose nodes stored.

GetNodeMatrix()

FBMatrix GetNodeMatrix

(

int

pIndex

)

Get the pose node matrix.

Parameters

pIndex

Index of the node.

Returns

a reference to the node's Matrix.

Remarks

if the index is invalid a reference to an identiy matrix is returned.

The reference will become undefined if this object is destroyed.

GetNodeName()

str GetNodeName

(

int

pIndex

)

Get the pose node at specified index.

Parameters

pIndex

Index of the node.

Remarks

if the index is invalid a reference to an empty string is returned.

The reference will become undefined if this object is destroyed.

GetNodeObject()

FBModel GetNodeObject

(

int

pIndex

)

Get the pose node object.

Parameters

pIndex

Index of the node.

Returns

a pointer to the node's Object.

Remarks

if the index is invalid a null pointer is returned.

IsNodeLocalMatrix()

bool IsNodeLocalMatrix

(

int

pIndex

)

Get the type of the Matrix for a given node.

Parameters

pIndex

Index of the node.

Returns

true if the matrix is defined in Local coordinate space.

Remarks

If this object is configured to hold BindPose data, this method will always return false.

RemoveNode()

RemoveNode

(

int

pIndex

)

Remove the pose node at specified index.

Parameters

pIndex

Index of the node to be removed.

SetIsNodeLocalMatrix()

SetIsNodeLocalMatrix	(	int	pIndex,
		bool	pIsNodeLocalMatrix
	)

Set the type of the Matrix for a given node.

Parameters

pIndex	Index of the node.
pIsNodeLocalMatrix	True if the matrix of the node is a local matrix.

SetNodeMatrix()

SetNodeMatrix	(	int	pIndex,
		FBMatrix	pMatrix
	)

Set the pose node matrix.

Parameters

pIndex	Index of the node.
pMatrix	Matrix to set for this pose node.

SetNodeObject()

SetNodeObject	(	int	pIndex,
		FBModel	pObject
	)

Set the pose node object.

Parameters

pIndex	Index of the node.
pObject	Object to associate with this pose node.

Member Data Documentation

Type

FBPoseType Type

Read Only Property: Type of the pose (bind pose or rest pose)