kfbxlayer.h File Reference

---

Detailed Description

Definition in file kfbxlayer.h.

#include <fbxfilesdk/components/kbaselib/kaydaradef_h.h>
#include <fbxfilesdk/components/kbaselib/kaydara.h>
#include <fbxfilesdk/components/kbaselib/klib/kstring.h>
#include <fbxfilesdk/components/kbaselib/klib/karrayul.h>
#include <fbxfilesdk/components/kbaselib/klib/kdebug.h>
#include <fbxfilesdk/kfbxmath/kfbxvector2.h>
#include <fbxfilesdk/kfbxmath/kfbxvector4.h>
#include <fbxfilesdk/kfbxplugins/kfbxcolor.h>
#include <fbxfilesdk/kfbxplugins/kfbxdatatypes.h>
#include <fbxfilesdk/kfbxplugins/kfbxstream.h>
#include <fbxfilesdk/fbxfilesdk_nsbegin.h>
#include <fbxfilesdk/fbxfilesdk_nsend.h>

Include dependency graph for kfbxlayer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	KFbxLayerElement
	KFbxLayerElement is the base class for Layer Elements. More...
class	LockAccessStatus
	Identifies what error occurs when the data arrays are manipulated. More...
class	KFbxLayerElementArray
	KFbxLayerElementArray is the base class for KFbxLayerElementArrayTemplate, it provides lock handling and data array manipulation of the data buffer for KFbxLayerElement. More...
class	KFbxLayerElementArrayTemplate
	KFbxLayerElementArrayTemplate provides data array manipulation of the data buffer for KFbxLayerElement. More...
class	KFbxLayerElementTemplate
	This class complements the KFbxLayerElement class. More...
class	KFbxLayerElementNormal
	Layer element for mapping Normals to a geometry. More...
class	KFbxLayerElementBinormal
	Layer element for mapping Binormals to a geometry. More...
class	KFbxLayerElementTangent
	Layer element for mapping Tangents to a geometry. More...
class	KFbxLayerElementMaterial
	Layer element for mapping Materials to a geometry. More...
class	KFbxLayerElementPolygonGroup
	Layer element for grouping related polygons together. More...
class	KFbxLayerElementUV
	Layer element for mapping UVs to a geometry. More...
class	KFbxLayerElementVertexColor
	Layer element for mapping Vertex Colors to a geometry. More...
class	KFbxLayerElementUserData
	Layer element for mapping custom user data to a geometry. More...
class	KFbxLayerElementSmoothing
	Layer element for indicating smoothness of components of a geometry. More...
class	KFbxLayerElementCrease
	Layer element for indicating crease of components of a geometry. More...
class	KFbxLayerElementVisibility
	Layer element for indicating if specified components are shown/hidden. More...
class	KFbxLayerElementTexture
	Layer element for mapping Textures to a geometry. More...
class	KFbxLayer
	KFbxLayer class provides a base for the layering mechanism. More...
Functions
template<class T>
KFbxLayerElementArrayTemplate < T > &	KFbxGetDirectArray (KFbxLayerElementUserData *pLayerElement, int pIndex, bool *pStatus)
	Returns the direct array with the given attribute index.
template<class T>
KFbxLayerElementArrayTemplate < T > const &	KFbxGetDirectArray (KFbxLayerElementUserData const *pLayerElement, int pIndex, bool *pStatus)
	Returns the direct array with the given attribute index.
template<class T>
KFbxLayerElementArrayTemplate < T > &	KFbxGetDirectArray (KFbxLayerElementUserData *pLayerElement, const char *pName, bool *pStatus)
	Returns the direct array with the given attribute name.The template type must match the attribute type with pName.
template<class T>
KFbxLayerElementArrayTemplate < T > const &	KFbxGetDirectArray (KFbxLayerElementUserData const *pLayerElement, const char *pName, bool *pStatus)
	Returns the direct array with the given attribute name.The template type must match the attribute type with pName.
Variables
const int	kNoMapping = -1
	Flag to indicate no direct array mapping for an index array element.

---

Function Documentation

KFbxLayerElementArrayTemplate< T > const & KFbxGetDirectArray	(	KFbxLayerElementUserData const *	pLayerElement,
		const char *	pName,
		bool *	pStatus
	)			[inline]

Returns the direct array with the given attribute name.The template type must match the attribute type with pName.

Parameters:

	pLayerElement	The layer element whose direct array to return.
	pName	The given attribute name.
	pStatus	Will be set to false if accessing the direct array encounters an error.

Returns:

If pStatus receives true, the direct array at the given index is returned. Otherwise the return value is undefined.

Definition at line 1938 of file kfbxlayer.h.

References KFbxLayerElementUserData::GetDirectArrayVoid().

KFbxLayerElementArrayTemplate< T > & KFbxGetDirectArray	(	KFbxLayerElementUserData *	pLayerElement,
		const char *	pName,
		bool *	pStatus
	)			[inline]

Returns the direct array with the given attribute name.The template type must match the attribute type with pName.

Parameters:

	pLayerElement	The layer element whose direct array to return.
	pName	The given attribute name.
	pStatus	Will be set to false if accessing the direct array encounters an error.

Returns:

If pStatus receives true, the direct array at the given index is returned. Otherwise the return value is undefined.

Definition at line 1925 of file kfbxlayer.h.

References KFbxLayerElementUserData::GetDirectArrayVoid().

KFbxLayerElementArrayTemplate< T > const & KFbxGetDirectArray	(	KFbxLayerElementUserData const *	pLayerElement,
		int	pIndex,
		bool *	pStatus
	)			[inline]

Returns the direct array with the given attribute index.

The template type must match the attribute type at pIndex.

Parameters:

	pLayerElement	The layer element whose direct array to return.
	pIndex	The direct array index
	pStatus	Will be set to false if accessing the direct array encounters an error.

Returns:

If pStatus receives true, the direct array at the given index is returned. Otherwise the return value is undefined.

Definition at line 1911 of file kfbxlayer.h.

References KFbxLayerElementUserData::GetDirectArrayVoid().

KFbxLayerElementArrayTemplate< T > & KFbxGetDirectArray	(	KFbxLayerElementUserData *	pLayerElement,
		int	pIndex,
		bool *	pStatus
	)			[inline]

Returns the direct array with the given attribute index.

The template type must match the attribute type at pIndex.

Parameters:

	pLayerElement	The layer element whose direct array to return.
	pIndex	The direct array index
	pStatus	Will be set to false if accessing the direct array encounters an error.

Returns:

If pStatus receives true, the direct array at the given index is returned. Otherwise the return value is undefined.

Definition at line 1898 of file kfbxlayer.h.

References KFbxLayerElementUserData::GetDirectArrayVoid().

---

Variable Documentation

const int kNoMapping = -1

Flag to indicate no direct array mapping for an index array element.

Definition at line 1461 of file kfbxlayer.h.