Public Member Functions | Protected Member Functions

KFbxBindingTableBase Class Reference

Search for all occurrences

Detailed Description

A binding table represents a collection of bindings from source types such as KFbxObjects, or KFbxLayerElements to destinations which can be of similar types.

See KFbxBindingTableEntry.

Definition at line 57 of file kfbxbindingtablebase.h.

#include <kfbxbindingtablebase.h>

Inheritance diagram for KFbxBindingTableBase:
Inheritance graph
[legend]

List of all members.

Public Member Functions

KFbxBindingTableEntry AddNewEntry ()
  Adds a new entry to the binding table.
size_t  GetEntryCount () const
  Query the number of table entries.
KFbxBindingTableEntry const &  GetEntry (size_t pIndex) const
  Access a table entry.
KFbxBindingTableEntry GetEntry (size_t pIndex)
  Access a table entry.
KFbxBindingTableEntry const *  GetEntryForSource (char const *pSrcName) const
  Retrieve the table entry for the given source value.
KFbxBindingTableEntry const *  GetEntryForDestination (char const *pDestName) const
  Retrieve the table entry for the given destination value.
virtual KFbxObject Copy (const KFbxObject &pObject)
  Copy an object content into this object.

Protected Member Functions

  KFbxBindingTableBase (KFbxSdkManager &pManager, char const *pName)
virtual  ~KFbxBindingTableBase ()=0

Constructor & Destructor Documentation

KFbxBindingTableBase ( KFbxSdkManager pManager,
char const *  pName 
) [protected]
virtual ~KFbxBindingTableBase ( ) [protected, pure virtual]

Member Function Documentation

KFbxBindingTableEntry& AddNewEntry ( )

Adds a new entry to the binding table.

Returns:
The new entry
size_t GetEntryCount ( ) const

Query the number of table entries.

Returns:
The number of entries
Examples:
ImportScene/DisplayMaterial.cxx.
KFbxBindingTableEntry const& GetEntry ( size_t  pIndex ) const

Access a table entry.

Parameters:
pIndex Valid range is [0, GetEntryCount()-1]
Returns:
A valid table entry if pIndex is valid. Otherwise the value is undefined.
Examples:
ImportScene/DisplayMaterial.cxx.
KFbxBindingTableEntry& GetEntry ( size_t  pIndex )

Access a table entry.

Parameters:
pIndex Valid range is [0, GetEntryCount()-1]
Returns:
A valid table entry if pIndex is valid. Otherwise the value is undefined.
KFbxBindingTableEntry const* GetEntryForSource ( char const *  pSrcName ) const

Retrieve the table entry for the given source value.

Parameters:
pSrcName The source value to query
Returns:
The corresponding entry, or NULL if no entry in the table has a source equal in value to pSrcName.
KFbxBindingTableEntry const* GetEntryForDestination ( char const *  pDestName ) const

Retrieve the table entry for the given destination value.

Parameters:
pDestName The destination value to query
Returns:
The corresponding entry, or NULL if no entry in the table has a destination equal in value to pDestName.
virtual KFbxObject& Copy ( const KFbxObject pObject ) [virtual]

Copy an object content into this object.

Parameters:
pObject The source object to copy data from.
Returns:
Returns the destination object being modified by the source.
Remarks:
This function replace the assignment operator (operator=). It will copy all property values and the name. Connections are NOT copied.

Reimplemented from KFbxObject.


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

KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase
KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase KFbxBindingTableBase