FBCluster Class Reference

#include <fbmodel.h>

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.

Warning:

This class is experimental.

Definition at line 925 of file fbmodel.h.

Public Member Functions
int	ClusterBegin (int pIndex=-1)
	Begin cluster definition.
int	ClusterEnd (bool pQueryOnly=false)
	End cluster definition.
void	LinkSetName (char *pName, int pLinkNumber)
	Set the name of a link.
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 (HFBModel pModel)
	Set model to a link.
HFBModel	LinkGetModel (int pLinkNumber)
	Get model from a link.
HFBModel	LinkGetAssociateModel (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 (HFBModel pModel)
	Constructor.

---

Constructor & Destructor Documentation

FBCluster

(

HFBModel

pModel

)

[protected]

Constructor.

protected access, call FBModel::Cluster instead.

Parameters:

pModel

Parent model in question.

---

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).

void LinkSetName	(	char *	pName,
		int	pLinkNumber
	)

Set the name of a link.

Parameters:

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

char* 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.

void LinkRemove

(

int

pLinkNumber

)

Remove a link.

Parameters:

pLinkNumber

Number value of link to rename.

int LinkGetCount

(

)

Get number of links.

Returns:

Number of links.

void LinkSetModel

(

HFBModel

pModel

)

Set model to a link.

Parameters:

pModel

Model to set.

HFBModel LinkGetModel

(

int

pLinkNumber

)

Get model from a link.

Parameters:

pLinkNumber

Number value of link to get model from.

Returns:

Model at link number pLinkNumber.

HFBModel 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.

void LinkClearUnused

(

double

pThreshold = -1.0

)

Remove all unused links.

Parameters:

pThreshold

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

void LinkSetCurrentVertex	(	int	pLinkIndex,
		int	pPointIndex
	)

Link at current vertex.

Parameters:

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

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

void VertexSetTransform	(	FBVector3d	pPosition,
		FBVector3d	pRotation,
		FBVector3d	pScaling
	)

Set transform of a cluster set.

Parameters:

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

void VertexGetTransform	(	FBVector3d &	pPosition,
		FBVector3d &	pRotation,
		FBVector3d &	pScaling
	)

Get transform of a cluster set.

Return values:

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

void VertexAdd	(	int	pVertexIndex,
		double	pWeight
	)

Add a vertex to a cluster.

Parameters:

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

void VertexRemove

(

int

pVertexIndex

)

Remove a vertex from a cluster.

Parameters:

pVertexIndex

Index 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:

pIndex

Index of link to get vertex from.

Returns:

Number value of vertex at link number pIndex

double VertexGetWeight

(

int

pIndex

)

Get vertex weight.

Parameters:

pIndex

Index 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:

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

void VertexClear

(

)

Clear all linked vertices.

---

Member Data Documentation

FBPropertyClusterMode ClusterMode

Read Write Property: Cluster mode.

Definition at line 1043 of file fbmodel.h.

FBPropertyDouble ClusterAccuracy

Read Write Property: Cluster accuracy.

Definition at line 1044 of file fbmodel.h.

---

Please send us your comments about this page.