OpenMaya.MExternalContentInfoTable Class Reference

Inheritance diagram for OpenMaya.MExternalContentInfoTable:

Public Member Functions
def	__getitem__ ()
def	__init__ ()
def	__len__ ()
def	addResolvedEntry ()
def	addUnresolvedEntry ()
def	getEntry ()
def	getInfo ()

Static Public Member Functions
def	__new__ ()

Detailed Description

This is a table of all the external content for a given node.

Constructor & Destructor Documentation

def OpenMaya.MExternalContentInfoTable.__init__

(

)

Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMaya.MExternalContentInfoTable.__getitem__

(

)

Return self[key].

def OpenMaya.MExternalContentInfoTable.__len__

(

)

Return len(self).

def OpenMaya.MExternalContentInfoTable.__new__ ( )

static

Create and return a new object.  See help(type) for accurate signature.

def 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.

def 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().

def 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.

def OpenMaya.MExternalContentInfoTable.getInfo

(

)

getInfo(key) -> [unresolvedLocation, resolvedLocation, contextNodeFullName, roles]

Retrieves external content information based on its key.

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