#include <mobu-python-api.h>

Class Description

Weighting interface for meshes.

Warning: This class is experimental.

Inheritance diagram for FBCluster:

Public Member Functions
	__reduce__ ()

	__init__ (object arg1, FBModel arg2)
	Constructor. More...

int	ClusterBegin (FBCluster arg1, object arg2)
	Begin cluster definition. More...

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

	LinkClearUnused (FBCluster arg1, object arg2)
	Remove all unused links. More...

object	LinkGetAssociateModel (FBCluster arg1, object arg2)
	Get model associated with link. More...

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

object	LinkGetModel (FBCluster arg1, object arg2)
	Get model from a link. More...

str	LinkGetName (FBCluster arg1, object arg2)
	Get the name of a link. More...

int	LinkGetVertexIndex (FBCluster arg1, object arg2)
	Get current vertex at link. More...

	LinkRemove (FBCluster arg1, object arg2)
	Remove a link. More...

	LinkSetCurrentVertex (FBCluster arg1, object arg2, object arg3)
	Link at current vertex. More...

	LinkSetModel (FBCluster arg1, FBModel arg2)
	Set model to a link. More...

	LinkSetName (FBCluster arg1, str arg2, object arg3)
	Set the name of a link. More...

	VertexAdd (FBCluster arg1, object arg2, object arg3)
	Add a vertex to a cluster. More...

	VertexClear (FBCluster arg1)
	Clear all linked vertices. More...

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

int	VertexGetNumber (FBCluster arg1, object arg2)
	Get vertex number. More...

	VertexGetTransform (FBCluster arg1, FBVector3d arg2, FBVector3d arg3, FBVector3d arg4)
	Get transform of a cluster set. More...

float	VertexGetWeight (FBCluster arg1, object arg2)
	Get vertex weight. More...

	VertexRemove (FBCluster arg1, object arg2)
	Remove a vertex from a cluster. More...

	VertexSetTransform (FBCluster arg1, FBVector3d arg2, FBVector3d arg3, FBVector3d arg4)
	Set transform of a cluster set. More...

	VertexSetWeight (FBCluster arg1, object arg2, object arg3)
	Set vertex weight. More...

Public Member Functions inherited from FBComponent
	__reduce__ ()

FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...

str	ClassName (FBComponent arg1)
	Get the class name. More...

	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...

	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...

bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...

	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...

	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...

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

bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...

bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...

bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...

bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...

int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...

object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...

	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...

	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...

	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...

	HardSelect (FBComponent arg1)
	HardSelect. More...

object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBPlug
	__reduce__ ()

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

str	ClassName (FBPlug arg1)
	internal System vars. More...

bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...

bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...

bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...

bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...

	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...

	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...

bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...

bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...

bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...

	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...

object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...

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

FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...

object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...

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

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

object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...

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

FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...

bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...

bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...

	MoveSrcAt (...)

bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...

bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...

	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...

	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...

	__init__ (...)

method	staticmethod (function)

Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()

	__init__ (...)

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

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

Public Attributes inherited from FBComponent
object	OwnerNamespace

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

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

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

object	FullName

ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...

ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

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

Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__	(	object	arg1,
		FBModel	arg2
	)

Constructor.

Python Docstring:

__init__( (object)arg1, (FBModel)arg2) -> None

C++ Signature:

 FBCluster(ORSDK2018::FBModel * pModel)

protected access, call FBModel::Cluster instead.

Parameters

pModel Parent model in question.

See the C++ reference

__reduce__ ( )

int ClusterBegin	(	FBCluster	arg1,
		object	arg2
	)

Begin cluster definition.

Python Docstring:

ClusterBegin( (FBCluster)arg1 [, (object)arg2]) -> int

C++ Signature:

int ClusterBegin(int pIndex = -1)

Parameters

pIndex Link index.

Returns: Index of last item(default=-1).

See the C++ reference

int ClusterEnd ( FBCluster arg1 )

End cluster definition.

Python Docstring:

ClusterEnd( (FBCluster)arg1) -> int

C++ Signature:

int ClusterEnd()

Returns: 0, (Not implemented).

See the C++ reference

LinkClearUnused	(	FBCluster	arg1,
		object	arg2
	)

Remove all unused links.

Python Docstring:

LinkClearUnused( (FBCluster)arg1 [, (object)arg2]) -> None

C++ Signature:

void LinkClearUnused(double pThreshold = -1.0)

Parameters

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

See the C++ reference

object LinkGetAssociateModel	(	FBCluster	arg1,
		object	arg2
	)

Get model associated with link.

Python Docstring:

LinkGetAssociateModel( (FBCluster)arg1, (object)arg2) -> object

C++ Signature:

ORSDK2018::FBModel * LinkGetAssociateModel(int pLinkNumber)

Parameters

pLinkNumber Number value of link to get associated model from.

Returns: Model associated to link number pLinkNumber.

See the C++ reference

int LinkGetCount ( FBCluster arg1 )

Get number of links.

Python Docstring:

LinkGetCount( (FBCluster)arg1) -> int

C++ Signature:

int LinkGetCount()

Returns: Number of links.

See the C++ reference

object LinkGetModel	(	FBCluster	arg1,
		object	arg2
	)

Get model from a link.

Python Docstring:

LinkGetModel( (FBCluster)arg1, (object)arg2) -> object

C++ Signature:

ORSDK2018::FBModel * LinkGetModel(int pLinkNumber)

Parameters

pLinkNumber Number value of link to get model from.

Returns: Model at link number pLinkNumber.

See the C++ reference

str LinkGetName	(	FBCluster	arg1,
		object	arg2
	)

Get the name of a link.

Python Docstring:

LinkGetName( (FBCluster)arg1, (object)arg2) -> str

C++ Signature:

const char * LinkGetName(int pLinkNumber)

Parameters

pLinkNumber Number value of link to get name from.

Returns: Name of link number pLinkNumber.

See the C++ reference

int LinkGetVertexIndex	(	FBCluster	arg1,
		object	arg2
	)

Get current vertex at link.

Python Docstring:

LinkGetVertexIndex( (FBCluster)arg1, (object)arg2) -> int

C++ Signature:

int LinkGetVertexIndex(int pIndex)

Parameters

pIndex Index of link to get vertex from.

Returns: Index value of the current vertex associated to link at index number pIndex

See the C++ reference

LinkRemove	(	FBCluster	arg1,
		object	arg2
	)

Remove a link.

Python Docstring:

LinkRemove( (FBCluster)arg1, (object)arg2) -> None

C++ Signature:

void LinkRemove(int pLinkNumber)

Parameters

pLinkNumber Number value of link to rename.

See the C++ reference

LinkSetCurrentVertex	(	FBCluster	arg1,
		object	arg2,
		object	arg3
	)

Link at current vertex.

Python Docstring:

LinkSetCurrentVertex( (FBCluster)arg1, (object)arg2, (object)arg3) -> None

C++ Signature:

void LinkSetCurrentVertex(int pLinkIndex, int pPointIndex)

Parameters

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

See the C++ reference

LinkSetModel	(	FBCluster	arg1,
		FBModel	arg2
	)

Set model to a link.

Python Docstring:

LinkSetModel( (FBCluster)arg1, (FBModel)arg2) -> None

C++ Signature:

void LinkSetModel(ORSDK2018::FBModel * pModel)

Parameters

pModel Model to set.

See the C++ reference

LinkSetName	(	FBCluster	arg1,
		str	arg2,
		object	arg3
	)

Set the name of a link.

Python Docstring:

LinkSetName( (FBCluster)arg1, (str)arg2, (object)arg3) -> None

C++ Signature:

void LinkSetName(const char * pName, int pLinkNumber)

Parameters

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

See the C++ reference

VertexAdd	(	FBCluster	arg1,
		object	arg2,
		object	arg3
	)

Add a vertex to a cluster.

Python Docstring:

VertexAdd( (FBCluster)arg1, (object)arg2, (object)arg3) -> None

C++ Signature:

void VertexAdd(int pVertexIndex, double pWeight)

Parameters

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

See the C++ reference

VertexClear ( FBCluster arg1 )

Clear all linked vertices.

Python Docstring:

VertexClear( (FBCluster)arg1) -> None

C++ Signature:

void VertexClear()

See the C++ reference

int VertexGetCount ( FBCluster arg1 )

Get the number of vertices.

Python Docstring:

VertexGetCount( (FBCluster)arg1) -> int

C++ Signature:

int VertexGetCount()

Returns: Number of vertices in a cluster.

See the C++ reference

int VertexGetNumber	(	FBCluster	arg1,
		object	arg2
	)

Get vertex number.

Python Docstring:

VertexGetNumber( (FBCluster)arg1, (object)arg2) -> int

C++ Signature:

int VertexGetNumber(int pIndex)

Parameters

pIndex Index of link to get vertex from.

Returns: Number value of vertex at link number pIndex

See the C++ reference

VertexGetTransform	(	FBCluster	arg1,
		FBVector3d	arg2,
		FBVector3d	arg3,
		FBVector3d	arg4
	)

Get transform of a cluster set.

Python Docstring:

VertexGetTransform( (FBCluster)arg1, (FBVector3d)arg2, (FBVector3d)arg3, (FBVector3d)arg4) -> None

C++ Signature:

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

Return values

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

See the C++ reference

float VertexGetWeight	(	FBCluster	arg1,
		object	arg2
	)

Get vertex weight.

Python Docstring:

VertexGetWeight( (FBCluster)arg1, (object)arg2) -> float

C++ Signature:

double VertexGetWeight(int pIndex)

Parameters

pIndex Index of link to get vertex from.

Returns: Weight of vertex found at link number pIndex.

See the C++ reference

VertexRemove	(	FBCluster	arg1,
		object	arg2
	)

Remove a vertex from a cluster.

Python Docstring:

VertexRemove( (FBCluster)arg1, (object)arg2) -> None

C++ Signature:

void VertexRemove(int pVertexIndex)

Parameters

pVertexIndex Index of vertex to remove.

See the C++ reference

VertexSetTransform	(	FBCluster	arg1,
		FBVector3d	arg2,
		FBVector3d	arg3,
		FBVector3d	arg4
	)

Set transform of a cluster set.

Python Docstring:

VertexSetTransform( (FBCluster)arg1, (FBVector3d)arg2, (FBVector3d)arg3, (FBVector3d)arg4) -> None

C++ Signature:

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

Parameters

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

See the C++ reference

VertexSetWeight	(	FBCluster	arg1,
		object	arg2,
		object	arg3
	)

Set vertex weight.

Python Docstring:

VertexSetWeight( (FBCluster)arg1, (object)arg2, (object)arg3) -> None

C++ Signature:

void VertexSetWeight(double pWeight, int pIndex)

Parameters

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

See the C++ reference

Member Data Documentation

FBPropertyDouble ClusterAccuracy

Read Write Property: Cluster accuracy.

See the C++ reference

FBPropertyClusterMode ClusterMode

Read Write Property: Cluster mode.

See the C++ reference

FBCluster Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation