pymel.core.modeling.alignSurface

alignSurface(*args, **kwargs)

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.

Flags:

Long name (short name)		Argument Types	Properties
attach (at)		bool
caching (cch)		bool
	Modifies the node caching mode. See the node documentation for more information. Note:For advanced users only.
constructionHistory (ch)		bool
	Turn the construction history on or off
curvatureContinuity (cc)		bool
	Curvature continuity is on if true and off otherwise. Default:false
curvatureScale1 (cs1)		float
	Curvature scale applied to curvature of first surface for curvature continuity. Default:0.0
curvatureScale2 (cs2)		float
	Curvature scale applied to curvature of second surface for curvature continuity. Default:0.0
directionU (du)		bool
	If true use U direction of surface and V direction otherwise. Default:true Advanced flags
joinParameter (jnp)		float
	Parameter on reference surface where modified surface is to be aligned to. Default:123456.0
keepMultipleKnots (kmk)		bool
name (n)		unicode
	Name the resulting object
nodeState (nds)		int
	Modifies the node state. See the node documentation for more information. Note:For advanced users only. Common flags
object (o)		bool
	Create the result, or just the dependency node
positionalContinuity (pc)		bool
	Positional continuity is on if true and off otherwise. Default:true
positionalContinuityType (pct)		int
	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
replaceOriginal (rpo)		bool
	Create in place(i.e., replace) Flag can have multiple arguments, passed either as a tuple or a list.
reverse1 (rv1)		bool
	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
reverse2 (rv2)		bool
	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
swap1 (sw1)		bool
	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
swap2 (sw2)		bool
	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
tangentContinuity (tc)		bool
	Tangent continuity is on if true and off otherwise. Default:true
tangentContinuityType (tct)		int
	Tangent continuity type legal values: 1 - do tangent continuity on first surface, 2 - do tangent continuity on second surface Default:1
tangentScale1 (ts1)		float
	Tangent scale applied to tangent of first surface for tangent continuity. Default:1.0
tangentScale2 (ts2)		float
	Tangent scale applied to tangent of second surface for tangent continuity. Default:1.0
twist (tw)		bool
	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

Derived from mel command maya.cmds.alignSurface

Example:

import pymel.core as pm

# Do modify positional continuity on both active surfaces with no history:
pm.alignSurface( ch=False, pc=True, pct=6 )

# Do positional and tangent continuity, with the second surface
# tangent modified (by default move position continuity is done
# on the first surface):
pm.alignSurface( tc=True, tct=2 )