FBX C++ API Reference
FbxLayerEntryView Class Reference

#include <fbxlayerentryview.h>

Class Description

FbxLayerEntryView encodes a layer element representation (the index of the layer, the type of the layer element and whether the layer element is a UVSet layer element) to a string stored in FbxBindingTableEntry and decodes the string back to a layer element representation.

This class is used in combination with FbxBindingTableEntry to represent a source or a destination FbxLayerElement.

See also
FbxBindingTableEntry and FbxBindingTable.

Definition at line 33 of file fbxlayerentryview.h.

+ Inheritance diagram for FbxLayerEntryView:

Public Member Functions

 FbxLayerEntryView (FbxBindingTableEntry *pEntry, bool pAsSource, bool pCreate=false)
 Constructor. More...
 
virtual ~FbxLayerEntryView ()
 Destructor. More...
 
void SetLayerElement (int pLayerIndex, FbxLayerElement::EType pType, bool pUVSet)
 Set the layer element for the binding entry. More...
 
void GetLayerElement (int &pLayerIndex, FbxLayerElement::EType &pType, bool &pUVSet) const
 Get the layer element for binding entry. More...
 
FbxLayerElementGetLayerElement (FbxLayerContainer *pContainer) const
 Get the layer element for binding entry. More...
 
virtual const char * EntryType () const
 Get the entry type. More...
 
- Public Member Functions inherited from FbxEntryView
virtual bool IsValid () const
 Check whether this entry view is valid or not. More...
 
virtual bool Create ()
 Create a new entry view. More...
 
 FbxEntryView (FbxBindingTableEntry *pEntry, bool pAsSource, bool pCreate=false)
 Constructor. More...
 
virtual ~FbxEntryView ()
 Destructor. More...
 

Static Public Attributes

static const char * sEntryType
 Name of the entry type used in the binding entry. More...
 
- Static Public Attributes inherited from FbxEntryView
static const char * sEntryType
 Entry type. More...
 

Constructor & Destructor Documentation

◆ FbxLayerEntryView()

FbxLayerEntryView ( FbxBindingTableEntry pEntry,
bool  pAsSource,
bool  pCreate = false 
)

Constructor.

Parameters
pEntryThe binding table entry to create the entry view for.
pAsSourcetrue to create the entry view as source, false as destination.
pCreatetrue to create the entry view, false otherwise.

◆ ~FbxLayerEntryView()

virtual ~FbxLayerEntryView ( )
virtual

Destructor.

Member Function Documentation

◆ SetLayerElement()

void SetLayerElement ( int  pLayerIndex,
FbxLayerElement::EType  pType,
bool  pUVSet 
)

Set the layer element for the binding entry.

Parameters
pLayerIndexLayerElement index.
pTypeLayerElement type.
pUVSetWhether this is a UVSet LayerElement.

◆ GetLayerElement() [1/2]

void GetLayerElement ( int &  pLayerIndex,
FbxLayerElement::EType pType,
bool &  pUVSet 
) const

Get the layer element for binding entry.

Parameters
pLayerIndexLayerElement index.
pTypeLayerElement type.
pUVSetWhether this is a UVSet LayerElement.

◆ GetLayerElement() [2/2]

FbxLayerElement* GetLayerElement ( FbxLayerContainer pContainer) const

Get the layer element for binding entry.

Parameters
pContainerFbxLayerContainer to get the layer element from.
Returns
The layer element for binding entry.

◆ EntryType()

virtual const char* EntryType ( ) const
virtual

Get the entry type.

Returns
Entry type as string "FbxLayerEntry".
Remarks
Always use EntryType() to get the right entry type.

Reimplemented from FbxEntryView.

Member Data Documentation

◆ sEntryType

const char* sEntryType
static

Name of the entry type used in the binding entry.

It should be "FbxLayerEntry" in this case.

Definition at line 40 of file fbxlayerentryview.h.


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