Geometry class. More...

#include <pyfbsdk.h>

Inheritance diagram for FBGeometry:

[legend]

Public Member Functions
bool	GeometryBegin ()
	Begin geometry editing.

bool	GeometryEnd ()
	End geometry editing.

FBNormal	GetBinormalsDirectArray (int pOutArrayCount)
	Get a pointer to the direct array of binormals.

int	GetBinormalsIndexArray (int pOutArrayCount)
	Get a pointer to the index array of binormals.

int	GetMaterialIndexArray (int pOutArrayCount)
	Get a pointer to the index array of Material.

FBNormal	GetNormalsDirectArray (int pOutArrayCount)
	Get a pointer to the direct array of normals.

int	GetNormalsIndexArray (int pOutArrayCount)
	Get a pointer to the index array of normals.

FBVertex	GetPositionsArray (int pOutArrayCount)
	Get a pointer to the position array.

FBNormal	GetTangentsDirectArray (int pOutArrayCount)
	Get a pointer to the direct array of tangents.

int	GetTangentsIndexArray (int pOutArrayCount)
	Get a pointer to the index array of tangents.

FBUV	GetUVSetDirectArray (int pOutArrayCount, str pUVSetName=None)
	Get a pointer to the direct array of UVset Modify array value will be only effective when geometry editing is enabled.

int	GetUVSetIndexArray (int pOutArrayCount, str pUVSetName=None)
	Get a pointer to the index array of UVset.

FBGeometryMappingMode	GetUVSetMappingMode (str pUVSetName=None)
	Get UVSet mapping mode.

FBGeometryReferenceMode	GetUVSetReferenceMode (str pUVSetName=None)
	Get UVSet reference mode.

FBStringList	GetUVSets ()
	Get available UVSet name.

FBColorF	GetVertexColorsDirectArray (int pOutArrayCount)
	Get a pointer to the direct array of vertex color.

int	GetVertexColorsIndexArray (int pOutArrayCount)
	Get a pointer to the index array of vertex color.

int	ShapeAdd (str pName)
	Add new shape.

	ShapeClearAll ()
	Clears all the shapes.

int	ShapeGetCount ()
	Get Shape Count.

str	ShapeGetName (int pShapeIdx)
	Return the shape Name.

	ShapeInit (int pShapeIdx, int pDiffSize, bool pWithNormal=False)
	Init the shape.

bool	ShapeSetDiffPoint (int pShapeIdx, int pDiffIndex, int pOriIndex, FBVertex pPosDiff)
	Set the differentiate point.

bool	ShapeSetDiffPoint (int pShapeIdx, int pDiffIndex, int pOriIndex, FBVertex pPosDiff, FBNormal pNormalDiff)
	Set the differentiate point.

int	VertexAdd (FBVertex pVertex)
	Add a vertex.

int	VertexAdd (FBVertex pVertex, FBNormal pNormal)
	Add a vertex.

int	VertexAdd (FBVertex pVertex, FBNormal pNormal, FBUV pUV)
	Add a vertex.

int	VertexAdd (FBVertex pVertex, FBNormal pNormal, FBUV pUV, FBColorF pVertexColor)
	Add a vertex.

int	VertexAdd (float px, float py, float pz)
	Add a vertex.

int	VertexAdd (float px, float py, float pz, float nx, float ny, float nz)
	Begin geometry editing.

int	VertexAdd (float px, float py, float pz, float nx, float ny, float nz, float UVu, float UVv)
	Begin geometry editing.

int	VertexAdd (float px, float py, float pz, float nx, float ny, float nz, float UVu, float UVv, float pRed, float pGreen, float pBlue, float pAlpha)
	Begin geometry editing.

bool	VertexArrayClear ()
	Clear all geometry vertex arrays.

bool	VertexArrayInit (int pVertexcount, bool pUniqueMaterial, unsigned int pFBGeometryArrayIDs=0)
	Init geometry vertex arrays.

bool	VertexClear ()
	Clear all Vertex arrays.

FBColorF	VertexColorGet (int pIndex=-1)
	Get a Vertex Color.

bool	VertexColorSet (FBColorF pColor, int pIndex=-1)
	Set a Vertex Color.

bool	VertexColorSet (float pRed, float pGreen, float pBlue, float pAlpha, int pIndex=-1)
	Set a UV coordinate.

int	VertexCount ()
	Get the number of vertices in the geometry.

FBVertex	VertexGet (int pIndex)
	Get a vertex.

bool	VertexGetSelected (int pIndex)
	Get the selected state of a vertex.

bool	VertexGetTransformable (int pIndex)
	Get the Transformable state of a vertex.

bool	VertexGetVisible (int pIndex)
	Get the visible state of a vertex.

	VertexInit (int pSize, bool pResize, bool pInitUV=True, bool pInitVertexColor=False)
	Resize or Reserve vertex, normal and UV array for performance.

FBNormal	VertexNormalGet (int pIndex=-1)
	Get a normal at a vertex.

bool	VertexNormalSet (FBNormal pVertex, int pIndex=-1)
	Set a normal at a vertex.

bool	VertexNormalSet (float px, float py, float pz, int pIndex=-1)
	Set a normal at a vertex.

bool	VertexSet (FBVertex pVertex, int pIndex=-1)
	Set a vertex.

bool	VertexSet (float px, float py, float pz, int pIndex=-1)
	Set a vertex.

bool	VertexSetSelected (int pIndex, bool pState)
	Set the selected state of a vertex.

bool	VertexSetVisible (int pIndex, bool pState)
	Set the visible state of a vertex.

FBUV	VertexUVGet (int pIndex=-1)
	Get a UV coordinate.

bool	VertexUVSet (FBUV pUV, int pIndex=-1)
	Set a UV coordinate.

bool	VertexUVSet (float pU, float pV, int pIndex=-1)
	Set a UV coordinate.

Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.

str	ClassName ()
	Get the class name.

	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

bool	FBCreate ()
	Open Reality Creation function.

	FBDelete ()
	Open Reality deletion function.

	FBDestroy ()
	Open Reality destruction function.

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

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

FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.

	HardSelect ()
	HardSelect.

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

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

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.

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

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

FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.

	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

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

	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

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

Public Attributes
FBGeometryMappingMode	BinormalMappingMode
	Read Only Property: Binormal mapping mode.

FBGeometryReferenceMode	BinormalReferenceMode
	Read Only Property: Binormal reference mode.

FBGeometryMappingMode	MaterialMappingMode
	Read Property: Material mapping mode.

FBGeometryMappingMode	NormalMappingMode
	Read Only Property: Normal mapping mode.

FBGeometryReferenceMode	NormalReferenceMode
	Read Only Property: Normal reference mode.

FBGeometryMappingMode	TangentMappingMode
	Read Only Property: Tangent mapping mode.

FBGeometryReferenceMode	TangentReferenceMode
	Read Only Property: Tangent reference mode.

FBGeometryMappingMode	VertexColorMappingMode
	Read Only Property: Vertex Color mapping mode.

FBGeometryReferenceMode	VertexColorReferenceMode
	Read Only Property: Vertex Color reference mode.

Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.

str	LongName
	Read Write Property: Name and namespace for object.

str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.

FBListComponent	Parents
	List: Parents.

FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

bool	Selected
	Read Write Property: Selected property.

int	TypeInfo
	Contains the Type information of the object.

Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.

int	TypeInfo
	TypeInfo.

Detailed 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 samples: ShapeCreation.py, VertexArrayManipulation.py.

Member Function Documentation

◆ GeometryBegin()

bool GeometryBegin ( )

Begin geometry editing.

Returns: true if successful.

◆ GeometryEnd()

bool GeometryEnd ( )

End geometry editing.

Returns: true if successful.

◆ GetBinormalsDirectArray()

FBNormal GetBinormalsDirectArray ( int pOutArrayCount )

Get a pointer to the direct array of binormals.

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

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 also: GeometryBegin()/GeometryEnd()

◆ GetBinormalsIndexArray()

int GetBinormalsIndexArray ( int pOutArrayCount )

Get a pointer to the index array of binormals.

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

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 also: GeometryBegin()/GeometryEnd()

◆ GetMaterialIndexArray()

int GetMaterialIndexArray ( int pOutArrayCount )

Get a pointer to the index array of Material.

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

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 also: GeometryBegin()/GeometryEnd()

◆ GetNormalsDirectArray()

FBNormal GetNormalsDirectArray ( int pOutArrayCount )

Get a pointer to the direct array of normals.

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

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 also: GeometryBegin()/GeometryEnd()

◆ GetNormalsIndexArray()

int GetNormalsIndexArray ( int pOutArrayCount )

Get a pointer to the index array of normals.

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

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 also: GeometryBegin()/GeometryEnd()

◆ GetPositionsArray()

FBVertex GetPositionsArray ( int pOutArrayCount )

Get a pointer to the position array.

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

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 also: GeometryBegin()/GeometryEnd()

◆ GetTangentsDirectArray()

FBNormal GetTangentsDirectArray ( int pOutArrayCount )

Get a pointer to the direct array of tangents.

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

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 also: GeometryBegin()/GeometryEnd()

◆ GetTangentsIndexArray()

int GetTangentsIndexArray ( int pOutArrayCount )

Get a pointer to the index array of tangents.

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

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 also: GeometryBegin()/GeometryEnd()

◆ GetUVSetDirectArray()

FBUV GetUVSetDirectArray	(	int	pOutArrayCount,
		str	pUVSetName = `None`
	)

Get a pointer to the direct array of UVset Modify array value will be only effective when geometry editing is enabled.

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 also: GeometryBegin()/GeometryEnd()

◆ GetUVSetIndexArray()

int GetUVSetIndexArray	(	int	pOutArrayCount,
		str	pUVSetName = `None`
	)

Get a pointer to the index array of UVset.

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

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 also: GeometryBegin()/GeometryEnd()

◆ GetUVSetMappingMode()

FBGeometryMappingMode GetUVSetMappingMode ( str pUVSetName = None )

Get UVSet mapping mode.

Parameters

pUVSetName The name of UVset, NULL for the first UVset.

Returns: Mapping mode of the UVset.

◆ GetUVSetReferenceMode()

FBGeometryReferenceMode GetUVSetReferenceMode ( str pUVSetName = None )

Get UVSet reference mode.

Parameters

pUVSetName The name of UVset, NULL for the first UVset.

Returns: Reference mode of the UVset.

◆ GetUVSets()

FBStringList GetUVSets ( )

Get available UVSet name.

Returns: StringList contain all the available UVSets' name.

◆ GetVertexColorsDirectArray()

FBColorF GetVertexColorsDirectArray ( int pOutArrayCount )

Get a pointer to the direct array of vertex color.

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

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 also: GeometryBegin()/GeometryEnd()

◆ GetVertexColorsIndexArray()

int GetVertexColorsIndexArray ( int pOutArrayCount )

Get a pointer to the index array of vertex color.

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

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 also: GeometryBegin()/GeometryEnd()

◆ ShapeAdd()

int ShapeAdd ( str pName )

Add new shape.

Parameters

pName the shape name

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

◆ ShapeClearAll()

ShapeClearAll ( )

Clears all the shapes.

◆ ShapeGetCount()

int ShapeGetCount ( )

Get Shape Count.

◆ ShapeGetName()

str ShapeGetName ( int pShapeIdx )

Return the shape Name.

◆ ShapeInit()

ShapeInit	(	int	pShapeIdx,
		int	pDiffSize,
		bool	pWithNormal = `False`
	)

Init the shape.

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.

◆ ShapeSetDiffPoint() [1/2]

bool ShapeSetDiffPoint	(	int	pShapeIdx,
		int	pDiffIndex,
		int	pOriIndex,
		FBVertex	pPosDiff
	)

Set the differentiate point.

Parameters

pShapeIdx	The index of the shape
pDiffIndex	The index of the diff point in this shape.
pOriIndex	The index of the diff point in the original geometry.
pPosDiff	The position differentiation.

◆ ShapeSetDiffPoint() [2/2]

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

Set the differentiate point.

Parameters

pShapeIdx	The index of the shape
pDiffIndex	The index of the diff point in this shape.
pOriIndex	The index of the diff point in the original geometry.
pPosDiff	The position differentiation.
pNormalDiff	The normal differentiation.

◆ VertexAdd() [1/8]

int VertexAdd ( FBVertex pVertex )

Add a vertex.

Parameters

pVertex Vertex values used to add vertex.

Returns: Index where vertex was added.

Remarks: Set Normal with default value

◆ VertexAdd() [2/8]

int VertexAdd	(	FBVertex	pVertex,
		FBNormal	pNormal
	)

Add a vertex.

Parameters

pVertex	Vertex values used to add vertex.
pNormal	Normal values used to add vertex.

Returns: Index where vertex was added.

◆ VertexAdd() [3/8]

int VertexAdd	(	FBVertex	pVertex,
		FBNormal	pNormal,
		FBUV	pUV
	)

Add a vertex.

Parameters

pVertex	Vertex values used to add vertex.
pNormal	Normal values used to add vertex.
pUV	UV values used to add vertex.

Returns: Index where vertex was added.

◆ VertexAdd() [4/8]

int VertexAdd	(	FBVertex	pVertex,
		FBNormal	pNormal,
		FBUV	pUV,
		FBColorF	pVertexColor
	)

Add a vertex.

Parameters

pVertex	Vertex values used to add vertex.
pNormal	Normal values used to add vertex.
pUV	UV values used to add vertex.
pVertexColor	Color values used to add vertex.

Returns: Index where vertex was added.

◆ VertexAdd() [5/8]

int VertexAdd	(	float	px,
		float	py,
		float	pz
	)

Add a vertex.

Parameters

px	X coordinate of vertex to add.
py	Y coordinate of vertex to add.
pz	Z coordinate of vertex to add.

Returns: Index where vertex was added.

Remarks: Set Normal with default value

◆ VertexAdd() [6/8]

int VertexAdd	(	float	px,
		float	py,
		float	pz,
		float	nx,
		float	ny,
		float	nz
	)

Begin geometry editing.

Returns: true if successful.

◆ VertexAdd() [7/8]

int VertexAdd	(	float	px,
		float	py,
		float	pz,
		float	nx,
		float	ny,
		float	nz,
		float	UVu,
		float	UVv
	)

Begin geometry editing.

Returns: true if successful.

◆ VertexAdd() [8/8]

int VertexAdd	(	float	px,
		float	py,
		float	pz,
		float	nx,
		float	ny,
		float	nz,
		float	UVu,
		float	UVv,
		float	pRed,
		float	pGreen,
		float	pBlue,
		float	pAlpha
	)

Begin geometry editing.

Returns: true if successful.

◆ VertexArrayClear()

bool VertexArrayClear ( )

Clear all geometry vertex arrays.

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.

◆ VertexArrayInit()

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

Init geometry vertex arrays.

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.

◆ VertexClear()

bool VertexClear ( )

Clear all Vertex arrays.

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.

◆ VertexColorGet()

FBColorF VertexColorGet ( int pIndex = -1 )

Get a Vertex Color.

Parameters

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

Returns: Color of vertex at UVSetIndex.

◆ VertexColorSet() [1/2]

bool VertexColorSet	(	FBColorF	pColor,
		int	pIndex = `-1`
	)

Set a Vertex Color.

Parameters

pColor	Vertex Color to set.
pIndex	Index of Vertex to affect with pColor(default=-1).

Returns: true if successful.

◆ VertexColorSet() [2/2]

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

Set a UV coordinate.

Parameters

pRed	Red Color Channel to set, range [0, 1].
pGreen	Green Color Channel to set, range [0, 1].
pBlue	Blue Color Channel to set, range [0, 1].
pAlpha	Alpha Color Channel to set, range [0, 1].
pIndex	Index of Vertex to affect with Red, Green, Blue and Alpha (default=-1).

Returns: true if successful.

◆ VertexCount()

int VertexCount ( )

Get the number of vertices in the geometry.

Returns: Number of vertices in the geometry.

◆ VertexGet()

FBVertex VertexGet ( int pIndex )

Get a vertex.

Parameters

pIndex Index of vertex to get.

Returns: Vertex stored at pIndex.

◆ VertexGetSelected()

bool VertexGetSelected ( int pIndex )

Get the selected state of a vertex.

Parameters

pIndex The index of the vertex

Returns: true if the vertex is selected, false if not

◆ VertexGetTransformable()

bool VertexGetTransformable ( int pIndex )

Get the Transformable state of a vertex.

Parameters

pIndex The index of the vertex

Returns: true if the vertex is Transformable, false if not

◆ VertexGetVisible()

bool VertexGetVisible ( int pIndex )

Get the visible state of a vertex.

Parameters

pIndex The index of the vertex

Returns: true if the vertex is visible, false if not

◆ VertexInit()

VertexInit	(	int	pSize,
		bool	pResize,
		bool	pInitUV = `True`,
		bool	pInitVertexColor = `False`
	)

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

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.

◆ VertexNormalGet()

FBNormal VertexNormalGet ( int pIndex = -1 )

Get a normal at a vertex.

Parameters

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

Returns: Normal of vertex at pIndex.

◆ VertexNormalSet() [1/2]

bool VertexNormalSet	(	FBNormal	pVertex,
		int	pIndex = `-1`
	)

Set a normal at a vertex.

Parameters

pVertex	Normal to set.
pIndex	Index of vertex to set Normal at(default=-1).

Returns: true if successful.

◆ VertexNormalSet() [2/2]

bool VertexNormalSet	(	float	px,
		float	py,
		float	pz,
		int	pIndex = `-1`
	)

Set a normal at a vertex.

Parameters

px	X coordinate of normal.
py	Y coordinate of normal.
pz	Z coordinate of normal.
pIndex	Index of vertex to set Normal at(default=-1).

Returns: true if successful.

◆ VertexSet() [1/2]

bool VertexSet	(	FBVertex	pVertex,
		int	pIndex = `-1`
	)

Set a vertex.

Parameters

pVertex	Vertex values used to set vertex.
pIndex	Index of vertex to affect (default=-1).

Returns: true if successful.

◆ VertexSet() [2/2]

bool VertexSet	(	float	px,
		float	py,
		float	pz,
		int	pIndex = `-1`
	)

Set a vertex.

Parameters

px	X coordinate to set.
py	Y coordinate to set.
pz	Z coordinate to set.
pIndex	Index of vertex to set(default=-1).

Returns: true if successful.

◆ VertexSetSelected()

bool VertexSetSelected	(	int	pIndex,
		bool	pState
	)

Set the selected state of a vertex.

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

◆ VertexSetVisible()

bool VertexSetVisible	(	int	pIndex,
		bool	pState
	)

Set the visible state of a vertex.

Parameters

pIndex	The index of the vertex
pState	true to be visible

Returns: true if the vertex is visible, false if not

◆ VertexUVGet()

FBUV VertexUVGet ( int pIndex = -1 )

Get a UV coordinate.

Parameters

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

Returns: UV coordinate of vertex at UVSetIndex.

◆ VertexUVSet() [1/2]

bool VertexUVSet	(	FBUV	pUV,
		int	pIndex = `-1`
	)

Set a UV coordinate.

Parameters

pUV	UV coordinate to set.
pIndex	Index of Vertex to affect with UV coordinate(default=-1).

Returns: true if successful.

◆ VertexUVSet() [2/2]

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

Set a UV coordinate.

Parameters

pU	U coordinate to set.
pV	V coordinate to set.
pIndex	Index of Vertex to affect with UV coordinate(default=-1).

Returns: true if successful.

Member Data Documentation

◆ BinormalMappingMode

FBGeometryMappingMode BinormalMappingMode

Read Only Property: Binormal mapping mode.

◆ BinormalReferenceMode

FBGeometryReferenceMode BinormalReferenceMode

Read Only Property: Binormal reference mode.

◆ MaterialMappingMode

FBGeometryMappingMode MaterialMappingMode

Read Property: Material mapping mode.

◆ NormalMappingMode

FBGeometryMappingMode NormalMappingMode

Read Only Property: Normal mapping mode.

◆ NormalReferenceMode

FBGeometryReferenceMode NormalReferenceMode

Read Only Property: Normal reference mode.

◆ TangentMappingMode

FBGeometryMappingMode TangentMappingMode

Read Only Property: Tangent mapping mode.

◆ TangentReferenceMode

FBGeometryReferenceMode TangentReferenceMode

Read Only Property: Tangent reference mode.

◆ VertexColorMappingMode

FBGeometryMappingMode VertexColorMappingMode

Read Only Property: Vertex Color mapping mode.

◆ VertexColorReferenceMode

FBGeometryReferenceMode VertexColorReferenceMode

Read Only Property: Vertex Color reference mode.

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ GeometryBegin()

◆ GeometryEnd()

◆ GetBinormalsDirectArray()

◆ GetBinormalsIndexArray()

◆ GetMaterialIndexArray()

◆ GetNormalsDirectArray()

◆ GetNormalsIndexArray()

◆ GetPositionsArray()

◆ GetTangentsDirectArray()

◆ GetTangentsIndexArray()

◆ GetUVSetDirectArray()

◆ GetUVSetIndexArray()

◆ GetUVSetMappingMode()

◆ GetUVSetReferenceMode()

◆ GetUVSets()

◆ GetVertexColorsDirectArray()

◆ GetVertexColorsIndexArray()

◆ ShapeAdd()

◆ ShapeClearAll()

◆ ShapeGetCount()

◆ ShapeGetName()

◆ ShapeInit()

◆ ShapeSetDiffPoint() [1/2]

◆ ShapeSetDiffPoint() [2/2]

◆ VertexAdd() [1/8]

◆ VertexAdd() [2/8]

◆ VertexAdd() [3/8]

◆ VertexAdd() [4/8]

◆ VertexAdd() [5/8]

◆ VertexAdd() [6/8]

◆ VertexAdd() [7/8]

◆ VertexAdd() [8/8]

◆ VertexArrayClear()

◆ VertexArrayInit()

◆ VertexClear()

◆ VertexColorGet()

◆ VertexColorSet() [1/2]

◆ VertexColorSet() [2/2]

◆ VertexCount()

◆ VertexGet()

◆ VertexGetSelected()

◆ VertexGetTransformable()

◆ VertexGetVisible()

◆ VertexInit()

◆ VertexNormalGet()

◆ VertexNormalSet() [1/2]

◆ VertexNormalSet() [2/2]

◆ VertexSet() [1/2]

◆ VertexSet() [2/2]

◆ VertexSetSelected()

◆ VertexSetVisible()

◆ VertexUVGet()

◆ VertexUVSet() [1/2]

◆ VertexUVSet() [2/2]

Member Data Documentation

◆ BinormalMappingMode

◆ BinormalReferenceMode

◆ MaterialMappingMode

◆ NormalMappingMode

◆ NormalReferenceMode

◆ TangentMappingMode

◆ TangentReferenceMode

◆ VertexColorMappingMode

◆ VertexColorReferenceMode