pymel.core.nodetypes.AlignSurface¶

digraph inheritance9f7419991f { rankdir=TB; ranksep=0.15; nodesep=0.15; size="8.0, 12.0"; "AbstractBaseCreate" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.AbstractBaseCreate.html#pymel.core.nodetypes.AbstractBaseCreate",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "DependNode" -> "AbstractBaseCreate" [arrowsize=0.5,style="setlinewidth(0.5)"]; "AlignSurface" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="#pymel.core.nodetypes.AlignSurface",style="setlinewidth(0.5)",tooltip="class counterpart of mel function `alignSurface`",height=0.25,shape=box,fontsize=8]; "AbstractBaseCreate" -> "AlignSurface" [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 AlignSurface(*args, **kwargs)¶

class counterpart of mel function alignSurface

The surface align command is used to align surfaces in maya. The main alignment options are positional, tangent and curvature continuity. Curvature continuity implies tangent continuity. NOTE: this tool is based on Studio’s align tool. Positional continuity means the surfaces (move) or the ends of the surfaces (modify) are changed. Tangent continuity means one of the surfaces is modified to be tangent at the points where they meet. Curvature continuity means one of the surfaces is modified to be curvature continuous as well as tangent. The default behaviour, when no surfaces or flags are passed, is to only do positional and tangent continuity on the active list with the end of the first surface and the start of the other surface used for alignment.

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'))¶

getCaching(**kwargs)¶

Toggle caching for all attributes so that no recomputation is needed

Derived from mel command maya.cmds.alignSurface

getCurvatureContinuity(**kwargs)¶

Curvature continuity is on if true and off otherwise. Default:false

Derived from mel command maya.cmds.alignSurface

getCurvatureScale1(**kwargs)¶

Curvature scale applied to curvature of first surface for curvature continuity. Default:0.0

Derived from mel command maya.cmds.alignSurface

getCurvatureScale2(**kwargs)¶

Curvature scale applied to curvature of second surface for curvature continuity. Default:0.0

Derived from mel command maya.cmds.alignSurface

getDirectionU(**kwargs)¶

If true use U direction of surface and V direction otherwise. Default:true

Derived from mel command maya.cmds.alignSurface

getJoinParameter(**kwargs)¶

Parameter on reference surface where modified surface is to be aligned to. Default:123456.0

Derived from mel command maya.cmds.alignSurface

getNodeState(**kwargs)¶

Maya dependency nodes have 6 possible states. The Normal (0), HasNoEffect (1), and Blocking (2)states can be used to alter how the graph is evaluated. The Waiting-Normal (3), Waiting-HasNoEffect (4), Waiting-Blocking (5)are for internal use only. They temporarily shut off parts of the graph during interaction (e.g., manipulation). The understanding is that once the operation is done, the state will be reset appropriately, e.g. Waiting-Blockingwill reset back to Blocking. The Normaland Blockingcases apply to all nodes, while HasNoEffectis node specific; many nodes do not support this option. Plug-ins store state in the MPxNode::stateattribute. Anyone can set it or check this attribute. Additional details about each of these 3 states follow. StateDescriptionNormalThe normal node state. This is the default.HasNoEffectThe HasNoEffectoption (a.k.a. pass-through), is used in cases where there is an operation on an input producing an output of the same data type. Nearly all deformers support this state, as do a few other nodes. As stated earlier, it is not supported by all nodes. Its typical to implement support for the HasNoEffectstate in the nodes compute method and to perform appropriate operations. Plug-ins can also support HasNoEffect. The usual implementation of this state is to copy the input directly to the matching output without applying the algorithm in the node. For deformers, applying this state leaves the input geometry undeformed on the output. BlockingThis is implemented in the depend node base class and applies to all nodes. Blockingis applied during the evaluation phase to connections. An evaluation request to a blocked connection will return as failures, causing the destination plug to retain its current value. Dirty propagation is indirectly affected by this state since blocked connections are never cleaned. When a node is set to Blockingthe behavior is supposed to be the same as if all outgoing connections were broken. As long as nobody requests evaluation of the blocked node directly it wont evaluate after that. Note that a blocked node will still respond to getAttrrequests but a getAttron a downstream node will not reevaluate the blocked node. Setting the root transform of a hierarchy to Blockingwont automatically influence child transforms in the hierarchy. To do this, youd need to explicitly set all child nodes to the Blockingstate. For example, to set all child transforms to Blocking, you could use the following script. import maya.cmds as cmds def blockTree(root): nodesToBlock = [] for node in {child:1 for child in cmds.listRelatives( root, path=True, allDescendents=True )}.keys(): nodesToBlock += cmds.listConnections(node, source=True, destination=True ) for node in {source:1 for source in nodesToBlock}.keys(): cmds.setAttr( ‘%s.nodeState’ % node, 2 ) Applying this script would continue to draw objects but things would not be animated. Default:kdnNormal

Derived from mel command maya.cmds.alignSurface

getPositionalContinuity(**kwargs)¶

Positional continuity is on if true and off otherwise. Default:true

Derived from mel command maya.cmds.alignSurface

getPositionalContinuityType(**kwargs)¶

Positional continuity type legal values: 1 - move first surface, 2 - move second surface, 3 - move both surfaces, 4 - modify first surface, 5 - modify second surface, 6 - modify both surfaces Default:1

Derived from mel command maya.cmds.alignSurface

getReverse1(**kwargs)¶

If true, reverse the direction (specified by directionU) of the first input surface before doing align. Otherwise, do nothing to the first input surface before aligning. NOTE: setting this attribute to random values will cause unpredictable results and is not supported. Default:false

Derived from mel command maya.cmds.alignSurface

getReverse2(**kwargs)¶

If true, reverse the direction (specified by directionU) of the second input surface before doing align. Otherwise, do nothing to the second input surface before aligning. NOTE: setting this attribute to random values will cause unpredictable results and is not supported. Default:false

Derived from mel command maya.cmds.alignSurface

getSwap1(**kwargs)¶

If true, swap the UV directions of the first input surface before doing align. Otherwise, do nothing to the first input surface before aligning. NOTE: setting this attribute to random values will cause unpredictable results and is not supported. Default:false

Derived from mel command maya.cmds.alignSurface

getSwap2(**kwargs)¶

If true, swap the UV directions of the second input surface before doing align. Otherwise, do nothing to the second input surface before aligning. NOTE: setting this attribute to random values will cause unpredictable results and is not supported. Default:false

Derived from mel command maya.cmds.alignSurface

getTangentContinuity(**kwargs)¶

Tangent continuity is on if true and off otherwise. Default:true

Derived from mel command maya.cmds.alignSurface

getTangentContinuityType(**kwargs)¶

Tangent continuity type legal values: 1 - do tangent continuity on first surface, 2 - do tangent continuity on second surface Default:1

Derived from mel command maya.cmds.alignSurface

getTangentScale1(**kwargs)¶

Tangent scale applied to tangent of first surface for tangent continuity. Default:1.0

Derived from mel command maya.cmds.alignSurface

getTangentScale2(**kwargs)¶

Tangent scale applied to tangent of second surface for tangent continuity. Default:1.0

Derived from mel command maya.cmds.alignSurface

getTwist(**kwargs)¶

If true, reverse the second surface in the opposite direction (specified by directionU) before doing align. This will avoid twists in the aligned surfaces. Otherwise, do nothing to the second input surface before aligning. NOTE: setting this attribute to random values will cause unpredictable results and is not supported. Default:false Common flags

Derived from mel command maya.cmds.alignSurface

setCaching(val=True, **kwargs)¶

Toggle caching for all attributes so that no recomputation is needed

Derived from mel command maya.cmds.alignSurface

setCurvatureContinuity(val=True, **kwargs)¶

Curvature continuity is on if true and off otherwise. Default:false

Derived from mel command maya.cmds.alignSurface

setCurvatureScale1(val=True, **kwargs)¶

Curvature scale applied to curvature of first surface for curvature continuity. Default:0.0

Derived from mel command maya.cmds.alignSurface

setCurvatureScale2(val=True, **kwargs)¶

Curvature scale applied to curvature of second surface for curvature continuity. Default:0.0

Derived from mel command maya.cmds.alignSurface

setDirectionU(val=True, **kwargs)¶

If true use U direction of surface and V direction otherwise. Default:true

Derived from mel command maya.cmds.alignSurface

setJoinParameter(val=True, **kwargs)¶

Parameter on reference surface where modified surface is to be aligned to. Default:123456.0

Derived from mel command maya.cmds.alignSurface

setNodeState(val=True, **kwargs)¶

Maya dependency nodes have 6 possible states. The Normal (0), HasNoEffect (1), and Blocking (2)states can be used to alter how the graph is evaluated. The Waiting-Normal (3), Waiting-HasNoEffect (4), Waiting-Blocking (5)are for internal use only. They temporarily shut off parts of the graph during interaction (e.g., manipulation). The understanding is that once the operation is done, the state will be reset appropriately, e.g. Waiting-Blockingwill reset back to Blocking. The Normaland Blockingcases apply to all nodes, while HasNoEffectis node specific; many nodes do not support this option. Plug-ins store state in the MPxNode::stateattribute. Anyone can set it or check this attribute. Additional details about each of these 3 states follow. StateDescriptionNormalThe normal node state. This is the default.HasNoEffectThe HasNoEffectoption (a.k.a. pass-through), is used in cases where there is an operation on an input producing an output of the same data type. Nearly all deformers support this state, as do a few other nodes. As stated earlier, it is not supported by all nodes. Its typical to implement support for the HasNoEffectstate in the nodes compute method and to perform appropriate operations. Plug-ins can also support HasNoEffect. The usual implementation of this state is to copy the input directly to the matching output without applying the algorithm in the node. For deformers, applying this state leaves the input geometry undeformed on the output. BlockingThis is implemented in the depend node base class and applies to all nodes. Blockingis applied during the evaluation phase to connections. An evaluation request to a blocked connection will return as failures, causing the destination plug to retain its current value. Dirty propagation is indirectly affected by this state since blocked connections are never cleaned. When a node is set to Blockingthe behavior is supposed to be the same as if all outgoing connections were broken. As long as nobody requests evaluation of the blocked node directly it wont evaluate after that. Note that a blocked node will still respond to getAttrrequests but a getAttron a downstream node will not reevaluate the blocked node. Setting the root transform of a hierarchy to Blockingwont automatically influence child transforms in the hierarchy. To do this, youd need to explicitly set all child nodes to the Blockingstate. For example, to set all child transforms to Blocking, you could use the following script. import maya.cmds as cmds def blockTree(root): nodesToBlock = [] for node in {child:1 for child in cmds.listRelatives( root, path=True, allDescendents=True )}.keys(): nodesToBlock += cmds.listConnections(node, source=True, destination=True ) for node in {source:1 for source in nodesToBlock}.keys(): cmds.setAttr( ‘%s.nodeState’ % node, 2 ) Applying this script would continue to draw objects but things would not be animated. Default:kdnNormal

Derived from mel command maya.cmds.alignSurface

setPositionalContinuity(val=True, **kwargs)¶

Positional continuity is on if true and off otherwise. Default:true

Derived from mel command maya.cmds.alignSurface

setPositionalContinuityType(val=True, **kwargs)¶

Positional continuity type legal values: 1 - move first surface, 2 - move second surface, 3 - move both surfaces, 4 - modify first surface, 5 - modify second surface, 6 - modify both surfaces Default:1

Derived from mel command maya.cmds.alignSurface

setReverse1(val=True, **kwargs)¶

If true, reverse the direction (specified by directionU) of the first input surface before doing align. Otherwise, do nothing to the first input surface before aligning. NOTE: setting this attribute to random values will cause unpredictable results and is not supported. Default:false

Derived from mel command maya.cmds.alignSurface

setReverse2(val=True, **kwargs)¶

If true, reverse the direction (specified by directionU) of the second input surface before doing align. Otherwise, do nothing to the second input surface before aligning. NOTE: setting this attribute to random values will cause unpredictable results and is not supported. Default:false

Derived from mel command maya.cmds.alignSurface

setSwap1(val=True, **kwargs)¶

If true, swap the UV directions of the first input surface before doing align. Otherwise, do nothing to the first input surface before aligning. NOTE: setting this attribute to random values will cause unpredictable results and is not supported. Default:false

Derived from mel command maya.cmds.alignSurface

setSwap2(val=True, **kwargs)¶

If true, swap the UV directions of the second input surface before doing align. Otherwise, do nothing to the second input surface before aligning. NOTE: setting this attribute to random values will cause unpredictable results and is not supported. Default:false

Derived from mel command maya.cmds.alignSurface

setTangentContinuity(val=True, **kwargs)¶

Tangent continuity is on if true and off otherwise. Default:true

Derived from mel command maya.cmds.alignSurface

setTangentContinuityType(val=True, **kwargs)¶

Tangent continuity type legal values: 1 - do tangent continuity on first surface, 2 - do tangent continuity on second surface Default:1

Derived from mel command maya.cmds.alignSurface

setTangentScale1(val=True, **kwargs)¶

Tangent scale applied to tangent of first surface for tangent continuity. Default:1.0

Derived from mel command maya.cmds.alignSurface

setTangentScale2(val=True, **kwargs)¶

Tangent scale applied to tangent of second surface for tangent continuity. Default:1.0

Derived from mel command maya.cmds.alignSurface

setTwist(val=True, **kwargs)¶

If true, reverse the second surface in the opposite direction (specified by directionU) before doing align. This will avoid twists in the aligned surfaces. Otherwise, do nothing to the second input surface before aligning. NOTE: setting this attribute to random values will cause unpredictable results and is not supported. Default:false Common flags

Derived from mel command maya.cmds.alignSurface