C++ API Reference
|
This is a table of all the external content for a given MPxNode. More...
#include <MExternalContentInfoTable.h>
Public Member Functions | |
MExternalContentInfoTable () | |
Class constructor. | |
~MExternalContentInfoTable () | |
Class destructor. | |
MStatus | addResolvedEntry (const MString &key, const MString &unresolvedLocation, const MString &resolvedLocation, const MStringArray &roles) |
This method is obsolete. More... | |
MStatus | addResolvedEntry (const MString &key, const MString &unresolvedLocation, const MString &resolvedLocation, const MString &contextNodeFullName, const MStringArray &roles) |
Add an entry in the table. More... | |
MStatus | addUnresolvedEntry (const MString &key, const MString &unresolvedLocation, const MStringArray &roles=MStringArray()) |
This method is obsolete. More... | |
MStatus | addUnresolvedEntry (const MString &key, const MString &unresolvedLocation, const MString &contextNodeFullName, const MStringArray &roles=MStringArray()) |
Add an entry in the table. More... | |
MStatus | getInfo (const MString &key, MString &unresolvedLocation, MString &resolvedLocation, MStringArray &roles) const |
This method is obsolete. More... | |
MStatus | getInfo (const MString &key, MString &unresolvedLocation, MString &resolvedLocation, MString &contextNodeFullName, MStringArray &roles) const |
This method is not available in Python. More... | |
MStatus | getEntry (unsigned int index, MString &key, MString &unresolvedLocation, MString &resolvedLocation, MStringArray &roles) const |
This method is obsolete. More... | |
MStatus | getEntry (unsigned int index, MString &key, MString &unresolvedLocation, MString &resolvedLocation, MString &contextNodeFullName, MStringArray &roles) const |
This method is not available in Python. More... | |
unsigned int | length () const |
Retrieves the number of entries in the table. More... | |
MExternalContentInfoTable (void *data) | |
Class constructor. | |
This is a table of all the external content for a given MPxNode.
External content is defined as any data that is not stored with the node and that is needed by the node to perform its work. It can be texture files, other scenes, audio files, etc.
Each node that references external content should report it through MPxNode::getExternalContent so that a complete list of external content can be saved with the scene in a way that makes it easy to inspect and edit offline.
MStatus addResolvedEntry | ( | const MString & | key, |
const MString & | unresolvedLocation, | ||
const MString & | resolvedLocation, | ||
const MStringArray & | roles | ||
) |
This method is obsolete.
Add an entry in the table.
[as of Maya 2019]
[in] | key | An arbitrary string defined by the caller. This will typically be an attribute name for situations where the content location is stored verbatim in a plug's value. |
[in] | unresolvedLocation | Path as stored in the node (i.e. without any token replacement performed). |
[in] | resolvedLocation | Full path to the content if it exists at the time of creation of this object. |
[in] | roles | An enumeration of all roles this content plays in the context of the node. The actual strings are not rigidly defined as of this writing. This is mostly for offline browsing of the content info: to assist in sorting content by role. A better content type system may be introduced later on to formalize this. |
MStatus addResolvedEntry | ( | const MString & | key, |
const MString & | unresolvedLocation, | ||
const MString & | resolvedLocation, | ||
const MString & | contextNodeFullName, | ||
const MStringArray & | roles | ||
) |
Add an entry in the table.
[in] | key | An arbitrary string defined by the caller. This will typically be an attribute name for situations where the content location is stored verbatim in a plug's value. |
[in] | unresolvedLocation | Path as stored in the node (i.e. without any token replacement performed). |
[in] | resolvedLocation | Full path to the content if it exists at the time of creation of this object. |
[in] | contextNodeFullName | The fullname of the URI owner (node) if it applies, an empty string otherwise. |
[in] | roles | An enumeration of all roles this content plays in the context of the node. The actual strings are not rigidly defined as of this writing. This is mostly for offline browsing of the content info: to assist in sorting content by role. A better content type system may be introduced later on to formalize this. |
MStatus addUnresolvedEntry | ( | const MString & | key, |
const MString & | unresolvedLocation, | ||
const MStringArray & | roles = MStringArray() |
||
) |
This method is obsolete.
Add an entry in the table.
[from before Maya 2016]
The resolved location will be inferred from the application's built-in file resolving for the specified file type. This will automatically add entries into the roles vector that correspond to the search rules for this file type.
[in] | key | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[in] | unresolvedLocation | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[in] | roles | See documentation for MExternalContentInfoTable::addResolvedEntry. |
MStatus addUnresolvedEntry | ( | const MString & | key, |
const MString & | unresolvedLocation, | ||
const MString & | contextNodeFullName, | ||
const MStringArray & | roles = MStringArray() |
||
) |
Add an entry in the table.
The resolved location will be inferred from the application's built-in file resolving for the specified file type. This will automatically add entries into the roles vector that correspond to the search rules for this file type.
[in] | key | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[in] | unresolvedLocation | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[in] | contextNodeFullName | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[in] | roles | See documentation for MExternalContentInfoTable::addResolvedEntry. |
MStatus getInfo | ( | const MString & | key, |
MString & | unresolvedLocation, | ||
MString & | resolvedLocation, | ||
MStringArray & | roles | ||
) | const |
This method is obsolete.
This method is not available in Python.
[as of Maya 2019]
Retrieves external content information based on its key.
[in] | key | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[out] | unresolvedLocation | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[out] | resolvedLocation | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[out] | roles | See documentation for MExternalContentInfoTable::addResolvedEntry. |
Note: In Python, this method has a different signature:
The function returns a string, the key.
MStatus getInfo | ( | const MString & | key, |
MString & | unresolvedLocation, | ||
MString & | resolvedLocation, | ||
MString & | contextNodeFullName, | ||
MStringArray & | roles | ||
) | const |
This method is not available in Python.
Retrieves external content information based on its key.
[in] | key | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[out] | unresolvedLocation | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[out] | resolvedLocation | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[out] | contextNodeFullName | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[out] | roles | See documentation for MExternalContentInfoTable::addResolvedEntry. |
Note: In Python, this method has a different signature:
The function returns a string, the key.
MStatus getEntry | ( | unsigned int | index, |
MString & | key, | ||
MString & | unresolvedLocation, | ||
MString & | resolvedLocation, | ||
MStringArray & | roles | ||
) | const |
This method is obsolete.
This method is not available in Python.
[from before Maya 2016]
Retrieves external content entry based on its position in the table.
[in] | index | Position of the entry to retrieve information from. |
[out] | key | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[out] | unresolvedLocation | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[out] | resolvedLocation | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[out] | roles | See documentation for MExternalContentInfoTable::addResolvedEntry. |
Note: In Python, this method has a different signature:
The function returns a string, the key.
MStatus getEntry | ( | unsigned int | index, |
MString & | key, | ||
MString & | unresolvedLocation, | ||
MString & | resolvedLocation, | ||
MString & | contextNodeFullName, | ||
MStringArray & | roles | ||
) | const |
This method is not available in Python.
Retrieves external content entry based on its position in the table.
[in] | index | Position of the entry to retrieve information from. |
[out] | key | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[out] | unresolvedLocation | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[out] | resolvedLocation | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[out] | contextNodeFullName | See documentation for MExternalContentInfoTable::addResolvedEntry. |
[out] | roles | See documentation for MExternalContentInfoTable::addResolvedEntry. |
Note: In Python, this method has a different signature:
The function returns a string, the key.
unsigned int length | ( | ) | const |
Retrieves the number of entries in the table.