FBMesh Class Reference

#include <mobu-python-api.h>

Class Description

Mesh class.

See the C++ reference

Inheritance diagram for FBMesh:

Public Member Functions
	__reduce__ ()
	__init__ (object arg1, str arg2)
	Constructor. More...
int	PolygonBegin (FBMesh arg1, object arg2)
	Begin Polygon definition. More...
int	PolygonCount (FBMesh arg1)
	Get number of polygons in mesh. More...
int	PolygonEnd (FBMesh arg1)
	End Polygon definition. More...
int	PolygonMaterialIdGet (FBMesh arg1, object arg2)
	Get a Material ID for the given Polygon index. More...
bool	PolygonVertexAdd (FBMesh arg1, object arg2)
	Add a vertex. More...
int	PolygonVertexCount (FBMesh arg1, object arg2)
	Get Polygon vertex count. More...
int	PolygonVertexIndex (FBMesh arg1, object arg2, object arg3)
	Get global (for the mesh) index of a vertex from a polygon. More...
list	PolygonVertexArrayGet (FBMesh arg1)
	Get the array of polygon vertex (i.e. More...
bool	IsTriangleMesh (FBMesh arg1)
	Determines if the mesh is composed entirely of triangles. More...
bool	TriangleListAdd (FBMesh arg1, object arg2, list arg3, object arg4)
	Add Triangle List, Must be called in-between FBGeometry::GeometryBegin() / GeometryEnd() It's user's responsibility to make sure to input valid index values, otherwise afterwards behavior will be undefined. More...
bool	TriangleStripAdd (FBMesh arg1, object arg2, list arg3, object arg4)
	Add Triangle Strip Must be called in-between FBGeometry::GeometryBegin() / GeometryEnd() It's user's responsibility to make sure to input valid index values, otherwise afterwards behavior will be undefined. More...
bool	PolygonListAdd (FBMesh arg1, object arg2, object arg3, list arg4, object arg5)
	Add Polygon List Must be called in-between FBGeometry::GeometryBegin() / GeometryEnd() It's user's responsibility to make sure to input valid index values, otherwise afterwards behavior will be undefined. More...
	ComputeVertexNormals (FBMesh arg1, object arg2)
	Compute Mesh Vertex Normal. More...
	InverseNormal (FBMesh arg1)
	Inverse Normal. More...
Public Member Functions inherited from FBGeometry
	__reduce__ ()
FBStringList	GetUVSets (FBGeometry arg1)
	Get available UVSet name. More...
FBUV	VertexUVGet (FBGeometry arg1, object arg2)
	Get a UV coordinate. More...
FBColorAndAlpha	VertexColorGet (FBGeometry arg1, object arg2)
	Get a Vertex Color. More...
FBNormal	VertexNormalGet (FBGeometry arg1, object arg2)
	Get a normal at a vertex. More...
FBVertex	VertexGet (FBGeometry arg1, object arg2)
	Get a vertex. More...
bool	GeometryEnd (FBGeometry arg1)
	End geometry editing. More...
bool	GeometryBegin (FBGeometry arg1)
	Begin geometry editing. More...
	VertexAdd (...)
bool	VertexClear (FBGeometry arg1)
	Clear all Vertex arrays. More...
bool	VertexArrayClear (FBGeometry arg1)
	Clear all geometry vertex arrays. More...
int	VertexCount (FBGeometry arg1)
	Get the number of vertices in the geometry. More...
bool	VertexGetSelected (FBGeometry arg1, object arg2)
	Get the selected state of a vertex. More...
bool	VertexGetTransformable (FBGeometry arg1, object arg2)
	Get the Transformable state of a vertex. More...
bool	VertexGetVisible (FBGeometry arg1, object arg2)
	Get the visible state of a vertex. More...
	VertexInit (FBGeometry arg1, object arg2, object arg3, object arg4, object arg5)
	Resize or Reserve vertex, normal and UV array for performance. More...
bool	VertexArrayInit (FBGeometry arg1, object arg2, object arg3, int arg4)
	Init geometry vertex arrays. More...
	VertexNormalSet (...)
	VertexColorSet (...)
	VertexSet (...)
bool	VertexSetSelected (FBGeometry arg1, object arg2, object arg3)
	Set the selected state of a vertex. More...
bool	VertexSetVisible (FBGeometry arg1, object arg2, object arg3)
	Set the visible state of a vertex. More...
	VertexUVSet (...)
list	GetPositionsArray (FBGeometry arg1)
	Get a pointer to the position array. More...
bool	SetPositionsArray (FBGeometry arg1, list arg2)
list	GetNormalsDirectArray (FBGeometry arg1)
	Get a pointer to the direct array of normals. More...
bool	SetNormalsDirectArray (FBGeometry arg1, list arg2)
list	GetNormalsIndexArray (FBGeometry arg1)
	Get a pointer to the index array of normals. More...
bool	SetNormalsIndexArray (FBGeometry arg1, list arg2)
list	GetTangentsDirectArray (FBGeometry arg1)
	Get a pointer to the direct array of tangents. More...
bool	SetTangentsDirectArray (FBGeometry arg1, list arg2)
list	GetTangentsIndexArray (FBGeometry arg1)
	Get a pointer to the index array of tangents. More...
bool	SetTangentsIndexArray (FBGeometry arg1, list arg2)
list	GetBinormalsDirectArray (FBGeometry arg1)
	Get a pointer to the direct array of binormals. More...
bool	SetBinormalsDirectArray (FBGeometry arg1, list arg2)
list	GetBinormalsIndexArray (FBGeometry arg1)
	Get a pointer to the index array of binormals. More...
bool	SetBinormalsIndexArray (FBGeometry arg1, list arg2)
list	GetVertexColorsDirectArray (FBGeometry arg1)
	Get a pointer to the direct array of vertex color. More...
bool	SetVertexColorsDirectArray (FBGeometry arg1, list arg2)
list	GetVertexColorsIndexArray (FBGeometry arg1)
	Get a pointer to the index array of vertex color. More...
bool	SetVertexColorsIndexArray (FBGeometry arg1, list arg2)
list	GetUVSetDirectArray (FBGeometry arg1, str arg2)
	Get a pointer to the direct array of UVset Modify array value will be only effective when geometry editing is enabled. More...
bool	SetUVSetDirectArray (FBGeometry arg1, list arg2, str arg3)
list	GetUVSetIndexArray (FBGeometry arg1, str arg2)
	Get a pointer to the index array of UVset. More...
bool	SetUVSetIndexArray (FBGeometry arg1, list arg2, str arg3)
list	GetMaterialIndexArray (FBGeometry arg1)
	Get a pointer to the index array of Material. More...
bool	SetMaterialIndexArray (FBGeometry arg1, list arg2)
int	ShapeGetCount (FBGeometry arg1)
	Get Shape Count. More...
str	ShapeGetName (FBGeometry arg1, object arg2)
	Return the shape Name. More...
int	ShapeAdd (FBGeometry arg1, str arg2)
	Add new shape. More...
	ShapeClearAll (FBGeometry arg1)
	Clears all the shapes. More...
	ShapeInit (FBGeometry arg1, object arg2, object arg3, object arg4)
	Init the shape. More...
bool	ShapeSetDiffPoint (FBGeometry arg1, object arg2, object arg3, object arg4, FBVertex arg5, FBNormal arg6)
bool	ShapeGetDiffPoint (FBGeometry arg1, object arg2, object arg3, object arg4, FBVertex arg5, FBNormal arg6)
bool	ShapeGetDiffPointAsList (FBGeometry arg1, object arg2, object arg3, list arg4, FBVertex arg5, FBNormal arg6)
FBGeometryMappingMode	GetUVSetMappingMode (FBGeometry arg1, str arg2)
	Get UVSet mapping mode. More...
FBGeometryReferenceMode	GetUVSetReferenceMode (FBGeometry arg1, str arg2)
	Get UVSet reference mode. More...
	__init__ (...)
	Constructor. 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__ (...)

Additional Inherited Members
Public Attributes inherited from FBGeometry
FBPropertyGeometryMappingMode	MaterialMappingMode
	Read Property: Material mapping mode. More...
FBPropertyGeometryMappingMode	NormalMappingMode
	Read Only Property: Normal mapping mode. More...
FBPropertyGeometryReferenceMode	NormalReferenceMode
	Read Only Property: Normal reference mode. More...
FBPropertyGeometryMappingMode	TangentMappingMode
	Read Only Property: Tangent mapping mode. More...
FBPropertyGeometryReferenceMode	TangentReferenceMode
	Read Only Property: Tangent reference mode. More...
FBPropertyGeometryMappingMode	BinormalMappingMode
	Read Only Property: Binormal mapping mode. More...
FBPropertyGeometryReferenceMode	BinormalReferenceMode
	Read Only Property: Binormal reference mode. More...
FBPropertyGeometryMappingMode	VertexColorMappingMode
	Read Only Property: Vertex Color mapping mode. More...
FBPropertyGeometryReferenceMode	VertexColorReferenceMode
	Read Only Property: Vertex Color reference 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,
		str	arg2
	)

Constructor.

Python Docstring:

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

C++ Signature:

 FBMesh(const char * pName, HIObject pObject = ((void *) 0)) 

Parameters

pName	Name of Mesh.
pObject	For internal use only(default=NULL).

See the C++ reference

__reduce__

(

)

ComputeVertexNormals	(	FBMesh	arg1,
		object	arg2
	)

Compute Mesh Vertex Normal.

Python Docstring:

ComputeVertexNormals( (FBMesh)arg1 [, (object)arg2]) -> None 

C++ Signature:

void ComputeVertexNormals(bool pCW = false) 

Parameters

pCW	True for clock wise normal, otherwise for counter-clock wise

See the C++ reference

InverseNormal

(

FBMesh

arg1

)

Inverse Normal.

Python Docstring:

InverseNormal( (FBMesh)arg1) -> None 

C++ Signature:

void InverseNormal() 

See the C++ reference

bool IsTriangleMesh

(

FBMesh

arg1

)

Determines if the mesh is composed entirely of triangles.

Python Docstring:

IsTriangleMesh( (FBMesh)arg1) -> bool 

C++ Signature:

bool IsTriangleMesh() 

Returns

true if all polygons are triangles, false otherwise

See the C++ reference

int PolygonBegin	(	FBMesh	arg1,
		object	arg2
	)

Begin Polygon definition.

Python Docstring:

PolygonBegin( (FBMesh)arg1 [, (object)arg2]) -> int 

C++ Signature:

int PolygonBegin(int pMaterialId = 0) 

Parameters

pMaterialId

Index of material for this polygon. Only effective when MaterialMappingMode is kFBGeometryMapping_BY_POLYGON mode.

Returns

Number of existing polygons in Mesh

See the C++ reference

int PolygonCount

(

FBMesh

arg1

)

Get number of polygons in mesh.

Python Docstring:

PolygonCount( (FBMesh)arg1) -> int 

C++ Signature:

int PolygonCount() 

Returns

Number of polygons in mesh.

See the C++ reference

int PolygonEnd

(

FBMesh

arg1

)

End Polygon definition.

Python Docstring:

PolygonEnd( (FBMesh)arg1) -> int 

C++ Signature:

int PolygonEnd() 

Clean up and associate vertices internally.

Returns

Current number of polygons.

Note

MoBu expect each polygon to contain at least 3 vertices, the behavior is undefined if user add less than 3 vertices polygon.

See the C++ reference

bool PolygonListAdd	(	FBMesh	arg1,
		object	arg2,
		object	arg3,
		list	arg4,
		object	arg5
	)

Add Polygon List Must be called in-between FBGeometry::GeometryBegin() / GeometryEnd() It's user's responsibility to make sure to input valid index values, otherwise afterwards behavior will be undefined.

Python Docstring:

PolygonListAdd( (FBMesh)arg1, (object)arg2, (object)arg3, (list)arg4 [, (object)arg5]) -> bool 

C++ Signature:

bool PolygonListAdd(int pPolygonSize, int pIndexArraySize, int * pIndexArray, int pMaterialId = 0) 

Parameters

pPolygonSize	Size of polygon, 3 mean triangle, 4 for quadrilateral, and so on. minimum input value is 3.
pIndexArraySize	Size of pIndexArray, Added polygon count is floor(max(pIndexArraySize, 0) / pPolygonSize)
pIndexArray	Index array of triangle strip.
pMaterialId	Index of material for this polygon. Only effective when MaterialMappingMode is kFBGeometryMapping_BY_POLYGON mode.

Note

The indexes' value in input pIndexArray won't be validated, and the behavior is undefined if out of range.

See the C++ reference

int PolygonMaterialIdGet	(	FBMesh	arg1,
		object	arg2
	)

Get a Material ID for the given Polygon index.

Python Docstring:

PolygonMaterialIdGet( (FBMesh)arg1 [, (object)arg2]) -> int 

C++ Signature:

int PolygonMaterialIdGet(int pIndex = -1) 

Parameters

pIndex

Polygon's index to get material ID at (default=-1).

Returns

ID of material of vertex at pIndex.

See the C++ reference

bool PolygonVertexAdd	(	FBMesh	arg1,
		object	arg2
	)

Add a vertex.

Python Docstring:

PolygonVertexAdd( (FBMesh)arg1, (object)arg2) -> bool 

C++ Signature:

bool PolygonVertexAdd(int pVertex) 

Parameters

pVertex

Index in mesh of vertex to add to polygon, must be in range of [0, ControlPointCount)

Returns

true if successful.

See the C++ reference

list PolygonVertexArrayGet

(

FBMesh

arg1

)

Get the array of polygon vertex (i.e.

Python Docstring:

PolygonVertexArrayGet( (FBMesh)arg1) -> list 

C++ Signature:

const int * PolygonVertexArrayGet(int & pArraySize) 

index to control points). This array is a concatenation of the list of polygon vertices of all the polygons. Example: a mesh made of 2 triangles [1,2,3] and [2,3,4] results in [1,2,3,2,3,4]. The first polygon starts at position 0 and the second at position 3.

Parameters

pArraySize

Polygon vertex array size.

Returns

Readonly polygon vertex array.

See the C++ reference

int PolygonVertexCount	(	FBMesh	arg1,
		object	arg2
	)

Get Polygon vertex count.

Python Docstring:

PolygonVertexCount( (FBMesh)arg1, (object)arg2) -> int 

C++ Signature:

int PolygonVertexCount(int pPolygonIndex) 

Parameters

pPolygonIndex

Index of polygon to get vertex count from.

Returns

Number of vertices in polygon at pPolygonIndex.

See the C++ reference

int PolygonVertexIndex	(	FBMesh	arg1,
		object	arg2,
		object	arg3
	)

Get global (for the mesh) index of a vertex from a polygon.

Python Docstring:

PolygonVertexIndex( (FBMesh)arg1, (object)arg2, (object)arg3) -> int 

C++ Signature:

int PolygonVertexIndex(int pPolygonIndex, int pVertexPolygonIndex) 

Parameters

pPolygonIndex	Index of polygon in question.
pVertexPolygonIndex	Polygon vertex index.

Returns

Index in mesh of vertex.

See the C++ reference

bool TriangleListAdd	(	FBMesh	arg1,
		object	arg2,
		list	arg3,
		object	arg4
	)

Add Triangle List, Must be called in-between FBGeometry::GeometryBegin() / GeometryEnd() It's user's responsibility to make sure to input valid index values, otherwise afterwards behavior will be undefined.

Python Docstring:

TriangleListAdd( (FBMesh)arg1, (object)arg2, (list)arg3 [, (object)arg4]) -> bool 

C++ Signature:

bool TriangleListAdd(int pIndexArraySize, int * pIndexArray, int pMaterialId = 0) 

Parameters

pIndexArraySize	Size of pIndexArray, Added triangle count is floor(max(pIndexArraySize, 0) / 3)
pIndexArray	Index array of triangle list.
pMaterialId	Index of material for this polygon. Only effective when MaterialMappingMode is kFBGeometryMapping_BY_POLYGON mode.

Note

The indexes' value in input pIndexArray won't be validated, and the behavior is undefined if out of range.

See the C++ reference

bool TriangleStripAdd	(	FBMesh	arg1,
		object	arg2,
		list	arg3,
		object	arg4
	)

Add Triangle Strip Must be called in-between FBGeometry::GeometryBegin() / GeometryEnd() It's user's responsibility to make sure to input valid index values, otherwise afterwards behavior will be undefined.

Python Docstring:

TriangleStripAdd( (FBMesh)arg1, (object)arg2, (list)arg3 [, (object)arg4]) -> bool 

C++ Signature:

bool TriangleStripAdd(int pIndexArraySize, int * pIndexArray, int pMaterialId = 0) 

Parameters

pIndexArraySize	Size of pIndexArray, Added triangle count is max(pIndexArraySize - 2, 0)
pIndexArray	Index array of triangle strip.
pMaterialId	Index of material for this polygon. Only effective when MaterialMappingMode is kFBGeometryMapping_BY_POLYGON mode.

Note

The indexes' value in input pIndexArray won't be validated, and the behavior is undefined if out of range.

See the C++ reference