OpenMaya.MFnReference Class Reference

Class Description

Function set for reference nodes.

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

Inheritance diagram for OpenMaya.MFnReference:

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

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

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
	isFromReferencedFile
	isLocked
	isShared
	namespace
	pluginName
	typeId
	typeName

Constructor & Destructor Documentation

OpenMaya.MFnReference.__init__

(

)

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

Member Function Documentation

OpenMaya.MFnReference.associatedNamespace

(

)

associatedNamespace(bool shortName) -> MString

Returns the namespace associated with this reference.

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.

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.

OpenMaya.MFnReference.fileName

(

)

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

Returns the name of file associated with this reference.

OpenMaya.MFnReference.ignoreReferenceEdits ( )

static

ignoreReferenceEdits() -> bool

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

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.

OpenMaya.MFnReference.isLoaded

(

)

isLoaded() -> bool

Returns true if the reference is loaded.

OpenMaya.MFnReference.isLocked

(

)

isLocked() -> bool

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

OpenMaya.MFnReference.nodes

(

)

nodes() -> MObjectArray

Returns an array of the nodes associated with this reference.

OpenMaya.MFnReference.parentAssembly

(

)

parentAssembly() -> MObject

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

OpenMaya.MFnReference.parentFileName

(

)

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

Returns the name of parent file associated with this reference.

OpenMaya.MFnReference.parentReference

(

)

parentReference() -> MObject

Returns the reference node associated with the parent reference.

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.