FBCluster Class Reference

Weighting interface for meshes. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBCluster:

Public Member Functions
int	ClusterBegin (int pIndex=-1)
	Begin cluster definition.
int	ClusterEnd ()
	End cluster definition.
	LinkClearUnused (float pThreshold=-1.0)
	Remove all unused links.
FBModel	LinkGetAssociateModel (int pLinkNumber)
	Get model associated with link.
int	LinkGetCount ()
	Get number of links.
FBModel	LinkGetModel (int pLinkNumber)
	Get model from a link.
str	LinkGetName (int pLinkNumber)
	Get the name of a link.
int	LinkGetVertexIndex (int pIndex)
	Get current vertex at link.
	LinkRemove (int pLinkNumber)
	Remove a link.
	LinkSetCurrentVertex (int pLinkIndex, int pPointIndex)
	Link at current vertex.
	LinkSetModel (FBModel pModel)
	Set model to a link.
	LinkSetName (str pName, int pLinkNumber)
	Set the name of a link.
	VertexAdd (int pVertexIndex, float pWeight)
	Add a vertex to a cluster.
	VertexClear ()
	Clear all linked vertices.
int	VertexGetCount ()
	Get the number of vertices.
int	VertexGetNumber (int pIndex)
	Get vertex number.
	VertexGetTransform (FBVector3d pPosition, FBVector3d pRotation, FBVector3d pScaling)
	Get transform of a cluster set.
float	VertexGetWeight (int pIndex)
	Get vertex weight.
	VertexRemove (int pVertexIndex)
	Remove a vertex from a cluster.
	VertexSetTransform (FBVector3d pPosition, FBVector3d pRotation, FBVector3d pScaling)
	Set transform of a cluster set.
	VertexSetWeight (float pWeight, int pIndex)
	Set vertex weight.
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
float	ClusterAccuracy
	Read Write Property: Cluster accuracy.
FBClusterMode	ClusterMode
	Read Write Property: Cluster mode.
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

Weighting interface for meshes.

This class is experimental.

See sample: FBClusterTransactions.py.

Member Function Documentation

ClusterBegin()

int ClusterBegin

(

int

pIndex = -1

)

Begin cluster definition.

Parameters

pIndex

Link index.

Returns

Index of last item(default=-1).

ClusterEnd()

int ClusterEnd

(

)

End cluster definition.

Returns

0, (Not implemented).

LinkClearUnused()

LinkClearUnused

(

float

pThreshold = -1.0

)

Remove all unused links.

Parameters

pThreshold

Weight value under which links are considered unused (default=-1).

LinkGetAssociateModel()

FBModel LinkGetAssociateModel

(

int

pLinkNumber

)

Get model associated with link.

Parameters

pLinkNumber

Number value of link to get associated model from.

Returns

Model associated to link number pLinkNumber.

LinkGetCount()

int LinkGetCount

(

)

Get number of links.

Returns

Number of links.

LinkGetModel()

FBModel LinkGetModel

(

int

pLinkNumber

)

Get model from a link.

Parameters

pLinkNumber

Number value of link to get model from.

Returns

Model at link number pLinkNumber.

LinkGetName()

str LinkGetName

(

int

pLinkNumber

)

Get the name of a link.

Parameters

pLinkNumber

Number value of link to get name from.

Returns

Name of link number pLinkNumber.

LinkGetVertexIndex()

int LinkGetVertexIndex

(

int

pIndex

)

Get current vertex at link.

Parameters

pIndex

Index of link to get vertex from.

Returns

Index value of the current vertex associated to link at index number pIndex

LinkRemove()

LinkRemove

(

int

pLinkNumber

)

Remove a link.

Parameters

pLinkNumber

Number value of link to rename.

LinkSetCurrentVertex()

LinkSetCurrentVertex	(	int	pLinkIndex,
		int	pPointIndex
	)

Link at current vertex.

Parameters

pLinkIndex	Index of link to add vertex to.
pPointIndex	Index of vertex to add.

LinkSetModel()

LinkSetModel

(

FBModel

pModel

)

Set model to a link.

Parameters

pModel

Model to set.

LinkSetName()

LinkSetName	(	str	pName,
		int	pLinkNumber
	)

Set the name of a link.

Parameters

pName	Name of the link.
pLinkNumber	Number value of link to name.

VertexAdd()

VertexAdd	(	int	pVertexIndex,
		float	pWeight
	)

Add a vertex to a cluster.

Parameters

pVertexIndex	Index of vertex to add.
pWeight	Weight to give to vertex.

VertexClear()

VertexClear

(

)

Clear all linked vertices.

VertexGetCount()

int VertexGetCount

(

)

Get the number of vertices.

Returns

Number of vertices in a cluster.

VertexGetNumber()

int VertexGetNumber

(

int

pIndex

)

Get vertex number.

Parameters

pIndex

Index of link to get vertex from.

Returns

Number value of vertex at link number pIndex

VertexGetTransform()

VertexGetTransform	(	FBVector3d	pPosition,
		FBVector3d	pRotation,
		FBVector3d	pScaling
	)

Get transform of a cluster set.

Parameters

pPosition	Position transform.
pRotation	Rotation transform.
pScaling	Scaling transform.

VertexGetWeight()

float VertexGetWeight

(

int

pIndex

)

Get vertex weight.

Parameters

pIndex

Index of link to get vertex from.

Returns

Weight of vertex found at link number pIndex.

VertexRemove()

VertexRemove

(

int

pVertexIndex

)

Remove a vertex from a cluster.

Parameters

pVertexIndex

Index of vertex to remove.

VertexSetTransform()

VertexSetTransform	(	FBVector3d	pPosition,
		FBVector3d	pRotation,
		FBVector3d	pScaling
	)

Set transform of a cluster set.

Parameters

pPosition	Position transform.
pRotation	Rotation transform.
pScaling	Scaling transform.

VertexSetWeight()

VertexSetWeight	(	float	pWeight,
		int	pIndex
	)

Set vertex weight.

Parameters

pWeight	Weight to give to vertex.
pIndex	Index of link to get vertex from.

Member Data Documentation

ClusterAccuracy

float ClusterAccuracy

Read Write Property: Cluster accuracy.

ClusterMode

FBClusterMode ClusterMode

Read Write Property: Cluster mode.