class counterpart of mel function choice
The choice command provides a mechanism for changing the inputs to an attribute based on some (usually time-based) criteria. For example, an object could be animated from frames 1 to 30 by a motion path, then from frames 30 to 50 it follows keyframe animation, and after frame 50 it returns to the motion path. Or, a revolve surface could change its input curve depending on some transform’s rotation value.The choice command creates a choice node (if one does not already exist) on all specified attributes of the selected objects. If the attribute was already connected to something, that something is now reconnected to the i’th index of the choice node’s input (or the next available input if the -in/index flag is not specified). If a source attribute is specified, then that attribute is connected to the choice node’s i’th input instead.The choice node operates by using the value of its selector attribute to determine which of its input attributes to pass through to its output. The input attributes can be of any type. For example, if the selector attribute was connected by an animation curve with keyframes at (1,1), (30,2) and (50,1), then that would mean that the choice node would pass on the data from input[1] from time 1 to 30, and after time 50, and the data from input[2] between times 30 and 50.This command returns the names of the created or modified choice nodes, and if a keyframe was added to the animation curve, it specifies the index (or value on the animation curve).
Add a new dynamic attibute to this node.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MFnDependencyNode.addAttribute
Undo is not currently supported for this method
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 : |
|
---|---|
Return type: | int |
Derived from api method maya.OpenMaya.MFnDependencyNode.allocateFlag
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 : |
|
---|---|
Return type: | PyNode |
Derived from api method maya.OpenMaya.MFnDependencyNode.attribute
Returns the class (normal, dynamic, extension) of the specified attribute.
Parameters : |
|
---|---|
Return type: |
Derived from api method maya.OpenMaya.MFnDependencyNode.attributeClass
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 : |
|
---|
Derived from api method maya.OpenMaya.MFnDependencyNode.deallocateAllFlags
Undo is not currently supported for this method
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 : |
|
---|
Derived from api method maya.OpenMaya.MFnDependencyNode.deallocateFlag
Undo is not currently supported for this method
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 : |
|
---|
Derived from api method maya.OpenMaya.MFnDependencyNode.dgCallbacks
Undo is not currently supported for this method
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 : |
|
---|---|
Return type: | float |
Derived from api method maya.OpenMaya.MFnDependencyNode.dgTimer
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
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
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
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
Retrieves the attribute with the given alias.
Parameters : |
|
---|---|
Return type: | (bool, PyNode) |
Derived from api method maya.OpenMaya.MFnDependencyNode.findAlias
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 : |
|
---|---|
Return type: | PyNode |
Derived from api method maya.OpenMaya.MFnDependencyNode.findPlug
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 : |
|
---|---|
Return type: | PyNode list |
Derived from api method maya.OpenMaya.MFnDependencyNode.getAffectedAttributes
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 : |
|
---|---|
Return type: | PyNode list |
Derived from api method maya.OpenMaya.MFnDependencyNode.getAffectedByAttributes
Returns the node’s alias attribute, which is a special attribute used to store information about the node’s attribute aliases.
Parameters : |
|
---|---|
Return type: | PyNode |
Derived from api method maya.OpenMaya.MFnDependencyNode.getAliasAttr
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
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
specifies the multi-input index of the choice node to connect the source attribute to. When queried, returns a list of integers one per specified -t/time that indicates the multi-index of the choice node to use at that time.
Derived from mel command maya.cmds.choice
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
specifies the attribute to be used as the choice node’s selector. The value of the selector at a given time determines which of the choice node’s multi-indices should be used as the output of the choice node at that time. This flag is only editable (it cannot be specified at creation time). When queried, returns a list of strings.
Derived from mel command maya.cmds.choice
Returns true if the node already has an attribute with the given name.
Parameters : |
|
---|---|
Return type: | bool |
Derived from api method maya.OpenMaya.MFnDependencyNode.hasAttribute
Indicates whether or not this node’s name is unique within the scene.
Return type: | bool |
---|
Derived from api method maya.OpenMaya.MFnDependencyNode.hasUniqueName
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
Indicates whether or not the specified attribute was added to this node within the current scene.
Parameters : |
|
---|---|
Return type: | bool |
Derived from api method maya.OpenMaya.MFnDependencyNode.isNewAttribute
Returns the alias for the plug’s attribute or the empty string if that attribute has no alias.
Parameters : |
|
---|---|
Return type: | unicode |
Derived from api method maya.OpenMaya.MFnDependencyNode.plugsAlias
Remove a dynamic attribute from a node.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MFnDependencyNode.removeAttribute
Undo is not currently supported for this method
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 : |
|
---|---|
Return type: | PyNode |
Derived from api method maya.OpenMaya.MFnDependencyNode.reorderedAttribute
Sets or removes an alias (i.e. an alternative name) for an attribute.
Parameters : |
|
---|---|
Return type: | bool |
Derived from api method maya.OpenMaya.MFnDependencyNode.setAlias
Sets the state of the specified flag for the node.
Parameters : |
|
---|
Derived from api method maya.OpenMaya.MFnDependencyNode.setFlag
Undo is not currently supported for this method
Sets the name of this node.
Parameters : |
|
---|---|
Return type: | unicode |
Derived from api method maya.OpenMaya.MFnDependencyNode.setName
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