Python Reference Guide
FBGeometry Class Reference

Geometry class. More...

Inheritance diagram for FBGeometry:

Public Member Functions

bool GeometryBegin ()
 Begin geometry editing. More...
 
bool GeometryEnd ()
 End geometry editing. More...
 
FBNormal GetBinormalsDirectArray (int pOutArrayCount)
 Get a pointer to the direct array of binormals. More...
 
int GetBinormalsIndexArray (int pOutArrayCount)
 Get a pointer to the index array of binormals. More...
 
int GetMaterialIndexArray (int pOutArrayCount)
 Get a pointer to the index array of Material. More...
 
FBNormal GetNormalsDirectArray (int pOutArrayCount)
 Get a pointer to the direct array of normals. More...
 
int GetNormalsIndexArray (int pOutArrayCount)
 Get a pointer to the index array of normals. More...
 
FBVertex GetPositionsArray (int pOutArrayCount)
 Get a pointer to the position array. More...
 
FBNormal GetTangentsDirectArray (int pOutArrayCount)
 Get a pointer to the direct array of tangents. More...
 
int GetTangentsIndexArray (int pOutArrayCount)
 Get a pointer to the index array of tangents. More...
 
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. More...
 
int GetUVSetIndexArray (int pOutArrayCount, str pUVSetName=None)
 Get a pointer to the index array of UVset. More...
 
FBGeometryMappingMode GetUVSetMappingMode (str pUVSetName=None)
 Get UVSet mapping mode. More...
 
FBGeometryReferenceMode GetUVSetReferenceMode (str pUVSetName=None)
 Get UVSet reference mode. More...
 
FBStringList GetUVSets ()
 Get available UVSet name. More...
 
FBColorF GetVertexColorsDirectArray (int pOutArrayCount)
 Get a pointer to the direct array of vertex color. More...
 
int GetVertexColorsIndexArray (int pOutArrayCount)
 Get a pointer to the index array of vertex color. More...
 
int ShapeAdd (str pName)
 Add new shape. More...
 
 ShapeClearAll ()
 Clears all the shapes. More...
 
int ShapeGetCount ()
 Get Shape Count. More...
 
str ShapeGetName (int pShapeIdx)
 Return the shape Name. More...
 
 ShapeInit (int pShapeIdx, int pDiffSize, bool pWithNormal=False)
 Init the shape. More...
 
bool ShapeSetDiffPoint (int pShapeIdx, int pDiffIndex, int pOriIndex, FBVertex pPosDiff)
 Set the differentiate point. More...
 
bool ShapeSetDiffPoint (int pShapeIdx, int pDiffIndex, int pOriIndex, FBVertex pPosDiff, FBNormal pNormalDiff)
 Set the differentiate point. More...
 
int VertexAdd (FBVertex pVertex)
 Add a vertex. More...
 
int VertexAdd (FBVertex pVertex, FBNormal pNormal)
 Add a vertex. More...
 
int VertexAdd (FBVertex pVertex, FBNormal pNormal, FBUV pUV)
 Add a vertex. More...
 
int VertexAdd (FBVertex pVertex, FBNormal pNormal, FBUV pUV, FBColorF pVertexColor)
 Add a vertex. More...
 
int VertexAdd (float px, float py, float pz)
 Add a vertex. More...
 
int VertexAdd (float px, float py, float pz, float nx, float ny, float nz)
 Begin geometry editing. More...
 
int VertexAdd (float px, float py, float pz, float nx, float ny, float nz, float UVu, float UVv)
 Begin geometry editing. More...
 
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. More...
 
bool VertexArrayClear ()
 Clear all geometry vertex arrays. More...
 
bool VertexArrayInit (int pVertexcount, bool pUniqueMaterial, unsigned int pFBGeometryArrayIDs=0)
 Init geometry vertex arrays. More...
 
bool VertexClear ()
 Clear all Vertex arrays. More...
 
FBColorF VertexColorGet (int pIndex=-1)
 Get a Vertex Color. More...
 
bool VertexColorSet (FBColorF pColor, int pIndex=-1)
 Set a Vertex Color. More...
 
bool VertexColorSet (float pRed, float pGreen, float pBlue, float pAlpha, int pIndex=-1)
 Set a UV coordinate. More...
 
int VertexCount ()
 Get the number of vertices in the geometry. More...
 
FBVertex VertexGet (int pIndex)
 Get a vertex. More...
 
bool VertexGetSelected (int pIndex)
 Get the selected state of a vertex. More...
 
bool VertexGetTransformable (int pIndex)
 Get the Transformable state of a vertex. More...
 
bool VertexGetVisible (int pIndex)
 Get the visible state of a vertex. More...
 
 VertexInit (int pSize, bool pResize, bool pInitUV=True, bool pInitVertexColor=False)
 Resize or Reserve vertex, normal and UV array for performance. More...
 
FBNormal VertexNormalGet (int pIndex=-1)
 Get a normal at a vertex. More...
 
bool VertexNormalSet (FBNormal pVertex, int pIndex=-1)
 Set a normal at a vertex. More...
 
bool VertexNormalSet (float px, float py, float pz, int pIndex=-1)
 Set a normal at a vertex. More...
 
bool VertexSet (FBVertex pVertex, int pIndex=-1)
 Set a vertex. More...
 
bool VertexSet (float px, float py, float pz, int pIndex=-1)
 Set a vertex. More...
 
bool VertexSetSelected (int pIndex, bool pState)
 Set the selected state of a vertex. More...
 
bool VertexSetVisible (int pIndex, bool pState)
 Set the visible state of a vertex. More...
 
FBUV VertexUVGet (int pIndex=-1)
 Get a UV coordinate. More...
 
bool VertexUVSet (FBUV pUV, int pIndex=-1)
 Set a UV coordinate. More...
 
bool VertexUVSet (float pU, float pV, int pIndex=-1)
 Set a UV coordinate. More...
 
- Public Member Functions inherited from FBComponent
 FBComponent ()
 Constructor. More...
 
str ClassName ()
 Get the class name. More...
 
 DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags. More...
 
 EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags. More...
 
bool FBCreate ()
 Open Reality Creation function. More...
 
 FBDelete ()
 Open Reality deletion function. More...
 
 FBDestroy ()
 Open Reality destruction function. More...
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated). More...
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled. More...
 
FBFileReference GetOwnerFileReference (p0)
 Get the owner FileReference object. More...
 
 HardSelect ()
 HardSelect. More...
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled. More...
 
bool Is (int pTypeId)
 Returns true if object is of type TypeId. More...
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessNamespaceHierarchy. More...
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessObjectNamespace. More...
 
int PropertyAdd (FBProperty pProperty)
 Add a property to the component's property manager. More...
 
bool PropertyAddReferenceProperty (FBProperty pReferenceProperty)
 Add a reference property to the component's property manager. More...
 
FBProperty PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
 Create user or dynamic property. More...
 
 PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading. More...
 
 PropertyRemove (FBProperty pProperty)
 Remove a Property from the component's Property manager. More...
 
 SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags. More...
 
 SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status. More...
 

Public Attributes

FBGeometryMappingMode BinormalMappingMode
 Read Only Property: Binormal mapping mode.
More...
 
FBGeometryReferenceMode BinormalReferenceMode
 Read Only Property: Binormal reference mode.
More...
 
FBGeometryMappingMode MaterialMappingMode
 Read Property: Material mapping mode.
More...
 
FBGeometryMappingMode NormalMappingMode
 Read Only Property: Normal mapping mode.
More...
 
FBGeometryReferenceMode NormalReferenceMode
 Read Only Property: Normal reference mode.
More...
 
FBGeometryMappingMode TangentMappingMode
 Read Only Property: Tangent mapping mode.
More...
 
FBGeometryReferenceMode TangentReferenceMode
 Read Only Property: Tangent reference mode.
More...
 
FBGeometryMappingMode VertexColorMappingMode
 Read Only Property: Vertex Color mapping mode.
More...
 
FBGeometryReferenceMode VertexColorReferenceMode
 Read Only Property: Vertex Color reference mode.
More...
 
- Public Attributes inherited from FBComponent
FBListComponent Components
 List: List of components.
More...
 
str LongName
 Read Write Property: Name and namespace for object.
More...
 
str Name
 Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py. More...
 
FBListComponent Parents
 List: Parents.
More...
 
FBManager PropertyList
 Read Only Property: Manages all of the properties for the component.
More...
 
bool Selected
 Read Write Property: Selected property.
More...
 
int TypeInfo
 Contains the Type information of the object.
More...
 
- Public Attributes inherited from FBPlug
str ClassGroupName
 ClassGroupName of the object.
More...
 
int TypeInfo
 TypeInfo.
More...
 

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
pOutArrayCountTo 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
pOutArrayCountTo 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
pOutArrayCountTo 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
pOutArrayCountTo 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
pOutArrayCountTo 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
pOutArrayCountTo 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
pOutArrayCountTo 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
pOutArrayCountTo 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
pOutArrayCountTo return the length the array.
pUVSetNameThe 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
pOutArrayCountTo return the length the array.
pUVSetNameThe 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
pUVSetNameThe 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
pUVSetNameThe 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
pOutArrayCountTo 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
pOutArrayCountTo 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
pNamethe 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
pShapeIdxThe index of the shape to be initialized
pDiffSizeTotal number of different point (pos or normal) compared to base geometry.
pWithNormalCurrently 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
pShapeIdxThe index of the shape
pDiffIndexThe index of the diff point in this shape.
pOriIndexThe index of the diff point in the original geometry.
pPosDiffThe position differentiation.

◆ ShapeSetDiffPoint() [2/2]

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

Set the differentiate point.

Parameters
pShapeIdxThe index of the shape
pDiffIndexThe index of the diff point in this shape.
pOriIndexThe index of the diff point in the original geometry.
pPosDiffThe position differentiation.
pNormalDiffThe normal differentiation.

◆ VertexAdd() [1/8]

int VertexAdd ( FBVertex  pVertex)

Add a vertex.

Parameters
pVertexVertex 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
pVertexVertex values used to add vertex.
pNormalNormal 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
pVertexVertex values used to add vertex.
pNormalNormal values used to add vertex.
pUVUV 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
pVertexVertex values used to add vertex.
pNormalNormal values used to add vertex.
pUVUV values used to add vertex.
pVertexColorColor 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
pxX coordinate of vertex to add.
pyY coordinate of vertex to add.
pzZ 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
pVertexcountnumber of control points (vertex)
pUniqueMaterialUser could specify per polygon mapping mode for mesh
pFBGeometryArrayIDsRequest 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
pIndexIndex 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
pColorVertex Color to set.
pIndexIndex 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
pRedRed Color Channel to set, range [0, 1].
pGreenGreen Color Channel to set, range [0, 1].
pBlueBlue Color Channel to set, range [0, 1].
pAlphaAlpha Color Channel to set, range [0, 1].
pIndexIndex 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
pIndexIndex of vertex to get.
Returns
Vertex stored at pIndex.

◆ VertexGetSelected()

bool VertexGetSelected ( int  pIndex)

Get the selected state of a vertex.

Parameters
pIndexThe 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
pIndexThe 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
pIndexThe 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
pSizeNumber of vertices to resize or reserve.
pResizeTrue, 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.
pInitUVinit Vertex UV array if true
pInitVertexColorInit Vertex Color Array if true.

◆ VertexNormalGet()

FBNormal VertexNormalGet ( int  pIndex = -1)

Get a normal at a vertex.

Parameters
pIndexVertex 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
pVertexNormal to set.
pIndexIndex 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
pxX coordinate of normal.
pyY coordinate of normal.
pzZ coordinate of normal.
pIndexIndex 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
pVertexVertex values used to set vertex.
pIndexIndex 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
pxX coordinate to set.
pyY coordinate to set.
pzZ coordinate to set.
pIndexIndex 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
pIndexThe index of the vertex
pStateThe 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
pIndexThe index of the vertex
pStatetrue to be visible
Returns
true if the vertex is visible, false if not

◆ VertexUVGet()

FBUV VertexUVGet ( int  pIndex = -1)

Get a UV coordinate.

Parameters
pIndexIndex 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
pUVUV coordinate to set.
pIndexIndex 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
pUU coordinate to set.
pVV coordinate to set.
pIndexIndex 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.