FBX C++ API Reference
FbxBindingTableEntry Class Reference

#include <fbxbindingtableentry.h>

Class Description

A binding table entry stores a binding between a source and a destination.

Users should not instantiate this class directly, but always call FbxBindingTableBase::AddNewEntry() to create a new entry in the binding table.

Examples:
ExportShader/main.cxx, and ImportScene/DisplayMaterial.cxx.

Definition at line 28 of file fbxbindingtableentry.h.

Public Member Functions

FbxBindingTableEntryoperator= (const FbxBindingTableEntry &pEntry)
 Assignment operator. More...
 

Constructor and Destructor

 FbxBindingTableEntry ()
 Constructor. More...
 
 FbxBindingTableEntry (const FbxBindingTableEntry &pEntry)
 Copy constructor. More...
 
 ~FbxBindingTableEntry ()
 Destructor. More...
 

Access

void SetSource (const char *pSource)
 Set the source. More...
 
const char * GetSource () const
 Retrieve the source. More...
 
void SetDestination (const char *pDestination)
 Set the destination. More...
 
const char * GetDestination () const
 Retrieve the destination. More...
 
void SetEntryType (const char *pType, bool pAsSource)
 Set the source type or destination type. More...
 
const char * GetEntryType (bool pAsSource) const
 Get the source type or destination type. More...
 
void * GetUserDataPtr ()
 Retrieve user data pointer. More...
 
const void * GetUserDataPtr () const
 Retrieve user data pointer. More...
 
void SetUserDataPtr (void *pData)
 Set user data pointer. More...
 

Constructor & Destructor Documentation

◆ FbxBindingTableEntry() [1/2]

Constructor.

◆ FbxBindingTableEntry() [2/2]

Copy constructor.

Parameters
pEntryFbxBindingTableEntry to be copied.
Remarks
the UserDataPtr is a shared pointer.

◆ ~FbxBindingTableEntry()

Destructor.

Member Function Documentation

◆ SetSource()

void SetSource ( const char *  pSource)

Set the source.

Parameters
pSourceThe source to set.

◆ GetSource()

const char* GetSource ( ) const

Retrieve the source.

Examples:
ImportScene/DisplayMaterial.cxx.

◆ SetDestination()

void SetDestination ( const char *  pDestination)

Set the destination.

Parameters
pDestinationThe destination to set.

◆ GetDestination()

const char* GetDestination ( ) const

Retrieve the destination.

◆ SetEntryType()

void SetEntryType ( const char *  pType,
bool  pAsSource 
)

Set the source type or destination type.

Parameters
pTypeThe source type or destination type to set.
pAsSourceFlag indicates source type or destination type to set.

◆ GetEntryType()

const char* GetEntryType ( bool  pAsSource) const

Get the source type or destination type.

Parameters
pAsSourceFlag indicates source type or destination type to get.
Returns
Source type or destination type.
Examples:
ImportScene/DisplayMaterial.cxx.

◆ GetUserDataPtr() [1/2]

void* GetUserDataPtr ( )

Retrieve user data pointer.

Returns
User data pointer.

◆ GetUserDataPtr() [2/2]

const void* GetUserDataPtr ( ) const

Retrieve user data pointer.

Returns
User data pointer.

◆ SetUserDataPtr()

void SetUserDataPtr ( void *  pData)

Set user data pointer.

Parameters
pDatauser data pointer.

◆ operator=()

FbxBindingTableEntry& operator= ( const FbxBindingTableEntry pEntry)

Assignment operator.

Parameters
pEntryFbxBindingTableEntry assigned to this one.
Remarks
the UserDataPtr is a shared pointer.

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