KFbxLayerElement Class Reference

#include <kfbxlayer.h>

Inherited by KFbxLayerElementTemplate, KFbxLayerElementTemplate< bool >, and KFbxLayerElementTemplate< void * >.

Inheritance diagram for KFbxLayerElement:

Inheritance graph
List of all members.

Detailed Description

KFbxLayerElement is the base class for Layer Elements.

It describes how a Layer Element is mapped on a geometry surface and how the mapping information is arranged in memory.

Definition at line 84 of file kfbxlayer.h.

Public Types

enum  ELayerElementType
 Type identifier for Layer Elements. More...
enum  EMappingMode
 Determine how the element is mapped on a surface. More...
enum  EReferenceMode
 Determine how the mapping information is stored in the array of coordinate. More...

Public Member Functions

void SetMappingMode (EMappingMode pMappingMode)
 Set the Mapping Mode.
void SetReferenceMode (EReferenceMode pReferenceMode)
 Set the Reference Mode.
EMappingMode GetMappingMode ()
 Get the Mapping Mode.
EReferenceMode GetReferenceMode ()
 Get the Reference Mode.
void SetName (const char *pName)
 Set the name of this object.
const char * GetName () const
 Get the name of this object.

Member Enumeration Documentation

enum ELayerElementType

Type identifier for Layer Elements.

Definition at line 116 of file kfbxlayer.h.

enum EMappingMode

Determine how the element is mapped on a surface.

  • eNONE The mapping is undetermined.
  • eBY_CONTROL_POINT There will be one mapping coordinate for each surface control point/vertex.
  • eBY_POLYGON_VERTEX There will be one mapping coordinate for each vertex, for each polygon it is part of. This means that a vertex will have as many mapping coordinates as polygons it is part of.
  • eBY_POLYGON There can be only one mapping coordinate for the whole polygon.
  • eBY_EDGE There will be one mapping coordinate for each unique edge in the mesh. This is meant to be used with smoothing layer elements.
  • eALL_SAME There can be only one mapping coordinate for the whole surface.

Definition at line 155 of file kfbxlayer.h.

enum EReferenceMode

Determine how the mapping information is stored in the array of coordinate.

  • eDIRECT This indicates that the mapping information for the n'th element is found in the n'th place of KFbxLayerElementTemplate::mDirectArray.
  • eINDEX, This symbol is kept for backward compatibility with FBX v5.0 files. In FBX v6.0 and higher, this symbol is replaced with eINDEX_TO_DIRECT.
  • eINDEX_TO_DIRECT This indicates that the KFbxLayerElementTemplate::mIndexArray contains, for the n'th element, an index in the KFbxLayerElementTemplate::mDirectArray array of mapping elements. eINDEX_TO_DIRECT is usually useful to store coordinates for eBY_POLYGON_VERTEX mapping mode elements. Since the same coordinates are usually repeated a large number of times, it saves spaces to store the coordinate only one time and refer to them with an index. Materials and Textures are also referenced with this mode and the actual Material/Texture can be accessed via the KFbxLayerElementTemplate::mDirectArray

Definition at line 178 of file kfbxlayer.h.

Member Function Documentation

void SetMappingMode ( EMappingMode  pMappingMode  )  [inline]

Set the Mapping Mode.

Parameters:
pMappingMode Specify the way the layer element is mapped on a surface.

Definition at line 189 of file kfbxlayer.h.

void SetReferenceMode ( EReferenceMode  pReferenceMode  )  [inline]

Set the Reference Mode.

Parameters:
pMappingMode Specify how the mapping information is arraged in memory.

Reimplemented in KFbxLayerElementSmoothing.

Definition at line 194 of file kfbxlayer.h.

EMappingMode GetMappingMode (  )  [inline]

Get the Mapping Mode.

Returns:
The current Mapping Mode.

Definition at line 199 of file kfbxlayer.h.

EReferenceMode GetReferenceMode (  )  [inline]

Get the Reference Mode.

Returns:
The current Reference Mode.

Definition at line 204 of file kfbxlayer.h.

void SetName ( const char *  pName  )  [inline]

Set the name of this object.

Parameters:
pName Specify the name of this LayerElement object.

Definition at line 209 of file kfbxlayer.h.

const char* GetName (  )  const [inline]

Get the name of this object.

Returns:
The current name of this LayerElement object.

Definition at line 214 of file kfbxlayer.h.