FBCluster Class Reference


Detailed Description

Weighting interface for meshes.

Warning:
This class is experimental.
Examples
BasicOperations/FBClusterTransactions.py
Inheritance diagram for FBCluster:

List of all members.

Public Member Functions

int ClusterBegin (int pIndex=-1)
 Begin cluster definition.
int ClusterEnd ()
 End cluster definition.
 LinkSetName (str pName, int pLinkNumber)
 Set the name of a link.
str LinkGetName (int pLinkNumber)
 Get the name of a link.
 LinkRemove (int pLinkNumber)
 Remove a link.
int LinkGetCount ()
 Get number of links.
 LinkSetModel (FBModel pModel)
 Set model to a link.
FBModel LinkGetModel (int pLinkNumber)
 Get model from a link.
FBModel LinkGetAssociateModel (int pLinkNumber)
 Get model associated with link.
 LinkClearUnused (float pThreshold=-1.0)
 Remove all unused links.
 LinkSetCurrentVertex (int pLinkIndex, int pPointIndex)
 Link at current vertex.
int LinkGetVertexIndex (int pIndex)
 Get current vertex at link.
 VertexSetTransform (FBVector3 pPosition, FBVector3 pRotation, FBVector3 pScaling)
 Set transform of a cluster set.
 VertexGetTransform (FBVector3 pPosition, FBVector3 pRotation, FBVector3 pScaling)
 Get transform of a cluster set.
 VertexAdd (int pVertexIndex, float pWeight)
 Add a vertex to a cluster.
 VertexRemove (int pVertexIndex)
 Remove a vertex from a cluster.
int VertexGetCount ()
 Get the number of vertices.
int VertexGetNumber (int pIndex)
 Get vertex number.
float VertexGetWeight (int pIndex)
 Get vertex weight.
 VertexSetWeight (float pWeight, int pIndex)
 Set vertex weight.
 VertexClear ()
 Clear all linked vertices.

Public Attributes

FBPropertyClusterMode ClusterMode
 Read Write Property: Cluster mode.
FBPropertyBase ClusterAccuracy
 Read Write Property: Cluster accuracy.

Protected Member Functions

 __init__ (FBModel pModel)
 Constructor.

Member Function Documentation

__init__ ( FBModel  pModel) [protected]

Constructor.

protected access, call FBModel.Cluster instead.

Parameters:
pModelParent model in question.
Examples
BasicOperations/FBClusterTransactions.py
int ClusterBegin ( int  pIndex = -1)

Begin cluster definition.

Parameters:
pIndexLink index.
Returns:
Index of last item(default=-1).
int ClusterEnd ( )

End cluster definition.

Returns:
0, (Not implemented).
LinkSetName ( str  pName,
int  pLinkNumber 
)

Set the name of a link.

Parameters:
pLinkNumberNumber value of link to name.
pNameName of the link.
str LinkGetName ( int  pLinkNumber)

Get the name of a link.

Parameters:
pLinkNumberNumber value of link to get name from.
Returns:
Name of link number pLinkNumber.
LinkRemove ( int  pLinkNumber)

Remove a link.

Parameters:
pLinkNumberNumber value of link to rename.
int LinkGetCount ( )

Get number of links.

Returns:
Number of links.
LinkSetModel ( FBModel  pModel)

Set model to a link.

Parameters:
pModelModel to set.
FBModel LinkGetModel ( int  pLinkNumber)

Get model from a link.

Parameters:
pLinkNumberNumber value of link to get model from.
Returns:
Model at link number pLinkNumber.
FBModel LinkGetAssociateModel ( int  pLinkNumber)

Get model associated with link.

Parameters:
pLinkNumberNumber value of link to get associated model from.
Returns:
Model associated to link number pLinkNumber.
LinkClearUnused ( float  pThreshold = -1.0)

Remove all unused links.

Parameters:
pThresholdWeight value under which links are considered unused (default=-1).
LinkSetCurrentVertex ( int  pLinkIndex,
int  pPointIndex 
)

Link at current vertex.

Parameters:
pLinkIndexIndex of link to add vertex to.
pPointIndexIndex of vertex to add.
int LinkGetVertexIndex ( int  pIndex)

Get current vertex at link.

Parameters:
pIndexIndex of link to get vertex from.
Returns:
Index value of the current vertex associated to link at index number pIndex
VertexSetTransform ( FBVector3  pPosition,
FBVector3  pRotation,
FBVector3  pScaling 
)

Set transform of a cluster set.

Parameters:
pPositionPosition transform.
pRotationRotation transform.
pScalingScaling transform.
VertexGetTransform ( FBVector3  pPosition,
FBVector3  pRotation,
FBVector3  pScaling 
)

Get transform of a cluster set.

Return values:
pPositionPosition transform.
pRotationRotation transform.
pScalingScaling transform.
VertexAdd ( int  pVertexIndex,
float  pWeight 
)

Add a vertex to a cluster.

Parameters:
pVertexIndexIndex of vertex to add.
pWeightWeight to give to vertex.
VertexRemove ( int  pVertexIndex)

Remove a vertex from a cluster.

Parameters:
pVertexIndexIndex of vertex to remove.
int VertexGetCount ( )

Get the number of vertices.

Returns:
Number of vertices in a cluster.
int VertexGetNumber ( int  pIndex)

Get vertex number.

Parameters:
pIndexIndex of link to get vertex from.
Returns:
Number value of vertex at link number pIndex
float VertexGetWeight ( int  pIndex)

Get vertex weight.

Parameters:
pIndexIndex of link to get vertex from.
Returns:
Weight of vertex found at link number pIndex.
VertexSetWeight ( float  pWeight,
int  pIndex 
)

Set vertex weight.

Parameters:
pIndexIndex of link to get vertex from.
pWeightWeight to give to vertex.
VertexClear ( )

Clear all linked vertices.


Member Data Documentation

FBPropertyClusterMode ClusterMode

Read Write Property: Cluster mode.

FBPropertyBase ClusterAccuracy

Read Write Property: Cluster accuracy.


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