C++ API Reference
|
This is a table of the all the external content locations for a given MPxNode. More...
#include <MExternalContentLocationTable.h>
Public Member Functions | |
MExternalContentLocationTable () | |
Class constructor. | |
~MExternalContentLocationTable () | |
Class destructor. | |
MStatus | addEntry (const MString &key, const MString &location) |
Adds an external content location and its key to the table. More... | |
MStatus | getEntry (unsigned int index, MString &key, MString &location) const |
NO SCRIPT SUPPORT. More... | |
MStatus | getLocation (const MString &key, MString &location) const |
NO SCRIPT SUPPORT. More... | |
unsigned int | length () const |
Retrieves the number of entries in the table. More... | |
MExternalContentLocationTable (const void *const data) | |
Class constructor. | |
This is a table of the all the external content locations for a given MPxNode.
It is a subset of the information contained in MExternalContentInfo: it has as many entries, but each entry only states the key and location.
While MExternalContentInfoTable is meant to query external content from a MPxNode, MExternalContentLocationTable is meant to pass modified locations back to the MPxNode.
Key: Same as for MExternalContentInfoTable.
Value: New location of the content for this entry (path, URI, ...).
Adds an external content location and its key to the table.
[in] | key | An arbitrary string defined by the node. This will typically be an attribute name for situations where the content location is stored verbatim in a plug's value. |
[in] | location | Full path to the content referenced by the key. |
NO SCRIPT SUPPORT.
Retrieves an entry's key and location based on its index in the table.
[in] | index | Position of the entry to retrieve information from. |
[out] | key | See documentation for MExternalContentLocationTable::addEntry. |
[out] | location | See documentation for MExternalContentLocationTable::addEntry. |
Note: In Python, this method has a different signature:
NO SCRIPT SUPPORT.
Retrieves an entry's location based on the associated key.
[in] | key | See documentation for MExternalContentLocationTable::addEntry. |
[out] | location | See documentation for MExternalContentLocationTable::addEntry. |
Note: In Python, this method has a different signature:
The function returns a string.
unsigned int length | ( | ) | const |
Retrieves the number of entries in the table.