OpenMaya.MExternalContentInfoTable Class Reference

OpenMaya.MExternalContentInfoTable Class Reference

Class Description

This is a table of all the external content for a given node.
+ Inheritance diagram for OpenMaya.MExternalContentInfoTable:

Public Member Functions

__getitem__ ()
 
__init__ ()
 
__len__ ()
 
addResolvedEntry ()
 
addUnresolvedEntry ()
 
getEntry ()
 
getInfo ()
 

Constructor & Destructor Documentation

OpenMaya.MExternalContentInfoTable.__init__ ( )
x.__init__(...) initializes x; see help(type(x)) for signature

Member Function Documentation

OpenMaya.MExternalContentInfoTable.__getitem__ ( )
x.__getitem__(y) <==> x[y]
OpenMaya.MExternalContentInfoTable.__len__ ( )
x.__len__() <==> len(x)
OpenMaya.MExternalContentInfoTable.addResolvedEntry ( )
addResolvedEntry(key, unresolvedLocation, resolvedLocation, contextNodeFullName, roles) -> self

Add an entry in the table.

* key (string) - 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.
* unresolvedLocation (string) - Path as stored in the node (i.e. without any token replacement performed).
* resolvedLocation (string) - Full path to the content if it exists at the time of creation of this object.
* contextNodeFullName (string) - The fullname of the URI owner (node) if it applies, an empty string otherwise.
* roles (list of strings) - 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.
OpenMaya.MExternalContentInfoTable.addUnresolvedEntry ( )
addUnresolvedEntry(key, unresolvedLocation, contextNodeFullName, roles=None) -> self

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.

* key (string) - See documentation of MExternalContentInfoTable.addResolvedEntry().
* unresolvedLocation (string) - See documentation of MExternalContentInfoTable.addResolvedEntry().
* contextNodeFullName (string) - See documentation of MExternalContentInfoTable.addResolvedEntry().
* roles (list of strings) - See documentation of MExternalContentInfoTable.addResolvedEntry().
OpenMaya.MExternalContentInfoTable.getEntry ( )
getEntry(index) -> [key, unresolvedLocation, resolvedLocation, contextNodeFullName, roles]

Retrieves external content entry based on its position in the table.

* index (unsigned int) - Position of the entry to retrieve information from.
OpenMaya.MExternalContentInfoTable.getInfo ( )
getInfo(key) -> [unresolvedLocation, resolvedLocation, contextNodeFullName, roles]

Retrieves external content information based on its key.

* key (string) - See documentation of MExternalContentInfoTable.addResolvedEntry().