Public Member Functions | Public Attributes | Protected Member Functions | Friends

FBCluster Class Reference

Search for all occurrences

Detailed Description

Weighting interface for meshes.

Warning:
This class is experimental.

Definition at line 846 of file fbmodel.h.

#include <fbmodel.h>

Inheritance diagram for FBCluster:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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

Public Attributes

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

Protected Member Functions

 FBCluster (FBModel *pModel)
 Constructor.

Friends

class DataFBModel

Constructor & Destructor Documentation

FBCluster ( FBModel pModel) [protected]

Constructor.

protected access, call FBModel::Cluster instead.

Parameters:
pModelParent model in question.

Member Function Documentation

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).
void LinkSetName ( const char *  pName,
int  pLinkNumber 
)

Set the name of a link.

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

Get the name of a link.

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

Remove a link.

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

Get number of links.

Returns:
Number of links.
void 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.
void LinkClearUnused ( double  pThreshold = -1.0)

Remove all unused links.

Parameters:
pThresholdWeight value under which links are considered unused (default=-1).
void 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
void VertexSetTransform ( FBVector3d  pPosition,
FBVector3d  pRotation,
FBVector3d  pScaling 
)

Set transform of a cluster set.

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

Get transform of a cluster set.

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

Add a vertex to a cluster.

Parameters:
pVertexIndexIndex of vertex to add.
pWeightWeight to give to vertex.
void 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
double VertexGetWeight ( int  pIndex)

Get vertex weight.

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

Set vertex weight.

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

Clear all linked vertices.


Friends And Related Function Documentation

friend class DataFBModel [friend]

Definition at line 854 of file fbmodel.h.


Member Data Documentation

FBPropertyClusterMode ClusterMode

Read Write Property: Cluster mode.

Definition at line 963 of file fbmodel.h.

Read Write Property: Cluster accuracy.

Definition at line 964 of file fbmodel.h.


The documentation for this class was generated from the following file:

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