pymel.core.nodetypes.Reference¶

digraph inheritancef0d2d1ae36 { rankdir=TB; ranksep=0.15; nodesep=0.15; size="8.0, 12.0"; "DependNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.DependNode.html#pymel.core.nodetypes.DependNode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "PyNode" -> "DependNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ProxyUnicode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="../pymel.util.utilitytypes/pymel.util.utilitytypes.ProxyUnicode.html#pymel.util.utilitytypes.ProxyUnicode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "PyNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="../pymel.core.general/pymel.core.general.PyNode.html#pymel.core.general.PyNode",style="setlinewidth(0.5)",tooltip="Abstract class that is base for all pymel nodes classes.",height=0.25,shape=box,fontsize=8]; "ProxyUnicode" -> "PyNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Reference" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="#pymel.core.nodetypes.Reference",style="setlinewidth(0.5)",tooltip="class counterpart of mel function `reference`",height=0.25,shape=box,fontsize=8]; "DependNode" -> "Reference" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

class Reference(*args, **kwargs)¶

class counterpart of mel function reference

associatedNamespace(baseName)¶

Returns the namespace associated with this reference.

Parameters:	baseName : `bool` If true, return the base name of the reference
Return type:	`unicode`

Derived from api method maya.OpenMaya.MFnReference.associatedNamespace

containsNode(node)¶

Returns true if the specified node is from this reference or one of its child references. The containsNodeExactly method can be used to test membership without including the child references.

Parameters:	node : `PyNode` The node to be checked
Return type:	`bool`

Derived from api method maya.OpenMaya.MFnReference.containsNode

containsNodeExactly(node)¶

Returns true if the specified node is from this reference. Membership in child references is not checked. The containsNode method may be used to test membership in a reference and its child references.

Parameters:	node : `PyNode` The node to be checked
Return type:	`bool`

Derived from api method maya.OpenMaya.MFnReference.containsNodeExactly

fileName(resolvedName, includePath, includeCopyNumber)¶

Returns the name of file associated with this reference.

Parameters:

resolvedName : bool: If true, return the resolved name rather than the original file name. The unresolved name is the string originally specified when the file was loaded into Maya; this may contain environment variables, may be a relative path, and may otherwise not precisely indicate where the file can be located on disk. The resolved name is the actual path name that Maya is using to locate the file after relative paths and environment variables have been expanded, and any other necessary steps have been used to resolve its physical location.
includePath : bool: If true, include the file path in the return string.
includeCopyNumber : bool: If true, include the copy number (if there is one) in the return string.

Return type:

unicode

Derived from api method maya.OpenMaya.MFnReference.fileName

isExportEditsFile()¶

Returns true if the reference is an export edits file. An export edits file is a file of type ”.editMA” or ”.editMB” which was created using Maya’s offline file functionality.

Return type:	`bool`

Derived from api method maya.OpenMaya.MFnReference.isExportEditsFile

isLoaded()¶

Returns true if the reference is loaded.

Return type:	`bool`

Derived from api method maya.OpenMaya.MFnReference.isLoaded

nodes()¶

Returns an array of the nodes associated with this reference.

Return type:	`PyNode` list

Derived from api method maya.OpenMaya.MFnReference.nodes

parentAssembly()¶

Returns the parent assembly node that contains this reference. See MFnAssembly documentation for more details.

Return type:	`PyNode`

Derived from api method maya.OpenMaya.MFnReference.parentAssembly

parentFileName(resolveName, includePath, includeCopyNumber)¶

Returns the name of parent file associated with this reference.

Parameters:

resolveName : bool: If true, return the resolved name rather than the original file name. The unresolved name is the string originally specified when the file was loaded into Maya; this may contain environment variables, may be a relative path, and may otherwise not precisely indicate where the file can be located on disk. The resolved name is the actual path name that Maya is using to locate the file after relative paths and environment variables have been expanded, and any other necessary steps have been used to resolve its physical location.
includePath : bool: If true, include the file path in the return string.
includeCopyNumber : bool: If true, include the copy number (if there is one) in the return string.

Return type:

unicode

Derived from api method maya.OpenMaya.MFnReference.parentFileName

parentReference()¶

Returns the reference node associated with the parent reference.

Return type:	`PyNode`

Derived from api method maya.OpenMaya.MFnReference.parentReference