FBX C++ API Reference
FbxSemanticEntryView Class Reference

#include <fbxsemanticentryview.h>

Class Description

FbxSemanticEntryView stores a binding corresponding to a semantic within a shader file.

A shader semantic is a parameter, a constant or an operator. So a shader semantic could bind with FbxProperty ( parameter, constant) and FbxBindingOperator (operator).

Here is a code snippet to show how it used.

FbxBindingTableEntry& lEntry = lBindingTable.AddNewEntry();
FbxPropertyEntryView lSrcView( lEntry, true, true);
lSrcView.SetProperty( lProp.GetHierarchicalName());
FbxSemanticEntryView lDstView( &pEntry, false, true );
lDstView.SetSemantic( lProp.Getname());
See also
FbxBindingTableEntry and FbxBindingTable.
Examples:
ExportShader/main.cxx.

Definition at line 42 of file fbxsemanticentryview.h.

+ Inheritance diagram for FbxSemanticEntryView:

Public Member Functions

void SetSemantic (const char *pSemantic)
 Set the semantic to the binding entry. More...
 
FbxString GetSemantic (bool pAppendIndex=true) const
 Get the semantic from the binding entry. More...
 
int GetIndex () const
 Get the semantic index suffix. 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 and Destructor.

 FbxSemanticEntryView (FbxBindingTableEntry *pEntry, bool pAsSource, bool pCreate=false)
 Constructor. More...
 
virtual ~FbxSemanticEntryView ()
 Destructor. More...
 

Constructor & Destructor Documentation

◆ FbxSemanticEntryView()

FbxSemanticEntryView ( 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.

◆ ~FbxSemanticEntryView()

virtual ~FbxSemanticEntryView ( )
virtual

Destructor.

Member Function Documentation

◆ SetSemantic()

void SetSemantic ( const char *  pSemantic)

Set the semantic to the binding entry.

Parameters
pSemanticThe semantic string to set.

◆ GetSemantic()

FbxString GetSemantic ( bool  pAppendIndex = true) const

Get the semantic from the binding entry.

Parameters
pAppendIndextrue if the returned semantic append a index, false otherwise.
Returns
The semantic.

◆ GetIndex()

int GetIndex ( ) const

Get the semantic index suffix.

Returns
Semantic index suffix.

◆ EntryType()

virtual const char* EntryType ( ) const
virtual

Get the entry type.

Returns
Entry type as string "FbxSemanticEntry".
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 "FbxSemanticEntry" in this case.

Definition at line 49 of file fbxsemanticentryview.h.


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