FBCluster Class Reference

FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster FBCluster

Inheritance diagram for FBCluster:

[legend]

List of all members.

---

Detailed Description

Cluster.

Weighting interface for meshes. This class is experimental.

Public Member Functions
int	ClusterBegin (int pIndex=-1)
	Begin cluster definition.
int	ClusterEnd (bool pQueryOnly=False)
	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 Attributes
float	ClusterAccuracy
	Read Write Property: Cluster accuracy.
FBClusterMode	ClusterMode
	Read Write Property: Cluster mode.

---

Member Function Documentation

int ClusterBegin

(

int

pIndex = -1

)

Begin cluster definition.

Parameters:

pIndex

Link index.

Returns:

Index of last item(default=-1).

int ClusterEnd

(

bool

pQueryOnly = False

)

End cluster definition.

Parameters:

pQueryOnly

Were the operations on the cluster non-destructive?

Returns:

0, (Not implemented).

LinkClearUnused

(

float

pThreshold = -1.0

)

Remove all unused links.

Parameters:

pThreshold

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

FBModel LinkGetAssociateModel

(

int

pLinkNumber

)

Get model associated with link.

Parameters:

pLinkNumber

Nubmer value of link to get associated model from.

Returns:

Model associated to link number pLinkNumber.

int LinkGetCount

(

)

Get number of links.

Returns:

Number of links.

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.

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.

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

(

int

pLinkNumber

)

Remove a link.

Parameters:

pLinkNumber

Number value of link to rename.

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

(

FBModel

pModel

)

Set model to a link.

Parameters:

pModel

Model to set.

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	(	int	pVertexIndex,
		float	pWeight
	)

Add a vertex to a cluster.

Parameters:

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

VertexClear

(

)

Clear all linked vertices.

int VertexGetCount

(

)

Get the number of vertices.

Returns:

Number of vertices in a cluster.

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	(	FBVector3d	pPosition,
		FBVector3d	pRotation,
		FBVector3d	pScaling
	)

Get transform of a cluster set.

Parameters:

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

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

(

int

pVertexIndex

)

Remove a vertex from a cluster.

Parameters:

pVertexIndex

Index of vertex to remove.

VertexSetTransform	(	FBVector3d	pPosition,
		FBVector3d	pRotation,
		FBVector3d	pScaling
	)

Set transform of a cluster set.

Parameters:

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

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

float ClusterAccuracy

Read Write Property: Cluster accuracy.

FBClusterMode ClusterMode

Read Write Property: Cluster mode.

---