FBGeometry Class Reference

#include <mobu-python-api.h>

Class Description

Geometry class.

This class groups all geometry related elements which are shared across the different subclasses (FBMesh, FBSurface, FBNurbs and FBPatch). Geometry Material always use kFBGeometryReference_INDEX mode. While Normal, UV could have different combination of mapping and reference modes. Geometries created with SDK can support FBGeometryMapping_ALL_SAME or kFBGeometryMapping_BY_POLYGON for material, and kFBGeometryMapping_BY_CONTROL_POINT for Normal, Tangent, Binormal, Color and UV. Only one set of UV could be supported. Geometries passed from FBXSDK pipeline could have various complex mapping/reference mode combination for material, normal and UV. And could potentially contains multiple set of UVs.

See the C++ reference

Inheritance diagram for FBGeometry:

Public Member Functions
	__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__ (...)

Public Attributes
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__

(

...

)

Constructor.

Python Docstring:

Raises an exception
This class cannot be instantiated from Python 

C++ Signature:

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

Parameters

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

See the C++ reference

__reduce__

(

)

bool GeometryBegin

(

FBGeometry

arg1

)

Begin geometry editing.

Python Docstring:

GeometryBegin( (FBGeometry)arg1) -> bool 

C++ Signature:

bool GeometryBegin() 

Returns

true if successful.

See the C++ reference

bool GeometryEnd

(

FBGeometry

arg1

)

End geometry editing.

Python Docstring:

GeometryEnd( (FBGeometry)arg1) -> bool 

C++ Signature:

bool GeometryEnd() 

Returns

true if successful.

See the C++ reference

list GetBinormalsDirectArray

(

FBGeometry

arg1

)

Get a pointer to the direct array of binormals.

Python Docstring:

GetBinormalsDirectArray( (FBGeometry)arg1) -> list 

C++ Signature:

FBNormal * GetBinormalsDirectArray(int & pOutArrayCount) 

Modify array value will be only effective when geometry editing is enabled.

See also

GeometryBegin()/GeometryEnd()

Parameters

pOutArrayCount

To return the length the array.

Returns

Pointer to direct array of binormals, or NULL if the array hasn't been allocated yet.

See the C++ reference

list GetBinormalsIndexArray

(

FBGeometry

arg1

)

Get a pointer to the index array of binormals.

Python Docstring:

GetBinormalsIndexArray( (FBGeometry)arg1) -> list 

C++ Signature:

int * GetBinormalsIndexArray(int & pOutArrayCount) 

Modify array value will be only effective when geometry editing is enabled.

See also

GeometryBegin()/GeometryEnd()

Parameters

pOutArrayCount

To return the length the array.

Returns

Pointer to index array of binormals, or NULL if the array hasn't been allocated yet.

See the C++ reference

list GetMaterialIndexArray

(

FBGeometry

arg1

)

Get a pointer to the index array of Material.

Python Docstring:

GetMaterialIndexArray( (FBGeometry)arg1) -> list 

C++ Signature:

int * GetMaterialIndexArray(int & pOutArrayCount) 

Modify array value will be only effective when geometry editing is enabled.

See also

GeometryBegin()/GeometryEnd()

Parameters

pOutArrayCount

To return the length the array.

Returns

Pointer to index array of Material, or NULL if the array hasn't been allocated yet.

See the C++ reference

list GetNormalsDirectArray

(

FBGeometry

arg1

)

Get a pointer to the direct array of normals.

Python Docstring:

GetNormalsDirectArray( (FBGeometry)arg1) -> list 

C++ Signature:

FBNormal * GetNormalsDirectArray(int & pOutArrayCount) 

Modify array value will be only effective when geometry editing is enabled.

See also

GeometryBegin()/GeometryEnd()

Parameters

pOutArrayCount

To return the length the array.

Returns

Pointer to direct array of normals, or NULL if the array hasn't been allocated yet.

See the C++ reference

list GetNormalsIndexArray

(

FBGeometry

arg1

)

Get a pointer to the index array of normals.

Python Docstring:

GetNormalsIndexArray( (FBGeometry)arg1) -> list 

C++ Signature:

int * GetNormalsIndexArray(int & pOutArrayCount) 

Modify array value will be only effective when geometry editing is enabled.

See also

GeometryBegin()/GeometryEnd()

Parameters

pOutArrayCount

To return the length the array.

Returns

Pointer to index array of normals, or NULL if the array hasn't been allocated yet.

See the C++ reference

list GetPositionsArray

(

FBGeometry

arg1

)

Get a pointer to the position array.

Python Docstring:

GetPositionsArray( (FBGeometry)arg1) -> list 

C++ Signature:

FBVertex * GetPositionsArray(int & pOutArrayCount) 

Modify array value will be only effective when geometry editing is enabled.

See also

GeometryBegin()/GeometryEnd()

Parameters

pOutArrayCount

To return the length the array.

Returns

Pointer to index array of normals, or NULL if the array hasn't been allocated yet.

See the C++ reference

list GetTangentsDirectArray

(

FBGeometry

arg1

)

Get a pointer to the direct array of tangents.

Python Docstring:

GetTangentsDirectArray( (FBGeometry)arg1) -> list 

C++ Signature:

FBNormal * GetTangentsDirectArray(int & pOutArrayCount) 

Modify array value will be only effective when geometry editing is enabled.

See also

GeometryBegin()/GeometryEnd()

Parameters

pOutArrayCount

To return the length the array.

Returns

Pointer to direct array of tangents, or NULL if the array hasn't been allocated yet.

See the C++ reference

list GetTangentsIndexArray

(

FBGeometry

arg1

)

Get a pointer to the index array of tangents.

Python Docstring:

GetTangentsIndexArray( (FBGeometry)arg1) -> list 

C++ Signature:

int * GetTangentsIndexArray(int & pOutArrayCount) 

Modify array value will be only effective when geometry editing is enabled.

See also

GeometryBegin()/GeometryEnd()

Parameters

pOutArrayCount

To return the length the array.

Returns

Pointer to index array of tangents, or NULL if the array hasn't been allocated yet.

See the C++ reference

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.

Python Docstring:

GetUVSetDirectArray( (FBGeometry)arg1 [, (str)arg2]) -> list 

C++ Signature:

FBUV * GetUVSetDirectArray(int & pOutArrayCount, const char * pUVSetName = ((void *) 0)) 

See also

GeometryBegin()/GeometryEnd()

Parameters

pOutArrayCount	To return the length the array.
pUVSetName	The name of UVset, NULL for the first UVset.

Returns

pointer to the array of UV, or NULL is the array hasn't been allocated yet.

See the C++ reference

list GetUVSetIndexArray	(	FBGeometry	arg1,
		str	arg2
	)

Get a pointer to the index array of UVset.

Python Docstring:

GetUVSetIndexArray( (FBGeometry)arg1 [, (str)arg2]) -> list 

C++ Signature:

int * GetUVSetIndexArray(int & pOutArrayCount, const char * pUVSetName = ((void *) 0)) 

Modify array value will be only effective when geometry editing is enabled.

See also

GeometryBegin()/GeometryEnd()

Parameters

pOutArrayCount	To return the length the array.
pUVSetName	The name of UVset, NULL for the first UVset.

Returns

Pointer to index array of UVSet, or NULL if the array hasn't been allocated yet.

See the C++ reference

FBGeometryMappingMode GetUVSetMappingMode	(	FBGeometry	arg1,
		str	arg2
	)

Get UVSet mapping mode.

Python Docstring:

GetUVSetMappingMode( (FBGeometry)arg1 [, (str)arg2]) -> FBGeometryMappingMode 

C++ Signature:

FBGeometryMappingMode GetUVSetMappingMode(const char * pUVSetName = ((void *) 0)) 

Parameters

pUVSetName

The name of UVset, NULL for the first UVset.

Returns

Mapping mode of the UVset.

See the C++ reference

FBGeometryReferenceMode GetUVSetReferenceMode	(	FBGeometry	arg1,
		str	arg2
	)

Get UVSet reference mode.

Python Docstring:

GetUVSetReferenceMode( (FBGeometry)arg1 [, (str)arg2]) -> FBGeometryReferenceMode 

C++ Signature:

FBGeometryReferenceMode GetUVSetReferenceMode(const char * pUVSetName = ((void *) 0)) 

Parameters

pUVSetName

The name of UVset, NULL for the first UVset.

Returns

Reference mode of the UVset.

See the C++ reference

FBStringList GetUVSets

(

FBGeometry

arg1

)

Get available UVSet name.

Python Docstring:

GetUVSets( (FBGeometry)arg1) -> FBStringList 

C++ Signature:

ORSDK2018::FBStringList GetUVSets() 

Returns

StringList contain all the available UVSets' name.

See the C++ reference

list GetVertexColorsDirectArray

(

FBGeometry

arg1

)

Get a pointer to the direct array of vertex color.

Python Docstring:

GetVertexColorsDirectArray( (FBGeometry)arg1) -> list 

C++ Signature:

FBColorF * GetVertexColorsDirectArray(int & pOutArrayCount) 

Modify array value will be only effective when geometry editing is enabled.

See also

GeometryBegin()/GeometryEnd()

Parameters

pOutArrayCount

To return the length the array.

Returns

Pointer to direct array of vertex colors, or NULL if the array hasn't been allocated yet.

See the C++ reference

list GetVertexColorsIndexArray

(

FBGeometry

arg1

)

Get a pointer to the index array of vertex color.

Python Docstring:

GetVertexColorsIndexArray( (FBGeometry)arg1) -> list 

C++ Signature:

int * GetVertexColorsIndexArray(int & pOutArrayCount) 

Modify array value will be only effective when geometry editing is enabled.

See also

GeometryBegin()/GeometryEnd()

Parameters

pOutArrayCount

To return the length the array.

Returns

Pointer to index array of vertex color, or NULL if the array hasn't been allocated yet.

See the C++ reference

bool SetBinormalsDirectArray	(	FBGeometry	arg1,
		list	arg2
	)

Python Docstring:

SetBinormalsDirectArray( (FBGeometry)arg1, (list)arg2) -> bool 

bool SetBinormalsIndexArray	(	FBGeometry	arg1,
		list	arg2
	)

Python Docstring:

SetBinormalsIndexArray( (FBGeometry)arg1, (list)arg2) -> bool 

bool SetMaterialIndexArray	(	FBGeometry	arg1,
		list	arg2
	)

Python Docstring:

SetMaterialIndexArray( (FBGeometry)arg1, (list)arg2) -> bool 

bool SetNormalsDirectArray	(	FBGeometry	arg1,
		list	arg2
	)

Python Docstring:

SetNormalsDirectArray( (FBGeometry)arg1, (list)arg2) -> bool 

bool SetNormalsIndexArray	(	FBGeometry	arg1,
		list	arg2
	)

Python Docstring:

SetNormalsIndexArray( (FBGeometry)arg1, (list)arg2) -> bool 

bool SetPositionsArray	(	FBGeometry	arg1,
		list	arg2
	)

Python Docstring:

SetPositionsArray( (FBGeometry)arg1, (list)arg2) -> bool 

bool SetTangentsDirectArray	(	FBGeometry	arg1,
		list	arg2
	)

Python Docstring:

SetTangentsDirectArray( (FBGeometry)arg1, (list)arg2) -> bool 

bool SetTangentsIndexArray	(	FBGeometry	arg1,
		list	arg2
	)

Python Docstring:

SetTangentsIndexArray( (FBGeometry)arg1, (list)arg2) -> bool 

bool SetUVSetDirectArray	(	FBGeometry	arg1,
		list	arg2,
		str	arg3
	)

Python Docstring:

SetUVSetDirectArray( (FBGeometry)arg1, (list)arg2 [, (str)arg3]) -> bool 

bool SetUVSetIndexArray	(	FBGeometry	arg1,
		list	arg2,
		str	arg3
	)

Python Docstring:

SetUVSetIndexArray( (FBGeometry)arg1, (list)arg2 [, (str)arg3]) -> bool 

bool SetVertexColorsDirectArray	(	FBGeometry	arg1,
		list	arg2
	)

Python Docstring:

SetVertexColorsDirectArray( (FBGeometry)arg1, (list)arg2) -> bool 

bool SetVertexColorsIndexArray	(	FBGeometry	arg1,
		list	arg2
	)

Python Docstring:

SetVertexColorsIndexArray( (FBGeometry)arg1, (list)arg2) -> bool 

int ShapeAdd	(	FBGeometry	arg1,
		str	arg2
	)

Add new shape.

Python Docstring:

ShapeAdd( (FBGeometry)arg1, (str)arg2) -> int 

C++ Signature:

int ShapeAdd(const char * pName) 

Parameters

pName

the shape name

Returns

the index of the new shape, -1 if the shape adding fail.

See the C++ reference

ShapeClearAll

(

FBGeometry

arg1

)

Clears all the shapes.

Python Docstring:

ShapeClearAll( (FBGeometry)arg1) -> None 

C++ Signature:

void ShapeClearAll() 

See the C++ reference

int ShapeGetCount

(

FBGeometry

arg1

)

Get Shape Count.

Python Docstring:

ShapeGetCount( (FBGeometry)arg1) -> int 

C++ Signature:

int ShapeGetCount() 

See the C++ reference

bool ShapeGetDiffPoint	(	FBGeometry	arg1,
		object	arg2,
		object	arg3,
		object	arg4,
		FBVertex	arg5,
		FBNormal	arg6
	)

Python Docstring:

ShapeGetDiffPoint( (FBGeometry)arg1, (object)arg2, (object)arg3, (object)arg4, (FBVertex)arg5, (FBNormal)arg6) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool ShapeGetDiffPoint(int pShapeIdx, int pDiffIndex, int & pOriIndex, FBVertex & pPosDiff)
bool ShapeGetDiffPoint(int pShapeIdx, int pDiffIndex, int & pOriIndex, FBVertex & pPosDiff, FBNormal & pNormalDiff)

bool ShapeGetDiffPointAsList	(	FBGeometry	arg1,
		object	arg2,
		object	arg3,
		list	arg4,
		FBVertex	arg5,
		FBNormal	arg6
	)

Python Docstring:

ShapeGetDiffPointAsList( (FBGeometry)arg1, (object)arg2, (object)arg3, (list)arg4, (FBVertex)arg5, (FBNormal)arg6) -> bool 

str ShapeGetName	(	FBGeometry	arg1,
		object	arg2
	)

Return the shape Name.

Python Docstring:

ShapeGetName( (FBGeometry)arg1, (object)arg2) -> str 

C++ Signature:

const char * ShapeGetName(int pShapeIdx) 

See the C++ reference

ShapeInit	(	FBGeometry	arg1,
		object	arg2,
		object	arg3,
		object	arg4
	)

Init the shape.

Python Docstring:

ShapeInit( (FBGeometry)arg1, (object)arg2, (object)arg3, (object)arg4) -> None 

C++ Signature:

void ShapeInit(int pShapeIdx, int pDiffSize, bool pWithNormal = false) 

Parameters

pShapeIdx	The index of the shape to be initialized
pDiffSize	Total number of different point (pos or normal) compared to base geometry.
pWithNormal	Currently normal won't be considered during shape blending.

See the C++ reference

bool ShapeSetDiffPoint	(	FBGeometry	arg1,
		object	arg2,
		object	arg3,
		object	arg4,
		FBVertex	arg5,
		FBNormal	arg6
	)

Python Docstring:

ShapeSetDiffPoint( (FBGeometry)arg1, (object)arg2, (object)arg3, (object)arg4, (FBVertex)arg5 [, (FBNormal)arg6]) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool ShapeSetDiffPoint(int pShapeIdx, int pDiffIndex, int pOriIndex, const FBVertex & pPosDiff)
bool ShapeSetDiffPoint(int pShapeIdx, int pDiffIndex, int pOriIndex, const FBVertex & pPosDiff, const FBNormal & pNormalDiff)

VertexAdd

(

...

)

Python Docstring:

VertexAdd( (FBGeometry)arg1, (FBVertex)arg2) -> int

VertexAdd( (FBGeometry)arg1, (object)arg2, (object)arg3, (object)arg4) -> int 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

int VertexAdd(FBVertex pVertex)
int VertexAdd(FBVertex pVertex, FBNormal pNormal)
int VertexAdd(FBVertex pVertex, FBNormal pNormal, FBUV pUV)
int VertexAdd(FBVertex pVertex, FBNormal pNormal, FBUV pUV, FBColorF pVertexColor)
int VertexAdd(double px, double py, double pz)
int VertexAdd(double px, double py, double pz, double nx, double ny, double nz)
int VertexAdd(double px, double py, double pz, double nx, double ny, double nz, double UVu, double UVv)
int VertexAdd(double px, double py, double pz, double nx, double ny, double nz, double UVu, double UVv, double pRed, double pGreen, double pBlue, double pAlpha)

bool VertexArrayClear

(

FBGeometry

arg1

)

Clear all geometry vertex arrays.

Python Docstring:

VertexArrayClear( (FBGeometry)arg1) -> bool 

C++ Signature:

bool VertexArrayClear() 

Call this function to clear Position, Normal, UV, Color and etc vertex arrays, and it won't affect geometry's topology (polygon, Surface and etc.,).

Returns

true if successful.

See the C++ reference

bool VertexArrayInit	(	FBGeometry	arg1,
		object	arg2,
		object	arg3,
		int	arg4
	)

Init geometry vertex arrays.

Python Docstring:

VertexArrayInit( (FBGeometry)arg1, (object)arg2, (object)arg3 [, (int)arg4]) -> bool 

C++ Signature:

bool VertexArrayInit(int pVertexcount, bool pUniqueMaterial, unsigned int pFBGeometryArrayIDs = 0) 

Init position, normal and UV arrays (tangent, bi-normal and color on demand) with kFBGeometryMapping_BY_CONTROL_POINT / kFBGeometryReference_DIRECT mode. Will call VertexArrayClear() internally. User should then call GetXXXDirectyArray() to edit the vertex attributes directly.

Parameters

pVertexcount	number of control points (vertex)
pUniqueMaterial	User could specify per polygon mapping mode for mesh
pFBGeometryArrayIDs	Request to init other attribute arrays, bitwise combined value of FBGeometryArrayID enum items, currently support Tangent, Binormal and VertexColor. Only useful for mesh.

See the C++ reference

bool VertexClear

(

FBGeometry

arg1

)

Clear all Vertex arrays.

Python Docstring:

VertexClear( (FBGeometry)arg1) -> bool 

C++ Signature:

bool VertexClear() 

Call this function to clear Position, Normal, UV, Color and etc vertex arrays, and it won't affect geometry's topology (polygon, Surface and etc.,).

Returns

true if successful.

See the C++ reference

FBColorAndAlpha VertexColorGet	(	FBGeometry	arg1,
		object	arg2
	)

Get a Vertex Color.

Python Docstring:

VertexColorGet( (FBGeometry)arg1, (object)arg2) -> FBColorAndAlpha 

C++ Signature:

FBColorF VertexColorGet(int pIndex = -1) 

Parameters

pIndex

Index of Vertex to get Color for(default=-1).

Returns

Color of vertex at UVSetIndex.

See the C++ reference

VertexColorSet

(

...

)

Python Docstring:

VertexColorSet( (FBGeometry)arg1, (FBColorAndAlpha)arg2 [, (object)arg3]) -> bool

VertexColorSet( (FBGeometry)arg1, (object)arg2, (object)arg3, (object)arg4, (object)arg5 [, (object)arg6]) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool VertexColorSet(FBColorF pColor, int pIndex = -1)
bool VertexColorSet(float pRed, float pGreen, float pBlue, float pAlpha, int pIndex = -1)

int VertexCount

(

FBGeometry

arg1

)

Get the number of vertices in the geometry.

Python Docstring:

VertexCount( (FBGeometry)arg1) -> int 

C++ Signature:

int VertexCount() 

Returns

Number of vertices in the geometry.

See the C++ reference

FBVertex VertexGet	(	FBGeometry	arg1,
		object	arg2
	)

Get a vertex.

Python Docstring:

VertexGet( (FBGeometry)arg1, (object)arg2) -> FBVertex 

C++ Signature:

FBVertex VertexGet(int pIndex) 

Parameters

pIndex

Index of vertex to get.

Returns

Vertex stored at pIndex.

See the C++ reference

bool VertexGetSelected	(	FBGeometry	arg1,
		object	arg2
	)

Get the selected state of a vertex.

Python Docstring:

VertexGetSelected( (FBGeometry)arg1, (object)arg2) -> bool 

C++ Signature:

bool VertexGetSelected(int pIndex) 

Parameters

pIndex

The index of the vertex

Returns

true if the vertex is selected, false if not

See the C++ reference

bool VertexGetTransformable	(	FBGeometry	arg1,
		object	arg2
	)

Get the Transformable state of a vertex.

Python Docstring:

VertexGetTransformable( (FBGeometry)arg1, (object)arg2) -> bool 

C++ Signature:

bool VertexGetTransformable(int pIndex) 

Parameters

pIndex

The index of the vertex

Returns

true if the vertex is Transformable, false if not

See the C++ reference

bool VertexGetVisible	(	FBGeometry	arg1,
		object	arg2
	)

Get the visible state of a vertex.

Python Docstring:

VertexGetVisible( (FBGeometry)arg1, (object)arg2) -> bool 

C++ Signature:

bool VertexGetVisible(int pIndex) 

Parameters

pIndex

The index of the vertex

Returns

true if the vertex is visible, false if not

See the C++ reference

VertexInit	(	FBGeometry	arg1,
		object	arg2,
		object	arg3,
		object	arg4,
		object	arg5
	)

Resize or Reserve vertex, normal and UV array for performance.

Python Docstring:

VertexInit( (FBGeometry)arg1, (object)arg2, (object)arg3 [, (object)arg4 [, (object)arg5]]) -> None 

C++ Signature:

void VertexInit(int pSize, bool pResize, bool pInitUV = true, bool pInitVertexColor = false) 

Parameters

pSize	Number of vertices to resize or reserve.
pResize	True, for the geometry with known vertex count, we should resize the arrays to fixed size, and call VertexSet() afterwards; False, While for dynamic size geometry, we should only reserve the arrays with the estimated optimal size, then call VertexAdd() to dynamically increase the vertex count.
pInitUV	init Vertex UV array if true
pInitVertexColor	Init Vertex Color Array if true.

See the C++ reference

FBNormal VertexNormalGet	(	FBGeometry	arg1,
		object	arg2
	)

Get a normal at a vertex.

Python Docstring:

VertexNormalGet( (FBGeometry)arg1, (object)arg2) -> FBNormal 

C++ Signature:

FBNormal VertexNormalGet(int pIndex = -1) 

Parameters

pIndex

Vertex to get normal at(default=-1).

Returns

Normal of vertex at pIndex.

See the C++ reference

VertexNormalSet

(

...

)

Python Docstring:

VertexNormalSet( (FBGeometry)arg1, (FBNormal)arg2 [, (object)arg3]) -> bool

VertexNormalSet( (FBGeometry)arg1, (object)arg2, (object)arg3, (object)arg4 [, (object)arg5]) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool VertexNormalSet(FBNormal pVertex, int pIndex = -1)
bool VertexNormalSet(double px, double py, double pz, int pIndex = -1)

VertexSet

(

...

)

Python Docstring:

VertexSet( (FBGeometry)arg1, (FBVertex)arg2 [, (object)arg3]) -> bool

VertexSet( (FBGeometry)arg1, (object)arg2, (object)arg3, (object)arg4 [, (object)arg5]) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool VertexSet(FBVertex pVertex, int pIndex = -1)
bool VertexSet(double px, double py, double pz, int pIndex = -1)

bool VertexSetSelected	(	FBGeometry	arg1,
		object	arg2,
		object	arg3
	)

Set the selected state of a vertex.

Python Docstring:

VertexSetSelected( (FBGeometry)arg1, (object)arg2, (object)arg3) -> bool 

C++ Signature:

bool VertexSetSelected(int pIndex, bool pState) 

Parameters

pIndex	The index of the vertex
pState	The true to selected, false to deselect

Returns

true if the vertex is selected, false if not

See the C++ reference

bool VertexSetVisible	(	FBGeometry	arg1,
		object	arg2,
		object	arg3
	)

Set the visible state of a vertex.

Python Docstring:

VertexSetVisible( (FBGeometry)arg1, (object)arg2, (object)arg3) -> bool 

C++ Signature:

bool VertexSetVisible(int pIndex, bool pState) 

Parameters

pIndex	The index of the vertex
pState	true to be visible

Returns

true if the vertex is visible, false if not

See the C++ reference

FBUV VertexUVGet	(	FBGeometry	arg1,
		object	arg2
	)

Get a UV coordinate.

Python Docstring:

VertexUVGet( (FBGeometry)arg1, (object)arg2) -> FBUV 

C++ Signature:

FBUV VertexUVGet(int pIndex = -1) 

Parameters

pIndex

Index of Vertex to get UV coordinate for(default=-1).

Returns

UV coordinate of vertex at UVSetIndex.

See the C++ reference

VertexUVSet

(

...

)

Python Docstring:

VertexUVSet( (FBGeometry)arg1, (FBUV)arg2 [, (object)arg3]) -> bool

VertexUVSet( (FBGeometry)arg1, (float)arg2, (float)arg3 [, (object)arg4]) -> bool 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

bool VertexUVSet(FBUV pUV, int pIndex = -1)
bool VertexUVSet(float pU, float pV, int pIndex = -1)

Member Data Documentation

FBPropertyGeometryMappingMode BinormalMappingMode

Read Only Property: Binormal mapping mode.

See the C++ reference

FBPropertyGeometryReferenceMode BinormalReferenceMode

Read Only Property: Binormal reference mode.

See the C++ reference

FBPropertyGeometryMappingMode MaterialMappingMode

Read Property: Material mapping mode.

See the C++ reference

FBPropertyGeometryMappingMode NormalMappingMode

Read Only Property: Normal mapping mode.

See the C++ reference

FBPropertyGeometryReferenceMode NormalReferenceMode

Read Only Property: Normal reference mode.

See the C++ reference

FBPropertyGeometryMappingMode TangentMappingMode

Read Only Property: Tangent mapping mode.

See the C++ reference

FBPropertyGeometryReferenceMode TangentReferenceMode

Read Only Property: Tangent reference mode.

See the C++ reference

FBPropertyGeometryMappingMode VertexColorMappingMode

Read Only Property: Vertex Color mapping mode.

See the C++ reference

FBPropertyGeometryReferenceMode VertexColorReferenceMode

Read Only Property: Vertex Color reference mode.

See the C++ reference