This reference page is linked to from the following overview topics: Supported Scene Elements, Feature-Oriented Programs, Connections, Customizing the FBX SDK, Nodes and the Scene Graph, FBX Nodes, FBX Node Attributes, Geometry, Meshes, Materials and Textures, Meshes, Instancing - Sharing a Mesh, Materials, List of Python FBX classes.

Detailed Description

A mesh is a geometry made of polygons.

The class can define a geometry with as many n-sided polygons as needed. Users can freely mix triangles, quadrilaterals, and other polygons. Since the mesh-related terminology of the FBX SDK differs a little from the known standards, here are our definitions:

A control point is an XYZ coordinate, it is synonym of vertex.
A polygon vertex is an index to a control point (the same control point can be referenced by multiple polygon vertices).
A polygon is a group of polygon vertices. The minimum valid number of polygon vertices to define a polygon is 3.

Methods to initialize, set and access control points are provided in the KFbxGeometryBase class.

Examples:: Common/GeometryUtility.cxx, ExportDocument/main.cxx, ExportScene03/main.cxx, ExportScene03/MyKFbxMesh.cxx, ExportScene03/MyKFbxMesh.h, ImportScene/DisplayMesh.cxx, Instances/main.cxx, Layers/main.cxx, Normals/main.cxx, ProceduralTexture/main.cxx, SwitchBinding/main.cxx, UIExamples/CubeCreator/SDK_Utility.cxx, UIExamples/CubeCreator/SDK_Utility.h, UserProperties/main.cxx, UVSample/main.cxx, ViewScene/DrawScene.cxx, ViewScene/GlFunctions.cxx, and ViewScene/GlFunctions.h.

Definition at line 65 of file kfbxmesh.h.

#include <kfbxmesh.h>

Inheritance diagram for KFbxMesh:

[legend]

List of all members.

Classes
class	KDuplicateVertex
	Internal structure used to keep the duplicate vertex information. More...
struct	KFbxComponentMap
	Internal structure used to keep the mapping information between edges and polygons. More...
struct	KFbxEdgeLookup
struct	KFbxPolygon
struct	KFbxPolyIndex
struct	KFbxSplitEdgeData
struct	KFbxV2PVMap
class	KVertexNormalInfo
	Internal structure used to compute the normals on a mesh. More...
Public Member Functions
virtual EAttributeType	GetAttributeType () const
	Return the type of node attribute.
void	ReservePolygonCount (int pCount)
	Reserve memory in the polygon array to hold the specified number of polygons.
void	ReservePolygonVertexCount (int pCount)
	Reserve memory in the polygon vertex array to hold the specified number of polygon vertices.
bool	GetTextureUV (KFbxLayerElementArrayTemplate< KFbxVector2 > **pLockableArray, KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES) const
bool	GetMaterialIndices (KFbxLayerElementArrayTemplate< int > **pLockableArray) const
bool	GetTextureIndices (KFbxLayerElementArrayTemplate< int > **pLockableArray, KFbxLayerElement::ELayerElementType pTextureType) const
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
Public Attributes
KArrayTemplate< KFbxPolygon >	mPolygons
KArrayTemplate< int >	mPolygonVertices
KArrayTemplate< int >	mEdgeArray
Protected Member Functions
void	InitTextureIndices (KFbxLayerElementTexture *pLayerElementTexture, KFbxLayerElement::EMappingMode pMappingMode)
void	RemoveTextureIndex (KFbxLayerElementTexture *pLayerElementTextures, int pPolygonIndex, int pOffset)
void	RemoveUVIndex (KFbxLayerElementUV *pLayerElementUV, int pPolygonIndex, int pOffset)
K_DEPRECATED bool	IsBadPoly (int pPolygonIndex) const
bool	GetBadPolyIndices (KArrayTemplate< int > &pArrayBadPolyIndices, bool pCheckOne) const
	Get bad polygon indices in one mesh.
	KFbxMesh (KFbxSdkManager &pManager, char const *pName)
virtual void	Destruct (bool pRecursive, bool pDependents)
int	FindPolygonIndex (int pEdgeIndex)
void	PolySetTexture (KFbxLayer *pLayer, int pTextureIndex, KFbxLayerElement::ELayerElementType pTextureType)
template<class T >
bool	GetPolygonVertexLayerElementValue (const KFbxLayerElementTemplate< T > *pLayerElement, int pPolyIndex, int pVertexIndex, T &pValue) const
Static Protected Member Functions
static int	PolygonIndexCompare (const void p1, const void p2)
Protected Attributes
EMeshSmoothness	mSmoothness
int	mPreviewDivisionLevels
int	mRenderDivisionLevels
bool	mDisplaySubdivisions
EBoundaryRule	mBoundaryRule
bool	mPreserveBorders
bool	mPreserveHardEdges
bool	mPropagateEdgeHardness
KFbxV2PVMap	mV2PVMap
KFbxEdgeLookup	mPVEndFlags
Friends
class	KFbxGeometryConverter
class	KFbxWriter3DS
Polygon Management
void	BeginPolygon (int pMaterial=-1, int pTexture=-1, int pGroup=-1, bool pLegacy=true)
	Begins the process of adding a polygon to the mesh.
void	BeginPolygonExt (int pMaterial, int *pTextures)
	Begin writing a polygon.
void	AddPolygon (int pIndex, int pTextureUVIndex=-1)
	Add a polygon vertex to the current polygon.
void	EndPolygon ()
	End writing a polygon, it should be called after adding one polygon.
int	GetPolygonCount () const
	Get the polygon count of this mesh.
int	GetPolygonSize (int pPolygonIndex) const
	Get the number of polygon vertices in a polygon.
int	GetPolygonGroup (int pPolygonIndex) const
	Get the current group ID of the specified polygon.
void	SetPolygonGroup (int pPolygonIndex, int pGroup) const
	Assign the specified polygon a group ID.
int	GetPolygonVertex (int pPolygonIndex, int pPositionInPolygon) const
	Get a polygon vertex (i.e: an index to a control point).
bool	GetPolygonVertexNormal (int pPolyIndex, int pVertexIndex, KFbxVector4 &pNormal) const
	Get the normal associated with the specified polygon vertex.
bool	GetPolygonVertexNormals (KArrayTemplate< KFbxVector4 > &pNormals) const
	Get the normals associated with the mesh for every polygon vertex.
bool	GetPolygonVertexUV (int pPolyIndex, int pVertexIndex, const char *pUVSetName, KFbxVector2 &pUV) const
	Get the UV associated with the specified polygon vertex.
bool	GetPolygonVertexUVs (const char *pUVSetName, KArrayTemplate< KFbxVector2 > &pUVs) const
	Get the UVs associated with the mesh for every polygon vertex.
int *	GetPolygonVertices () const
	Get the array of polygon vertices (i.e: indices to the control points).
int	GetPolygonVertexCount () const
	Gets the number of polygon vertices in the mesh.
int	GetPolygonVertexIndex (int pPolygonIndex) const
	Gets the start index into the array returned by GetPolygonVertices() for the given polygon.
int	RemovePolygon (int pPolygonIndex)
	Remove the specified polygon from the mesh.
int	RemoveDuplicatedEdges (KArrayTemplate< int > &pEdgeIndexList)
	Remove the duplicated edges from the mesh.
Texture UV Utility Functions.
The methods found in this section are utility functions used to handle UV coordinates quickly.Internally, they refer to `KFbxLayer` and `KFbxLayerElementUV` methods to do the job. Except for the GetAllChannelUV(int pLayer), all the methods are implicitly working on Layer 0. Use the `KFbxLayer` methods to have access to the other layers.
void	InitTextureUV (int pCount, KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES)
	Init texture UV coordinates.
void	AddTextureUV (KFbxVector2 pUV, KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES)
	Add texture UV coordinates.
int	GetTextureUVCount (KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES)
	Get the number of texture UV coordinates.
int	GetUVLayerCount () const
	Get the number of layer containing at least one channel UVMap.
KArrayTemplate < KFbxLayerElement::ELayerElementType >	GetAllChannelUV (int pLayer)
	Fills an array describing, for the given layer, which texture channel have UVs associated to it.
Material, Texture and UV Indices Utility Functions.
The methods found in this section are utility functions used to handle Material, Texture and UV indices quickly.Internally, they refer to `KFbxLayer` and `KFbxLayerElementUV` methods to do the job. These functions are only working on Layer 0. Use the `KFbxLayer` methods directly to access other layers.
void	InitMaterialIndices (KFbxLayerElement::EMappingMode pMappingMode)
	Initialize material indices.
void	InitTextureIndices (KFbxLayerElement::EMappingMode pMappingMode, KFbxLayerElement::ELayerElementType pTextureType)
	Initialize texture indices.
void	InitTextureUVIndices (KFbxLayerElement::EMappingMode pMappingMode, KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES)
	Initialize texture UV indices.
int	GetTextureUVIndex (int pPolygonIndex, int pPositionInPolygon, KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES)
	Get a texture UV index associated with a polygon vertex (i.e: an index to a control point).
void	SetTextureUVIndex (int pPolygonIndex, int pPositionInPolygon, int pIndex, KFbxLayerElement::ELayerElementType pTypeIdentifier)
	Set a texture UV index associated with a polygon vertex (i.e: an index to a control point).
Utility functions
enum	ESplitObject { eBY_NORMAL }
	Object of interest when splitting. More...
void	Reset ()
	Reset the mesh to default values.
void	ComputeVertexNormals (bool pCW=false)
	Compute the vertex normals on the mesh.
bool	CheckIfVertexNormalsCCW ()
	Compares the normals calculated by doing cross-products between the polygon vertex and by the ones stored in the normal array.
bool	CheckSamePointTwice () const
	Verify if the mesh has polygons that are defined on the same point more than once.
int	RemoveBadPolygons ()
	Remove bad polygons from a mesh.
Point Splitting/Merging utility functions
bool	SplitPoints (KFbxLayerElement::ELayerElementType pTypeIdentifier=KFbxLayerElement::eDIFFUSE_TEXTURES)
	Split points.
bool	BuildMergeList (KArrayTemplate< int > &pMergeList, ESplitObject pObject, bool pExport=false)
	Insert the new indexes of the object that have to be merged.
void	MergePointsForPolygonVerteNormals (KArrayTemplate< int > &pMergeList)
	Merge the points specified in the list.
Edge management functions
void	BuildMeshEdgeArray ()
	Automatically generate edge data for the mesh.
int	GetMeshEdgeCount () const
	Query the number of edges defined on this mesh.
int	GetMeshEdgeIndex (int pStartVertexIndex, int pEndVertexIndex, bool &pReversed, int pExistedEdgeCount=-1)
	Get the index for the edge between the given vertices.
int	GetMeshEdgeIndexForPolygon (int pPolygon, int pPositionInPolygon)
	Get the index for the specific edge of pPolygon.
void	GetMeshEdgeVertices (int pEdgeIndex, int &pStartVertexIndex, int &pEndVertexIndex) const
	Get the vertices for the given edge.
void	BeginGetMeshEdgeVertices ()
	Use this method before calling GetMeshEdgeVertices if making several calls to that method.
void	EndGetMeshEdgeVertices ()
	Use this method after calling GetMeshEdgeVertices if making several calls to that method.
void	SetMeshEdgeCount (int pEdgeCount)
	Presets the number edge data elements.
void	SetMeshEdge (int pEdgeIndex, int pValue)
	Sets element in edge array to specific value.
int	AddMeshEdgeIndex (int pStartVertexIndex, int pEndVertexIndex, bool pCheckForDuplicates)
	Add an edge with the given start/end points.
int	SetMeshEdgeIndex (int pEdgeIndex, int pStartVertexIndex, int pEndVertexIndex, bool pCheckForDuplicates, int pExistedEdgeCount=-1)
	Set the index for the edge with the given start/end points.
void	BeginAddMeshEdgeIndex ()
	Call this before calling AddMeshEdgeIndex or SetMeshEdgeIndex to increase performance.
void	EndAddMeshEdgeIndex ()
	After calling AddMeshEdgeIndex or SetMeshEdgeIndex, EndAddMeshEdgeIndex should be called.
int	AddMeshEdgeIndexForPolygon (int pPolygonIndex, int pPositionInPolygon)
	Adds an edge for the specified polygon, and edge number within the polygon.
bool	SetMeshEdgeIndex (int pEdgeIndex, int pPolygonIndex, int pPositionInPolygon)
	Sets the specified edge to the specified polygon's edge.
void	ComputeComponentMaps (KFbxComponentMap &pEdgeToPolyMap, KFbxComponentMap &pPolyToEdgeMap)
	Compute component maps.
bool	IsTriangleMesh () const
	Determines if the mesh is composed entirely of triangles.
Crease utility functions
double	GetEdgeCreaseInfo (int pEdgeIndex)
	Get crease weight by edge index.
bool	GetEdgeCreaseInfoArray (KFbxLayerElementArrayTemplate< double > **pCreaseArray)
	Get crease edge array.
double	GetVertexCreaseInfo (int pVertexIndex)
	Get crease weight by vertex index.
bool	GetVertexCreaseInfoArray (KFbxLayerElementArrayTemplate< double > **pCreaseArray)
	Get vertex crease array.
bool	SetEdgeCreaseInfo (int pEdgeIndex, double pWeight)
	Set crease weight by edge index.
bool	SetEdgeCreaseInfoArray (KArrayTemplate< double > *pWeightArray)
	Set crease weight data array.
bool	SetVertexCreaseInfo (int pVertexIndex, double pWeight)
	Set crease weight by vertex index.
bool	SetVertexCreaseInfoArray (KArrayTemplate< double > *pWeightArray)
	Set crease weight data array.
Smooth mesh preview utility functions
enum	EMeshSmoothness { eHULL, eROUGH, eMEDIUM, eFINE }
	Display Smoothness. More...
enum	EBoundaryRule { eLEGACY, eCREASE_ALL, eCREASE_EDGES }
	the boundary rule. More...
KFbxMesh::EMeshSmoothness	GetMeshSmoothness () const
	Get display smoothness from mesh.
void	SetMeshSmoothness (KFbxMesh::EMeshSmoothness pSmoothness)
	Set the mesh display smoothness mode.
int	GetMeshPreviewDivisionLevels () const
	Get preview subdivision levels from mesh.
void	SetMeshPreviewDivisionLevels (int pPreviewDivisionLevels)
	Set mesh preview subdivision levels.
int	GetMeshRenderDivisionLevels () const
	Get render subdivision levels from mesh.
void	SetMeshRenderDivisionLevels (int pRenderDivisionLevels)
	Set mesh render subdivision levels.
bool	GetDisplaySubdivisions () const
	Query whether to display subdivisions isolines on mesh.
void	SetDisplaySubdivisions (bool pDisplySubdivisions)
	Set the DisplySubdivisions state.
EBoundaryRule	GetBoundaryRule () const
	Get BoundaryRule from mesh.
void	SetBoundaryRule (EBoundaryRule pBoundaryRule)
	Set BoundaryRule for this mesh.
bool	GetPreserveBorders () const
	Query whether to preserve borders when preview smooth mesh is enabled.
void	SetPreserveBorders (bool pPreserveBorders)
	Set the state of the PreserveBorders flag.
bool	GetPreserveHardEdges () const
	Query whether to preserve hard edges when preview smooth mesh.
void	SetPreserveHardEdges (bool pPreserveHardEdges)
	Set the state of the PreserveHardEdges flag.
bool	GetPropagateEdgeHardness () const
	Query whether to PropagateEdgeHardness when preview smooth mesh.
void	SetPropagateEdgeHardness (bool pPropagateEdgeHardness)
	Set state of the PropagateEdgeHardness flag.
Hole utility functions
bool	GetPolyHoleInfo (int pFaceIndex)
	Get hole flag by face index (an index to a polygon).
bool	GetPolyHoleInfoArray (KFbxLayerElementArrayTemplate< bool > **pHoleArray)
	Get hole flags Array.
bool	SetPolyHoleInfo (int pFaceIndex, bool pIsHole)
	Sets the flag indicating whether the face represents a hole or not.
bool	SetPolyHoleInfoArray (KArrayTemplate< bool > *pHoleArray)
	Set hole flags array.
Tangents data generate utility functions.
bool	GenerateTangentsData (KString pUVSetName="")
	Generate tangents data for UVSet with specific name.
bool	GenerateTangentsData (int pUVSetLayerIndex)
	Generate tangents data for UVSet in specific layer.
bool	GenerateTangentsDataForAllUVSets ()
	Generate tangents data for all UVSets in all layers.

eHULL	Default value, not active "smooth mesh preview". Search for all occurrences
eROUGH	Not active "smooth mesh preview". Search for all occurrences
eMEDIUM	Both display cage and smooth mesh. Search for all occurrences
eFINE	Display smooth mesh. Search for all occurrences

eLEGACY	Default value. Search for all occurrences
eCREASE_ALL	Used for hard corner. Search for all occurrences
eCREASE_EDGES	Used for round corner. Search for all occurrences

KFbxMesh	(	KFbxSdkManager &	pManager,
		char const *	pName
	)		`[protected]`

void BeginPolygon	(	int	pMaterial = `-1`,
		int	pTexture = `-1`,
		int	pGroup = `-1`,
		bool	pLegacy = `true`
	)

pMaterial	Index of material to assign to this polygon if material mapping type is eBY_POLYGON. Otherwise it must be `-1`.
pTexture	Index of texture to assign to this polygon if texture mapping type is eBY_POLYGON. Otherwise it must be `-1`.
pGroup	Group index assigned to polygon.
pLegacy	When set to `true`, automatically create a LayerElement of type Texture; This was the default behavior of earlier versions of the FBX SDK. Since version 2010, the textures are connected to the material object.

pMaterial	Index of material to assign to this polygon if material mapping type is eBY_POLYGON. Otherwise it must be `-1`.
pTextures	Array of index of texture (by texture type) to assign to this polygon if texture mapping type is eBY_POLYGON. Otherwise it must be an array of `-1`. This array is expected to be of size: KFbxLayerElement::LAYERELEMENT_TYPE_TEXTURE_COUNT. If one texture type is not used, the corresponding entry must be left at `-1`.

pIndex	Index in the table of the control points.
pTextureUVIndex	Index of texture UV coordinates to assign to this polygon if texture UV mapping type is eBY_POLYGON_VERTEX. Otherwise it must be `-1`.

void SetPolygonGroup	(	int	pPolygonIndex,
		int	pGroup
	)		const `[inline]`

pPolygonIndex	Index of the polygon.
pGroup	Group index assigned to the polygon.

int GetPolygonVertex	(	int	pPolygonIndex,
		int	pPositionInPolygon
	)		const `[inline]`

pPolygonIndex	Index of queried polygon. The valid range for this parameter is 0 to `KFbxMesh::GetPolygonCount()`.
pPositionInPolygon	Position of polygon vertex in indexed polygon. The valid range for this parameter is 0 to `KFbxMesh::GetPolygonSize(pPolygonIndex)`.

bool GetPolygonVertexNormal	(	int	pPolyIndex,
		int	pVertexIndex,
		KFbxVector4 &	pNormal
	)		const

pPolyIndex	Index of the polygon.
pVertexIndex	Index of the vertex in the polygon.
pNormal	The returned normal.

bool GetPolygonVertexUV	(	int	pPolyIndex,
		int	pVertexIndex,
		const char *	pUVSetName,
		KFbxVector2 &	pUV
	)		const

bool GetPolygonVertexUVs	(	const char *	pUVSetName,
		KArrayTemplate< KFbxVector2 > &	pUVs
	)		const

pUVSetName	The name of the UV set that contains the UVs.
pUVs	The returned UVs.

void InitTextureUV	(	int	pCount,
		KFbxLayerElement::ELayerElementType	pTypeIdentifier = `KFbxLayerElement::eDIFFUSE_TEXTURES`
	)

pCount	Number of texture UV elements.
pTypeIdentifier	Specifies which texture channel this UV refers to.

void AddTextureUV	(	KFbxVector2	pUV,
		KFbxLayerElement::ELayerElementType	pTypeIdentifier = `KFbxLayerElement::eDIFFUSE_TEXTURES`
	)

pUV	Texture UV coordinates, ranging between `0` and `1`.
pTypeIdentifier	Specifies which texture channel this UV refers to.

void InitTextureIndices	(	KFbxLayerElement::EMappingMode	pMappingMode,
		KFbxLayerElement::ELayerElementType	pTextureType
	)

KFbxMesh Class Reference

Detailed Description

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Polygon Management

Texture UV Utility Functions.

Material, Texture and UV Indices Utility Functions.

Utility functions

Point Splitting/Merging utility functions

Edge management functions

Crease utility functions

Smooth mesh preview utility functions

Hole utility functions

Tangents data generate utility functions.

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

void InitTextureUVIndices	(	KFbxLayerElement::EMappingMode	pMappingMode,
		KFbxLayerElement::ELayerElementType	pTypeIdentifier = `KFbxLayerElement::eDIFFUSE_TEXTURES`
	)

int GetTextureUVIndex	(	int	pPolygonIndex,
		int	pPositionInPolygon,
		KFbxLayerElement::ELayerElementType	pTypeIdentifier = `KFbxLayerElement::eDIFFUSE_TEXTURES`
	)

pPolygonIndex	Index of polygon. The valid range for this parameter is 0 to KFbxMesh::GetPolygonCount().
pPositionInPolygon	Position of polygon vertex in indexed polygon. The valid range for this parameter is 0 to KFbxMesh::GetPolygonSize(pPolygonIndex).
pTypeIdentifier	The texture channel the UVIndex refers to.

void SetTextureUVIndex	(	int	pPolygonIndex,
		int	pPositionInPolygon,
		int	pIndex,
		KFbxLayerElement::ELayerElementType	pTypeIdentifier
	)

bool BuildMergeList	(	KArrayTemplate< int > &	pMergeList,
		ESplitObject	pObject,
		bool	pExport = `false`
	)

pMergeList	The list that will contain the indexes of the objects to merge.
pObject	The object of interest of the merge.
pExport	If set to `true`, include the duplicate indexes in the merge list.

int GetMeshEdgeIndex	(	int	pStartVertexIndex,
		int	pEndVertexIndex,
		bool &	pReversed,
		int	pExistedEdgeCount = `-1`
	)

pStartVertexIndex	The starting point of the edge.
pEndVertexIndex	The ending point of the edge.
pReversed	flag will be set to true if the reverse edge is found, false otherwise.
pExistedEdgeCount	legal edge count in mEdgeArray

int GetMeshEdgeIndexForPolygon	(	int	pPolygon,
		int	pPositionInPolygon
	)

pPolygon	The polygon of interest.
pPositionInPolygon	The specific edge number in the polygon.