kfbxlayer.h File Reference

---

Detailed Description

Definition in file kfbxlayer.h.

#include <kaydaradef.h>
#include <kaydara.h>
#include <klib/kstring.h>
#include <klib/karrayul.h>
#include <klib/kdebug.h>
#include <kbaselib_nsuse.h>
#include <kfbxmath/kfbxvector2.h>
#include <kfbxmath/kfbxvector4.h>
#include <kfbxplugins/kfbxcolor.h>
#include <kfbxplugins/kfbxtypes.h>
#include <fbxfilesdk_nsbegin.h>
#include <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	KFbxLayerElementTemplate
	This class complements the KFbxLayerElement class. More...
class	KFbxLayerElementUserData
class	KFbxLayerElementSmoothing
	Layer to indicate smoothness of components of a geometry. More...
class	KFbxLayerElementTexture
	Layer to map Textures on a geometry. More...
class	KFbxLayer
	KFbxLayer class provides the base for the layering mechanism. More...
Defines
#define	KFBX_DLL   K_DLLIMPORT
Typedefs
typedef K_DLLIMPORT KFbxLayerElementTemplate< KFbxVector4 >	KFbxLayerElementNormal
	Layer to map Normals on a geometry.
typedef K_DLLIMPORT KFbxLayerElementTemplate< KFbxSurfaceMaterial * >	KFbxLayerElementMaterial
	Layer to map Materials on a geometry.
typedef K_DLLIMPORT KFbxLayerElementTemplate< int >	KFbxLayerElementPolygonGroup
	Layer to group related polygons together.
typedef K_DLLIMPORT KFbxLayerElementTemplate< KFbxVector2 >	KFbxLayerElementUV
	Layer to map UVs on a geometry.
typedef K_DLLIMPORT KFbxLayerElementTemplate< KFbxColor >	KFbxLayerElementVertexColor
	Layer to map Vertex Colors on a geometry.
typedef K_DLLIMPORT KFbxLayerElementTemplate< bool >	KFbxLayerElementVisibility
	To indicate if specified components are shown/hidden.
typedef K_DLLIMPORT KFbxLayerElementTemplate< KFbxTexture * >	KFbxLayerElementTextureBase
Functions
template<class T>
KArrayTemplate< T > &	KFbxGetDirectArray (KFbxLayerElementUserData *pLayerElement, int pIndex, bool *pStatus)
	Access the direct array at pIndex.
template<class T>
KArrayTemplate< T > &	KFbxGetDirectArray (KFbxLayerElementUserData *pLayerElement, const char *pName, bool *pStatus)
	Gets the direct array with the given attribute name.
Variables
const int	kNoMapping = -1
	Flag to indicate no direct array mapping for an index array element.

---

Typedef Documentation

typedef class K_DLLIMPORT KFbxLayerElementTemplate<KFbxSurfaceMaterial*> KFbxLayerElementMaterial

Layer to map Materials on a geometry.

Definition at line 310 of file kfbxlayer.h.

typedef class K_DLLIMPORT KFbxLayerElementTemplate<KFbxVector4> KFbxLayerElementNormal

Layer to map Normals on a geometry.

Definition at line 305 of file kfbxlayer.h.

typedef class K_DLLIMPORT KFbxLayerElementTemplate<int> KFbxLayerElementPolygonGroup

Layer to group related polygons together.

Definition at line 315 of file kfbxlayer.h.

typedef class K_DLLIMPORT KFbxLayerElementTemplate<KFbxVector2> KFbxLayerElementUV

Layer to map UVs on a geometry.

Definition at line 320 of file kfbxlayer.h.

typedef class K_DLLIMPORT KFbxLayerElementTemplate<KFbxColor> KFbxLayerElementVertexColor

Layer to map Vertex Colors on a geometry.

Definition at line 325 of file kfbxlayer.h.

typedef class K_DLLIMPORT KFbxLayerElementTemplate<bool> KFbxLayerElementVisibility

To indicate if specified components are shown/hidden.

Definition at line 682 of file kfbxlayer.h.

---

Function Documentation

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

Gets the direct array with the given attribute name.

Definition at line 649 of file kfbxlayer.h.

References KFbxLayerElementUserData::GetDirectArrayVoid().

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

Access the direct array at pIndex.

The template type must match the attribute type at pIndex.

Parameters:

	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 641 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 329 of file kfbxlayer.h.