Class Description

FbxLayer class provides a base for the layering mechanism.

A layer can contain one or more of the following layer elements:

Normals
Binormals
Tangents
Materials
Polygon Groups
UVs
Vertex Colors
Smoothing informations
Vertex Creases
Edge Creases
Custom User Data
Visibilities
Textures (diffuse, ambient, specular, etc.) (deprecated)

A typical layer for a Mesh contains Normals, UVs and Materials. A typical layer for NURBS contains only Materials. In the case of the NURBS, the NURBS' parameterization is used for the UVs; no UVs should be specified.

In most cases, you only need a single layer to describe a geometry. Many applications only support what is defined on the first layer. Take this into account when you fill the layer. For example, it is legal to define the Layer 0 with the UVs and then define the model's Normals on layer 1. However if you construct a file this way, it may not be imported correctly in other applications. Store the Normals in Layer 0 to avoid problems.

Since FBX SDK 2011, Textures are connected to the properties of FbxSurfaceMaterial derived classes. FbxLayerElementTexture is no longer used. See the code example in FbxLayerElementTexture for how to connect a texture.

Since FBX SDK 2011, texture layering is achieved by FbxLayeredTexture. See the code example in FbxLayeredTexture for how to blend textures.

Normally, you can access layer from FbxLayerContainer like FbxGeometry. For example,

 FbxMesh* mesh;
 FbxLayer* layer0 = mesh->GetLayer(0);
 FbxLayerElementNormal* normals = layer0->GetNormals();

See also:: FbxLayerElement; FbxLayerElementNormal; FbxLayerElementBinormal; FbxLayerElementTangent; FbxLayerElementMaterial; FbxLayerElementPolygonGroup; FbxLayerElementUV; FbxLayerElementVertexColor; FbxLayerElementSmoothing; FbxLayerElementCrease; FbxLayerElementUserData; FbxLayerElementHole; FbxLayerElementVisibility

Examples:: ExportScene03/main.cxx, and Instances/main.cxx.

Definition at line 2333 of file fbxlayer.h.

List of all members.

Public Member Functions
	FBXSDK_FRIEND_NEW ()
Layer Element Management
FbxLayerElementNormal *	GetNormals ()
	Returns this layer's Normals description .
const FbxLayerElementNormal *	GetNormals () const
	Returns this layer's Normals description .
FbxLayerElementTangent *	GetTangents ()
	Returns this layer's Tangents description.
const FbxLayerElementTangent *	GetTangents () const
	Returns this layer's Tangents description.
FbxLayerElementBinormal *	GetBinormals ()
	Returns this layer's Binormals description.
const FbxLayerElementBinormal *	GetBinormals () const
	Returns this layer's Binormals description.
FbxLayerElementMaterial *	GetMaterials ()
	Returns this layer's Materials description.
const FbxLayerElementMaterial *	GetMaterials () const
	Returns this layer's Materials description.
FbxLayerElementPolygonGroup *	GetPolygonGroups ()
	Returns this layer's Polygon Groups description.
const FbxLayerElementPolygonGroup *	GetPolygonGroups () const
	Returns this layer's Polygon Groups description.
FbxLayerElementUV *	GetUVs (FbxLayerElement::EType pTypeIdentifier=FbxLayerElement::eTextureDiffuse)
	Returns this layer's UV description.
const FbxLayerElementUV *	GetUVs (FbxLayerElement::EType pTypeIdentifier=FbxLayerElement::eTextureDiffuse) const
	Returns this layer's UV description.
int	GetUVSetCount () const
	Returns the number of different UV sets in this layer.
FbxArray< FbxLayerElement::EType >	GetUVSetChannels () const
	Returns an array that describes which UV sets are in this layer.
FbxArray< const FbxLayerElementUV * >	GetUVSets () const
	Returns an array of UV sets in this layer.
FbxLayerElementVertexColor *	GetVertexColors ()
	Returns this layer's Vertex Colors description.
const FbxLayerElementVertexColor *	GetVertexColors () const
	Returns this layer's Vertex Colors description.
FbxLayerElementSmoothing *	GetSmoothing ()
	Returns this layer's Smoothing description.
const FbxLayerElementSmoothing *	GetSmoothing () const
	Returns this layer's Smoothing description.
FbxLayerElementCrease *	GetVertexCrease ()
	Returns this layer's vertex crease description.
const FbxLayerElementCrease *	GetVertexCrease () const
	Returns this layer's vertex crease description.
FbxLayerElementCrease *	GetEdgeCrease ()
	Returns this layer's edge crease description.
const FbxLayerElementCrease *	GetEdgeCrease () const
	Returns this layer's edge crease description.
FbxLayerElementHole *	GetHole ()
	Returns this layer's Hole description.
const FbxLayerElementHole *	GetHole () const
	Returns this layer's Hole description.
FbxLayerElementUserData *	GetUserData ()
	Returns this layer's User Data.
const FbxLayerElementUserData *	GetUserData () const
	Returns this layer's User Data.
FbxLayerElementVisibility *	GetVisibility ()
	Returns this layer's visibility.
const FbxLayerElementVisibility *	GetVisibility () const
	Returns this layer's visibility.
FbxLayerElementTexture *	GetTextures (FbxLayerElement::EType pType)
	Returns this layer's Textures description.
const FbxLayerElementTexture *	GetTextures (FbxLayerElement::EType pType) const
	Returns this layer's Textures description.
void	SetTextures (FbxLayerElement::EType pType, FbxLayerElementTexture *pTextures)
	Sets this layer's Textures description.
FbxLayerElement *	GetLayerElementOfType (FbxLayerElement::EType pType, bool pIsUV=false)
	Returns the specified type of layer element description for this layer.
const FbxLayerElement *	GetLayerElementOfType (FbxLayerElement::EType pType, bool pIsUV=false) const
	Returns the specified type of layer element description for this layer.
void	SetNormals (FbxLayerElementNormal *pNormals)
	Sets this layer's Normals description.
void	SetBinormals (FbxLayerElementBinormal *pBinormals)
	Sets this layer's Binormals description.
void	SetTangents (FbxLayerElementTangent *pTangents)
	Sets this layer's Tangents description.
void	SetMaterials (FbxLayerElementMaterial *pMaterials)
	Sets this layer's Materials description.
void	SetPolygonGroups (FbxLayerElementPolygonGroup *pPolygonGroups)
	Sets this layer's Polygon Groups description.
void	SetUVs (FbxLayerElementUV *pUVs, FbxLayerElement::EType pTypeIdentifier=FbxLayerElement::eTextureDiffuse)
	Sets this layer's UVs description.
void	SetVertexColors (FbxLayerElementVertexColor *pVertexColors)
	Sets this layer's Vertex Colors description.
void	SetSmoothing (FbxLayerElementSmoothing *pSmoothing)
	Sets this layer's Smoothing description.
void	SetVertexCrease (FbxLayerElementCrease *pCrease)
	Sets this layer's Vertex Crease description.
void	SetEdgeCrease (FbxLayerElementCrease *pCrease)
	Sets this layer's Edge Crease description.
void	SetHole (FbxLayerElementHole *pHole)
	Sets this layer's Hole description.
void	SetUserData (FbxLayerElementUserData *pUserData)
	Sets this layer's User Data.
void	SetVisibility (FbxLayerElementVisibility *pVisibility)
	Sets this layer's the visibility.
void	SetLayerElementOfType (FbxLayerElement *pLayerElement, FbxLayerElement::EType pType, bool pIsUV=false)
	Sets the specified type of layer element description for this layer.
FbxLayerElement *	CreateLayerElementOfType (FbxLayerElement::EType pType, bool pIsUV=false)
	Creates the specified type of layer element description for this layer.
void	Clone (FbxLayer const &pSrcLayer)
	Clone function.

Member Function Documentation

FBXSDK_FRIEND_NEW ( )

void SetTextures	(	FbxLayerElement::EType	pType,
		FbxLayerElementTexture *	pTextures
	)

pType	Texture type identifier.
pTextures	A pointer to the Textures layer element, or `NULL` to remove the Textures definition.

FbxLayerElement* GetLayerElementOfType	(	FbxLayerElement::EType	pType,
		bool	pIsUV = `false`
	)

const FbxLayerElement* GetLayerElementOfType	(	FbxLayerElement::EType	pType,
		bool	pIsUV = `false`
	)		const

void SetUVs	(	FbxLayerElementUV *	pUVs,
		FbxLayerElement::EType	pTypeIdentifier = `FbxLayerElement::eTextureDiffuse`
	)

pUVs	A pointer to the UVs layer element, or `NULL` to remove the UV definition.
pTypeIdentifier	Layer element type, should be texture type.

void SetLayerElementOfType	(	FbxLayerElement *	pLayerElement,
		FbxLayerElement::EType	pType,
		bool	pIsUV = `false`
	)

pLayerElement	A pointer to the layer element, or `NULL` to remove the layer element.
pType	The required Layer element type. Calling with eNormal is the equivalent of calling GetNormals(). Calling with eBiNormal is the equivalent of calling GetBinormals(). Calling with eTangent is the equivalent of calling GetTangents(). Calling with eMaterial is the equivalent of calling GetMaterials(). Calling with ePolygonGroup is the equivalent of calling GetPolygonGroups(). Calling with eUV is the equivalent of calling GetUVs(). Calling with eVertexColor is the equivalent of calling GetVertexColors(). Calling with eSmoothing is the equivalent of calling GetSmoothing(). Calling with eVertexCrease is the equivalent of calling GetVertexCrease(). Calling with eEdgeCrease is the equivalent of calling GetEdgeCrease(). Calling with eUserData is the equivalent of calling GetUserData(). Calling with eVisibility is the equivalent of calling GetVisibility(). Calling with texture type is the equivalent of calling GetTextures(FbxLayerElement::EType pType).
pIsUV	If `true`, requests the UV layer element that corresponds with the specified texture type.

FbxLayerElement* CreateLayerElementOfType	(	FbxLayerElement::EType	pType,
		bool	pIsUV = `false`
	)

pType	The required Layer element type.
pIsUV	When `true`, requests the UV LayerElement that corresponds with the specified Layer Element type (only applies to TEXTURE type layer elements).

Class Description

Public Member Functions

Layer Element Management

Member Function Documentation