Python API 2.0 Reference: OpenMaya.MFnContainerNode Class Reference

+ Inheritance diagram for OpenMaya.MFnContainerNode:

Public Member Functions

def __init__ ()
 
def clear ()
 
def getMembers ()
 
def getParentContainer ()
 
def getPublishedNames ()
 
def getPublishedNodes ()
 
def getPublishedPlugs ()
 
def getRootTransform ()
 
def getSubcontainers ()
 
def isCurrent ()
 
def makeCurrent ()
 
- 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 getCurrentAsMObject ()
 
- 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__ ()
 

Static Public Attributes

int kChildAnchor = 1
 
int kGeneric = 2
 
int kParentAnchor = 0
 
- 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
 

Additional Inherited Members

- Properties inherited from OpenMaya.MFnDependencyNode
 isDefaultNode
 
 isFromReferencedFile
 
 isLocked
 
 isShared
 
 namespace
 
 pluginName
 
 typeId
 
 typeName
 

Detailed Description

Function set for containers.

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

Constructor & Destructor Documentation

OpenMaya.MFnContainerNode.__init__ ( )
Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

OpenMaya.MFnContainerNode.__new__ ( )
static
Create and return a new object.  See help(type) for accurate signature.
OpenMaya.MFnContainerNode.clear ( )
clear()

Delete all members of the container.
OpenMaya.MFnContainerNode.getCurrentAsMObject ( )
static
getCurrentAsMObject() -> MObject

Retrieve the current container node.
OpenMaya.MFnContainerNode.getMembers ( )
getMembers() -> MObjectArray

Return an array of the nodes included in this container.
OpenMaya.MFnContainerNode.getParentContainer ( )
getParentContainer() -> MObject

Return the parent container, if there is one. Otherwise return an empty MObject.
OpenMaya.MFnContainerNode.getPublishedNames ( )
getPublishedNames(unboundOnly=bool) -> [MString]

Return a list of published names on the container. Depending on the arguments, either all published names or only unbound published names will be returned.
OpenMaya.MFnContainerNode.getPublishedNodes ( )
getPublishedNodes(publishNodeType=MPublishNodeType) -> ([MString] publishedNames, MObjectArray publishedNodes)

Return a list of the published nodes of a given type. For any names that have assigned nodes, return the node at the corresponding array index. For any names that do not have assigned nodes, a NULL MObject will be at the corresponding array index.
OpenMaya.MFnContainerNode.getPublishedPlugs ( )
getPublishedPlugs() -> (MPlugArray publishedPlugs, [MString] publishedNames)

Return a tuple of plugs that have been published on this container and the names of those plugs.
OpenMaya.MFnContainerNode.getRootTransform ( )
getRootTransform() -> MObject

Return the root transform, if there is one. Otherwise return an empty MObject.
OpenMaya.MFnContainerNode.getSubcontainers ( )
getSubcontainers() -> MObjectArray

Return an array of the container nodes included in this container.
OpenMaya.MFnContainerNode.isCurrent ( )
isCurrent() -> bool

Return whether the container node managed by this function set is the current container.
OpenMaya.MFnContainerNode.makeCurrent ( )
makeCurrent(isCurrent) -> self

Set or clear whether the container managed by this function set is denoted as the
the current container.  If the flag is true and the container is allowed to be
current, then the current container is set to be the container.  Otherwise, if the
container managed by the function set is the current container, then the current
container is cleared.

* isCurrent (True/False) - Specifies whether this container shall be current.