pymel.core.nodetypes.DefaultRenderUtilityList¶
digraph inheritance35d1cd4e8d { rankdir=TB; ranksep=0.15; nodesep=0.15; size="8.0, 12.0"; "DefaultRenderUtilityList" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="#pymel.core.nodetypes.DefaultRenderUtilityList",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "DependNode" -> "DefaultRenderUtilityList" [arrowsize=0.5,style="setlinewidth(0.5)"]; "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)"]; }
- class DefaultRenderUtilityList(*args, **kwargs)¶
- MAttrClass = Enum( EnumValue('MAttrClass', 1, 'localDynamicAttr'), EnumValue('MAttrClass', 2, 'normalAttr'), EnumValue('MAttrClass', 3, 'extensionAttr'), EnumValue('MAttrClass', 4, 'invalidAttr'))¶
- MdgTimerMetric = Enum( EnumValue('MdgTimerMetric', 0, 'metric_callback'), EnumValue('MdgTimerMetric', 1, 'metric_compute'), EnumValue('MdgTimerMetric', 2, 'metric_dirty'), EnumValue('MdgTimerMetric', 3, 'metric_draw'), EnumValue('MdgTimerMetric', 4, 'metric_fetch'), EnumValue('MdgTimerMetric', 5, 'metric_callbackViaAPI'), EnumValue('MdgTimerMetric', 6, 'metric_callbackNotViaAPI'), EnumValue('MdgTimerMetric', 7, 'metric_computeDuringCallback'), EnumValue('MdgTimerMetric', 8, 'metric_computeNotDuringCallback'), EnumValue('MdgTimerMetric', 9, 'metrics'))¶
- MdgTimerState = Enum( EnumValue('MdgTimerState', 0, 'off'), EnumValue('MdgTimerState', 1, 'on'), EnumValue('MdgTimerState', 2, 'uninitialized'), EnumValue('MdgTimerState', 3, 'invalidState'))¶
- MdgTimerType = Enum( EnumValue('MdgTimerType', 0, 'type_self'), EnumValue('MdgTimerType', 1, 'type_inclusive'), EnumValue('MdgTimerType', 2, 'type_count'), EnumValue('MdgTimerType', 3, 'types'))¶
- addAttribute(attr)¶
Add a new dynamic attibute to this node.
Parameters: - attr : PyNode
new attribute
Derived from api method maya.OpenMaya.MFnDependencyNode.addAttribute
Undo is not currently supported for this method
- classmethod allocateFlag(pluginName)¶
Allocates a node flag for sole use by the caller. Note that the flag is not specific to any one node but is made available to the caller on all nodes. Furthermore, node flags only persist for the duration of the current Maya session: they are not saved with the scene.
Parameters: - pluginName : unicode
The name of the plugin which is allocating the flag. A plugin’s name can be retrieved by calling MFnPlugin::name() within its initializePlugin() or uninitializePlugin() functions.
Return type: int
Derived from api method maya.OpenMaya.MFnDependencyNode.allocateFlag
- attribute(index)¶
Finds the attribute of this node at the given index. Index order is based on the order in which the attributes were added to the node.
Parameters: - index : int
the index of the attribute
Return type: PyNode
Derived from api method maya.OpenMaya.MFnDependencyNode.attribute
- attributeClass(attribute)¶
Returns the class (normal, dynamic, extension) of the specified attribute.
Parameters: - attribute : PyNode
the attribute to check
Return type: Derived from api method maya.OpenMaya.MFnDependencyNode.attributeClass
- classmethod deallocateAllFlags(pluginName)¶
Deallocates all of the node flags which are currently allocated to the specified plugin. The deallocated flags immediately become available for use by any plugin.
Parameters: - pluginName : unicode
The name of the plugin whose flags are to be deallocated. A plugin’s name can be retrieved by calling MFnPlugin::name() within its initializePlugin() or uninitializePlugin() functions.
Derived from api method maya.OpenMaya.MFnDependencyNode.deallocateAllFlags
Undo is not currently supported for this method
- classmethod deallocateFlag(pluginName, flag)¶
Deallocates a node flag which was previously allocated by a call to allocateFlag . The flag subsequently becomes available for reallocation and use by someone else.
Parameters: - pluginName : unicode
The name of the plugin which allocated the flag. A plugin’s name can be retrieved by calling MFnPlugin::name() within its initializePlugin() or uninitializePlugin() functions.
- flag : int
Flag to deallocate.
Derived from api method maya.OpenMaya.MFnDependencyNode.deallocateFlag
Undo is not currently supported for this method
- dgCallbacks(timerType, callbackName, value)¶
Node callbacks that occur when timing is enabled get logged with the node and can be queried via this method. See the dgCallbackIds method for getting a further breakdown of the time for an individual callback on this node.
Parameters: - timerType : DependNode.MdgTimerType
The timer we want to query, e.g. kTimerType_self for self time.
values: ‘type_self’, ‘type_inclusive’, ‘type_count’, ‘types’
- callbackName : list list
Returns an array of callback names that were invoked for this node since the last timer reset.
- value : float list
Returns an array of timing values. There is a one-to-one correspondence with the `callbackName’ array.
Derived from api method maya.OpenMaya.MFnDependencyNode.dgCallbacks
Undo is not currently supported for this method
- dgTimer(timerMetric, timerType)¶
The function returns the specified timer value for the current node. This is the total amount of time spent performing the requested operation since the timer was last reset (see dgTimerReset() for details). There are numerous timers per node and these are referenced by the metric and the timer type.
Parameters: - timerMetric : DependNode.MdgTimerMetric
The timing metric we wish to query.
values: ‘metric_callback’, ‘metric_compute’, ‘metric_dirty’, ‘metric_draw’, ‘metric_fetch’, ‘metric_callbackViaAPI’, ‘metric_callbackNotViaAPI’, ‘metric_computeDuringCallback’, ‘metric_computeNotDuringCallback’, ‘metrics’
- timerType : DependNode.MdgTimerType
The timer type we wish to query.
values: ‘type_self’, ‘type_inclusive’, ‘type_count’, ‘types’
Return type: float
Derived from api method maya.OpenMaya.MFnDependencyNode.dgTimer
- dgTimerOff()¶
Indicates that this node should no longer collect DG timing data when DG timing is enabled. See dgTimerOn() and enableDGTiming() for more details. Derived from api method maya.OpenMaya.MFnDependencyNode.dgTimerOff
Undo is not currently supported for this method
- dgTimerOn()¶
Indicates that this node should collect DG timing data whenever DG timing is enabled. See enableDGTiming() for more details. Derived from api method maya.OpenMaya.MFnDependencyNode.dgTimerOn
Undo is not currently supported for this method
- dgTimerQueryState()¶
The function returns the current on/off state of the node’s timer.
Return type: DependNode.MdgTimerState Derived from api method maya.OpenMaya.MFnDependencyNode.dgTimerQueryState
- dgTimerReset()¶
The function resets the dependency graph timers and counters for this node to zero. Note that this method does not start or stop timing, it only resets the values to zero. If you want to turn on timing, use the method dgTimerOn() . If you want to turn off timing, use dgTimerOff() . Derived from api method maya.OpenMaya.MFnDependencyNode.dgTimerReset
Undo is not currently supported for this method
- findAlias(alias)¶
Retrieves the attribute with the given alias.
Parameters: - alias : unicode
alternative name of the attribute
Return type: (bool, PyNode)
Derived from api method maya.OpenMaya.MFnDependencyNode.findAlias
- findPlug(attr, wantNetworkedPlug)¶
Attempt to find a plug for the given attribute. This method will first try to find the networked version of the plug if requested. The networked version of a plug is one that currently exists in the dependency graph at a particular connection point. If a networked version is not found, then a standard non-networked plug is returned.
Parameters: - attr : PyNode
attribute whose plug we wish to find
- wantNetworkedPlug : bool
if true, request a networked plug if it is available
Return type: PyNode
Derived from api method maya.OpenMaya.MFnDependencyNode.findPlug
- getAffectedAttributes(attr)¶
Returns an array of attributes that are affected by the attribute passed in. That is, when the given attribute, attr is marked dirty (changed) all the affectedAttributes attributes will also be marked dirty. For nodes defined in plug-ins this call returns all those attributes that were marked as being affected by the given one via the MPxNode::attributeAffects call.
Parameters: - attr : PyNode
the attribute to check
Return type: PyNode list
Derived from api method maya.OpenMaya.MFnDependencyNode.getAffectedAttributes
- getAffectedByAttributes(attr)¶
Returns an array of attributes that affect the attribute passed in, attr . That is, when one of the attributes in affectedByAttributes is marked dirty (changed) then attr will also be marked dirty. For nodes defined in plug-ins this call returns all those attributes that were marked as affecting the given one via the MPxNode::attributeAffects call.
Parameters: - attr : PyNode
the attribute to check
Return type: PyNode list
Derived from api method maya.OpenMaya.MFnDependencyNode.getAffectedByAttributes
- getAliasAttr(force)¶
Returns the node’s alias attribute, which is a special attribute used to store information about the node’s attribute aliases.
Parameters: - force : bool
To indicate whether the alias attr should be created.
Return type: PyNode
Derived from api method maya.OpenMaya.MFnDependencyNode.getAliasAttr
- getAliasList()¶
Returns a list of all attribute aliases for this node. The aliases are pairs of strings with the first being the alias and the second being the attribute’s real name.
Return type: (bool, list list) Derived from api method maya.OpenMaya.MFnDependencyNode.getAliasList
- getConnections()¶
Get all of the current connections to this node as an array of plugs.
Return type: PyNode list Derived from api method maya.OpenMaya.MFnDependencyNode.getConnections
- getName()¶
Returns the name of this node. Note that if the object the instance of this class is attached to is data instead of being in the graph (ie. the object was created by one of the MFn*Data function sets, or was passed to an MPxNode::compute function in a data block) then the name method will not work.
Return type: unicode Derived from api method maya.OpenMaya.MFnDependencyNode.name
- hasAttribute(attrName)¶
Returns true if the node already has an attribute with the given name.
Parameters: - attrName : unicode
Name of attribute to be checked.
Return type: bool
Derived from api method maya.OpenMaya.MFnDependencyNode.hasAttribute
- hasUniqueName()¶
Indicates whether or not this node’s name is unique within the scene.
Return type: bool Derived from api method maya.OpenMaya.MFnDependencyNode.hasUniqueName
- isFromReferencedFile()¶
Indicates whether or not this node came from a referenced file. If it did, the node will be marked as read-only in the scene and changes to the node’s attributes will be saved in the main scene file, not the referenced file from which the node came.
Return type: bool Derived from api method maya.OpenMaya.MFnDependencyNode.isFromReferencedFile
- isNewAttribute(attr)¶
Indicates whether or not the specified attribute was added to this node within the current scene.
Parameters: - attr : PyNode
Attribute to check.
Return type: bool
Derived from api method maya.OpenMaya.MFnDependencyNode.isNewAttribute
- plugsAlias(plug)¶
Returns the alias for the plug’s attribute or the empty string if that attribute has no alias.
Parameters: - plug : PyNode
plug for whose attribute we want the alias
Return type: unicode
Derived from api method maya.OpenMaya.MFnDependencyNode.plugsAlias
- removeAttribute(attribute)¶
Remove a dynamic attribute from a node.
Parameters: - attribute : PyNode
attribute to remove
Derived from api method maya.OpenMaya.MFnDependencyNode.removeAttribute
Undo is not currently supported for this method
- reorderedAttribute(index)¶
Some nodes, such as the various animCurve nodes, require that their attributes be set in a specific order for proper operation. Usually this ordering is only important when the node is being created during file I/O.
Parameters: - index : int
the reordered index of the attribute
Return type: PyNode
Derived from api method maya.OpenMaya.MFnDependencyNode.reorderedAttribute
- setAlias(alias, name, plug, add=True)¶
Sets or removes an alias (i.e. an alternative name) for an attribute.
Parameters: - alias : unicode
alternative name for the attribute
- name : unicode
real name of the attribute
- plug : PyNode
plug to the attribute
- add : bool
true to add the alias, false to remove it
Return type: bool
Derived from api method maya.OpenMaya.MFnDependencyNode.setAlias
- setFlag(flag, state)¶
Sets the state of the specified flag for the node.
Parameters: - flag : int
flag to set
- state : bool
new state to which the flag will be set
Derived from api method maya.OpenMaya.MFnDependencyNode.setFlag
Undo is not currently supported for this method
- setName(name, createNamespace=False)¶
Sets the name of this node.
Parameters: - name : unicode
the new name for the node
- createNamespace : bool
determine whether or not to create a new namespace when the given name includes a namespace which does not exist.
Return type: unicode
Derived from api method maya.OpenMaya.MFnDependencyNode.setName
- typeName()¶
Returns the type name of this node. The string returned is the name of the node type as it is used in the ascii file format.
Return type: unicode Derived from api method maya.OpenMaya.MFnDependencyNode.typeName