Class Description

Layer element for mapping materials (FbxSurfaceMaterial) to a geometry.

FBX SDK 2011 and later connects materials (FbxSurfaceMaterial) to nodes (FbxNode). The direct array of this class is no longer used. The integer "n" in the index array of this class represents the n-th material (zero-based) connected to the node.

For example:

Mapping mode eAllSame and index array {0} means the whole geometry is assigned with the 0-th material connected to the node.

Mapping mode eByPolygon and index array {0, 1} means the first polygon is assigned with the 0-th material and the second polygon is assigned with the 1-th material.

You can access the materials from a node by using FbxNode::GetMaterialCount() and FbxNode::GetMaterial(int pIndex) or the more generic calls to GetSrcObjectCount<FbxSurfaceMaterial>() and GetSrcObject<FbxSurfaceMaterial>(index)

For example:

FbxNode* node;
int nbMat = node->GetMaterialCount();
int nbMat1= node->GetSrcObjectCount<FbxSurfaceMaterial>();
FbxSurfaceMaterial* material;
FbxLayerElementMaterial* layerElement;
if (layerElement->GetMappingMode() == FbxLayerElement::eAllSame)
{
    int index = layerElement->GetIndexArray()[0];
    material = node->GetMaterial(index);
}

Remarks: The DirectArray() methods still exist for legacy reasons but has been made private and should not be used. Therefore, to be correctly saved in FBX file, this type of Layer element should have its reference mode set to eIndexToDirect.

See Also: FbxSurfaceMaterial; FbxNode

Examples:: Common/GeometryUtility.cxx, ExportDocument/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, ImportScene/DisplayMesh.cxx, Instances/main.cxx, Layers/main.cxx, ProceduralTexture/main.cxx, and UI_Examples/CubeCreator/SDK_Utility.cxx.

Definition at line 1387 of file fbxlayer.h.

Inheritance diagram for FbxLayerElementMaterial:

Classes
class	LayerElementArrayProxy

Public Types
typedef FbxLayerElementTemplate < FbxSurfaceMaterial * >	ParentClass

Public Types inherited from FbxLayerElement
enum	EType { eUnknown, eNormal, eBiNormal, eTangent, eMaterial, ePolygonGroup, eUV, eVertexColor, eSmoothing, eVertexCrease, eEdgeCrease, eHole, eUserData, eVisibility, eTextureDiffuse, eTextureDiffuseFactor, eTextureEmissive, eTextureEmissiveFactor, eTextureAmbient, eTextureAmbientFactor, eTextureSpecular, eTextureSpecularFactor, eTextureShininess, eTextureNormalMap, eTextureBump, eTextureTransparency, eTextureTransparencyFactor, eTextureReflection, eTextureReflectionFactor, eTextureDisplacement, eTextureDisplacementVector, eTypeCount }
	Layer Element type identifier. More...

enum	EMappingMode { eNone, eByControlPoint, eByPolygonVertex, eByPolygon, eByEdge, eAllSame }
	Determines how the element is mapped to a surface. More...

enum	EReferenceMode { eDirect, eIndex, eIndexToDirect }
	Determines how the mapping information is stored in the array of coordinates. More...

Public Member Functions
	FBXSDK_LAYER_ELEMENT_CREATE_DECLARE (LayerElementMaterial)
	Allocation method. More...

Public Member Functions inherited from FbxLayerElementTemplate< FbxSurfaceMaterial * >
FbxLayerElementArrayTemplate < FbxSurfaceMaterial * > &	GetDirectArray () const
	Returns the direct array of Layer Elements. More...

FbxLayerElementArrayTemplate < FbxSurfaceMaterial * > &	GetDirectArray ()
	Returns the direct array of Layer Elements. More...

FbxLayerElementArrayTemplate < int > &	GetIndexArray () const
	Returns the index array of Layer Elements. More...

FbxLayerElementArrayTemplate < int > &	GetIndexArray ()
	Returns the index array of Layer Elements. More...

bool	Clear ()
	Removes all elements from the direct and the index arrays. More...

bool	operator== (const FbxLayerElementTemplate &pOther) const
	Equivalence operator. More...

FbxLayerElementTemplate &	operator= (FbxLayerElementTemplate const &pOther)
	Assignment operator. More...

int	RemapIndexTo (FbxLayerElement::EMappingMode pNewMapping)
	Changes the Mapping mode to the new one and re-computes the index array. More...

Public Member Functions inherited from FbxLayerElement
void	SetMappingMode (EMappingMode pMappingMode)
	Sets the Mapping Mode. More...

void	SetReferenceMode (EReferenceMode pReferenceMode)
	Sets the Reference Mode. More...

EMappingMode	GetMappingMode () const
	Returns the Mapping Mode. More...

EReferenceMode	GetReferenceMode () const
	Returns the Reference Mode. More...

void	SetName (const char *pName)
	Sets the name of this object. More...

const char *	GetName () const
	Returns the name of this object. More...

bool	operator== (const FbxLayerElement &pOther) const
	Equivalence operator. More...

FbxLayerElement &	operator= (FbxLayerElement const &pOther)
	Assignment operator. More...

void	Destroy ()
	Removes this layer element from its owner and delete it. More...

Additional Inherited Members
Static Public Attributes inherited from FbxLayerElement
static const int	sTypeTextureStartIndex = int(eTextureDiffuse)
	The start index of texture type layer elements. More...

static const int	sTypeTextureEndIndex = int(eTypeCount) - 1
	The end index of texture type layer elements. More...

static const int	sTypeTextureCount = sTypeTextureEndIndex - sTypeTextureStartIndex + 1
	The count of texture type layer elements. More...

static const int	sTypeNonTextureStartIndex = int(eNormal)
	The start index of non-texture type layer elements. More...

static const int	sTypeNonTextureEndIndex = int(eVisibility)
	The end index of non-texture type layer elements. More...

static const int	sTypeNonTextureCount = sTypeNonTextureEndIndex - sTypeNonTextureStartIndex + 1
	The count of non-texture type layer elements. More...

static const char *const	sTextureNames []
	Array of names of texture type layer elements. More...

static const char *const	sTextureUVNames []
	Array of names of UV layer elements. More...

static const char *const	sNonTextureNames []
	Array of names of non-texture type layer elements. More...

static const FbxDataType	sTextureDataTypes []
	Array of texture types. More...

static const char *const	sTextureChannelNames []
	Array of texture channels. More...

Member Typedef Documentation

typedef FbxLayerElementTemplate<FbxSurfaceMaterial*> ParentClass

Definition at line 1390 of file fbxlayer.h.

Member Function Documentation

FBXSDK_LAYER_ELEMENT_CREATE_DECLARE ( LayerElementMaterial )

Allocation method.

Returns: A pointer to the layer element or NULL if creation fails.

The documentation for this class was generated from the following file:

fbxsdk/scene/geometry/fbxlayer.h

FbxLayerElementMaterial Class Reference

Class Description

Classes

Public Types

Public Member Functions

Additional Inherited Members

Member Typedef Documentation

Member Function Documentation