Weighting interface for meshes. More...

#include <fbmodel.h>

Inheritance diagram for FBCluster:

[legend]

Public Member Functions
int	ClusterBegin (int pIndex=-1)
	Begin cluster definition. More...

int	ClusterEnd ()
	End cluster definition. More...

void	LinkSetName (const char *pName, int pLinkNumber)
	Set the name of a link. More...

const char *	LinkGetName (int pLinkNumber)
	Get the name of a link. More...

void	LinkRemove (int pLinkNumber)
	Remove a link. More...

int	LinkGetCount ()
	Get number of links. More...

void	LinkSetModel (FBModel *pModel)
	Set model to a link. More...

FBModel *	LinkGetModel (int pLinkNumber)
	Get model from a link. More...

FBModel *	LinkGetAssociateModel (int pLinkNumber)
	Get model associated with link. More...

void	LinkClearUnused (double pThreshold=-1.0)
	Remove all unused links. More...

void	LinkSetCurrentVertex (int pLinkIndex, int pPointIndex)
	Link at current vertex. More...

int	LinkGetVertexIndex (int pIndex)
	Get current vertex at link. More...

void	VertexSetTransform (FBVector3d pPosition, FBVector3d pRotation, FBVector3d pScaling)
	Set transform of a cluster set. More...

void	VertexGetTransform (FBVector3d &pPosition, FBVector3d &pRotation, FBVector3d &pScaling)
	Get transform of a cluster set. More...

void	VertexAdd (int pVertexIndex, double pWeight)
	Add a vertex to a cluster. More...

void	VertexRemove (int pVertexIndex)
	Remove a vertex from a cluster. More...

int	VertexGetCount ()
	Get the number of vertices. More...

int	VertexGetNumber (int pIndex)
	Get vertex number. More...

double	VertexGetWeight (int pIndex)
	Get vertex weight. More...

void	VertexSetWeight (double pWeight, int pIndex)
	Set vertex weight. More...

void	VertexClear ()
	Clear all linked vertices. More...

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor. More...

virtual	~FBComponent ()
	Destructor. More...

virtual bool	FBCreate ()
	Open Reality Creation function. More...

virtual void	FBDestroy ()
	Open Reality destruction function. More...

virtual void	FBDelete () override
	Open Reality deletion function. More...

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer. More...

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager. More...

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager. More...

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading. More...

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property. More...

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated). More...

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags. More...

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled. More...

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags. More...

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags. More...

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status. More...

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled. More...

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace. More...

virtual const char *	ClassName () override
	Get the class name. More...

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not. More...

const char *	GetFullName (void)
	Get the full name. More...

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object. More...

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object. More...

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object. More...

void	HardSelect ()
	HardSelect. More...

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId. More...

virtual int	GetTypeId () override
	GetTypeId( int pTypeId ) More...

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyClusterMode	ClusterMode
	Read Write Property: Cluster mode. More...

FBPropertyDouble	ClusterAccuracy
	Read Write Property: Cluster accuracy. More...

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyListComponent	Components
	List: List of components. More...

FBPropertyListComponent	Parents
	List: Parents. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

FBPropertyString	Name
	Read Write Property: Unique name of object. More...

FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component. More...

Protected Member Functions
	FBCluster (FBModel *pModel)
	Constructor. More...

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component. More...

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection. More...

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection. More...

void	DisconnectAllSrc ()
	Remove all source connections. More...

void	DisconnectAllDst ()
	Remove all destination connections. More...

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index. More...

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index. More...

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B. More...

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex. More...

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc. More...

int	GetSrcCount ()
	Get source connection count. More...

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index. More...

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index. More...

int	GetDstCount ()
	Get destination connection count. More...

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index. More...

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index. More...

bool	BeginChange ()
	Begins a change on multiple plugs. More...

void	EndChange ()
	Ends a change on multiple plugs. More...

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed. More...

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status. More...

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag. More...

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed. More...

FBPlug *	GetOwner ()
	Get the owner of this plug. More...

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index. More...

int	GetOwnedCount ()
	Get the owned plug count. More...

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object. More...

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id. More...

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component. More...

HIObject	mObject
	Handle on the Plug. More...

bool	mSDKComponent
	bool Plug is an SDK component. More...

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object. More...

static int	TypeInfo
	TypeInfo. More...

static int	mGlobalTypeInfo
	Represente the Type Index. More...

Detailed Description

Weighting interface for meshes.

Warning: This class is experimental.

Definition at line 1041 of file fbmodel.h.

Constructor & Destructor Documentation

◆ FBCluster()

FBCluster ( FBModel * pModel )

protected

Constructor.

protected access, call FBModel::Cluster instead.

Parameters

pModel Parent model in question.

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

void LinkClearUnused ( double 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()

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

◆ 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()

void LinkRemove ( int pLinkNumber )

Remove a link.

Parameters

pLinkNumber Number value of link to rename.

◆ LinkSetCurrentVertex()

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.

◆ LinkSetModel()

void LinkSetModel ( FBModel * pModel )

Set model to a link.

Parameters

pModel Model to set.

◆ LinkSetName()

void LinkSetName	(	const char *	pName,
		int	pLinkNumber
	)

Set the name of a link.

Parameters

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

◆ VertexAdd()

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.

◆ VertexClear()

void 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()

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.

◆ VertexGetWeight()

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.

◆ VertexRemove()

void VertexRemove ( int pVertexIndex )

Remove a vertex from a cluster.

Parameters

pVertexIndex Index of vertex to remove.

◆ VertexSetTransform()

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

Set transform of a cluster set.

Parameters

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

◆ VertexSetWeight()

void VertexSetWeight	(	double	pWeight,
		int	pIndex
	)

Set vertex weight.

Parameters

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

Member Data Documentation

◆ ClusterAccuracy

FBPropertyDouble ClusterAccuracy

Read Write Property: Cluster accuracy.

Definition at line 1159 of file fbmodel.h.

◆ ClusterMode

FBPropertyClusterMode ClusterMode

Read Write Property: Cluster mode.

Definition at line 1158 of file fbmodel.h.

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

fbmodel.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBCluster()

Member Function Documentation

◆ ClusterBegin()

◆ ClusterEnd()

◆ LinkClearUnused()

◆ LinkGetAssociateModel()

◆ LinkGetCount()

◆ LinkGetModel()

◆ LinkGetName()

◆ LinkGetVertexIndex()

◆ LinkRemove()

◆ LinkSetCurrentVertex()

◆ LinkSetModel()

◆ LinkSetName()

◆ VertexAdd()

◆ VertexClear()

◆ VertexGetCount()

◆ VertexGetNumber()

◆ VertexGetTransform()

◆ VertexGetWeight()

◆ VertexRemove()

◆ VertexSetTransform()

◆ VertexSetWeight()

Member Data Documentation

◆ ClusterAccuracy

◆ ClusterMode