C++ API Reference
MExternalContentLocationTable Class 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.
 

Detailed Description

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, ...).

Examples:
AbcImport/AlembicNode.cpp, AbcImport/AlembicNode.h, dx11Shader/dx11Shader.cpp, dx11Shader/dx11Shader.h, glslShader/GLSLShader.cpp, glslShader/GLSLShader.h, gpuCache/gpuCacheShapeNode.cpp, gpuCache/gpuCacheShapeNode.h, sceneAssembly/adskRepresentations.cpp, sceneAssembly/adskRepresentations.h, sceneAssembly/assemblyDefinition.cpp, sceneAssembly/assemblyDefinition.h, sceneAssembly/assemblyReference.cpp, and sceneAssembly/assemblyReference.h.

Member Function Documentation

MStatus addEntry ( const MString key,
const MString location 
)

Adds an external content location and its key to the table.

Parameters
[in]keyAn 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]locationFull path to the content referenced by the key.
Returns
Return status.
Status Codes:
  • MS::kSuccess The method successfully added the entry.
  • MS::kFailure The method failed to add the entry.
Examples:
sceneAssembly/assemblyDefinition.cpp.
MStatus getEntry ( unsigned int  index,
MString key,
MString location 
) const

NO SCRIPT SUPPORT.

Retrieves an entry's key and location based on its index in the table.

Parameters
[in]indexPosition of the entry to retrieve information from.
[out]keySee documentation for MExternalContentLocationTable::addEntry.
[out]locationSee documentation for MExternalContentLocationTable::addEntry.

Note: In Python, this method has a different signature:

def getEntryByIndex(
index, # input integer
keyLocation # output array filled with [ key, location ]
)
Returns
Return status.
Status Codes:
  • MS::kSuccess The method successfully retrieved the entry.
  • MS::kFailure The method failed to retrieved the entry.
Examples:
sceneAssembly/assemblyDefinition.cpp.
MStatus getLocation ( const MString key,
MString location 
) const

NO SCRIPT SUPPORT.

Retrieves an entry's location based on the associated key.

Parameters
[in]keySee documentation for MExternalContentLocationTable::addEntry.
[out]locationSee documentation for MExternalContentLocationTable::addEntry.

Note: In Python, this method has a different signature:

def getLocationByKey(
key # input string
)

The function returns a string.

Returns
Return status.
Status Codes:
  • MS::kSuccess The method successfully added the entry.
  • MS::kFailure The method failed to add the entry.
Examples:
sceneAssembly/adskRepresentations.cpp, and sceneAssembly/assemblyReference.cpp.
unsigned int length ( ) const

Retrieves the number of entries in the table.

Returns
Number of entries.
Examples:
sceneAssembly/assemblyDefinition.cpp.

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