OpenMaya.MFnReference Class Reference

Inheritance diagram for OpenMaya.MFnReference:

Public Member Functions
def	__init__ ()
def	associatedNamespace ()
def	containsNode ()
def	containsNodeExactly ()
def	fileName ()
def	isExportEditsFile ()
def	isLoaded ()
def	isLocked ()
def	isValidReference ()
def	nodes ()
def	parentAssembly ()
def	parentFileName ()
def	parentReference ()
Public Member Functions inherited from OpenMaya.MFnDependencyNode
def	__init__ ()
def	absoluteName ()
def	addAttribute ()
def	addExternalContentForFileAttr ()
def	affectsAnimation ()
def	attribute ()
def	attributeClass ()
def	attributeCount ()
def	canBeWritten ()
def	create ()
def	dgCallbackIds ()
def	dgCallbacks ()
def	dgTimer ()
def	dgTimerOff ()
def	dgTimerOn ()
def	dgTimerQueryState ()
def	dgTimerReset ()
def	findAlias ()
def	findPlug ()
def	getAffectedAttributes ()
def	getAffectingAttributes ()
def	getAliasAttr ()
def	getAliasList ()
def	getConnections ()
def	getExternalContent ()
def	hasAttribute ()
def	hasUniqueName ()
def	isFlagSet ()
def	isNewAttribute ()
def	isTrackingEdits ()
def	name ()
def	plugsAlias ()
def	removeAttribute ()
def	reorderedAttribute ()
def	setAffectsAnimation ()
def	setAlias ()
def	setDoNotWrite ()
def	setExternalContent ()
def	setExternalContentForFileAttr ()
def	setFlag ()
def	setName ()
def	setUuid ()
def	uniqueName ()
def	userNode ()
def	uuid ()
Public Member Functions inherited from OpenMaya.MFnBase
def	__init__ ()
def	hasObj ()
def	object ()
def	setObject ()
def	type ()

Static Public Member Functions
def	__new__ ()
def	ignoreReferenceEdits ()
def	setIgnoreReferenceEdits ()
Static Public Member Functions inherited from OpenMaya.MFnDependencyNode
def	__new__ ()
def	allocateFlag ()
def	classification ()
def	deallocateAllFlags ()
def	deallocateFlag ()
Static Public Member Functions inherited from OpenMaya.MFnBase
def	__new__ ()

Additional Inherited Members
Static Public Attributes inherited from OpenMaya.MFnDependencyNode
int	kTimerMetrics = 9
int	kTimerTypes = 3
int	kExtensionAttr = 3
int	kInvalidAttr = 4
int	kLocalDynamicAttr = 1
int	kNormalAttr = 2
int	kTimerInvalidState = 3
int	kTimerOff = 0
int	kTimerOn = 1
int	kTimerUninitialized = 2
int	kTimerMetric_callback = 0
int	kTimerMetric_callbackNotViaAPI = 6
int	kTimerMetric_callbackViaAPI = 5
int	kTimerMetric_compute = 1
int	kTimerMetric_computeDuringCallback = 7
int	kTimerMetric_computeNotDuringCallback = 8
int	kTimerMetric_dirty = 2
int	kTimerMetric_draw = 3
int	kTimerMetric_fetch = 4
int	kTimerType_count = 2
int	kTimerType_inclusive = 1
int	kTimerType_self = 0
Properties inherited from OpenMaya.MFnDependencyNode
	isDefaultNode = property(...)
	isFromReferencedFile = property(...)
	isLocked = property(...)
	isShared = property(...)
	namespace = property(...)
	pluginName = property(...)
	typeId = property(...)
	typeName = property(...)

Detailed Description

Function set for reference nodes.

Method resolution order:
-   MFnReference
-   MFnDependencyNode
-   MFnBase
-   builtins.object

Constructor & Destructor Documentation

def OpenMaya.MFnReference.__init__

(

)

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

Member Function Documentation

def OpenMaya.MFnReference.__new__ ( )

static

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

def OpenMaya.MFnReference.associatedNamespace

(

)

associatedNamespace(bool shortName) -> MString

Returns the namespace associated with this reference.

def OpenMaya.MFnReference.containsNode

(

)

containsNode(MObject) -> bool

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.

def OpenMaya.MFnReference.containsNodeExactly

(

)

containsNodeExactly(MObject) -> bool

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.

def OpenMaya.MFnReference.fileName

(

)

fileName(bool resolvedName, bool includePath, bool includeCopyNumber) -> MString

Returns the name of file associated with this reference.

def OpenMaya.MFnReference.ignoreReferenceEdits ( )

static

ignoreReferenceEdits() -> bool

Indicates whether reference edits will be tracked and logged or not.

def OpenMaya.MFnReference.isExportEditsFile

(

)

isExportEditsFile() -> bool

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.

def OpenMaya.MFnReference.isLoaded

(

)

isLoaded() -> bool

Returns true if the reference is loaded.

def OpenMaya.MFnReference.isLocked

(

)

isLocked() -> bool

Returns true if the reference is locked or if the referenced file was saved as locked.

def OpenMaya.MFnReference.isValidReference

(

)

isValidReference() -> bool

Returns true if the reference is an valid file reference.

def OpenMaya.MFnReference.nodes

(

)

nodes() -> MObjectArray

Returns an array of the nodes associated with this reference.

def OpenMaya.MFnReference.parentAssembly

(

)

parentAssembly() -> MObject

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

def OpenMaya.MFnReference.parentFileName

(

)

parentFileName(bool resolvedName, bool includePath, bool includeCopyNumber) -> MString

Returns the name of parent file associated with this reference.

def OpenMaya.MFnReference.parentReference

(

)

parentReference() -> MObject

Returns the reference node associated with the parent reference.

def OpenMaya.MFnReference.setIgnoreReferenceEdits ( )

static

setIgnoreReferenceEdits(bool) -> None

Specify whether reference edits should be tracked and logged or not.
This should be treated as a temporary state and should be enabled 
around a batch of operations where reference edits should be ignored.
Restore the previous value when the batch of operations is complete.