alignSurface

Show frames

Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

alignSurface( [surface] [surface] , [caching=boolean], [constructionHistory=boolean], [curvatureContinuity=boolean], [curvatureScale1=float], [curvatureScale2=float], [directionU=boolean], [joinParameter=float], [name=string], [nodeState=int], [object=boolean], [positionalContinuity=boolean], [positionalContinuityType=int], [replaceOriginal=boolean], [reverse1=boolean], [reverse2=boolean], [swap1=boolean], [swap2=boolean], [tangentContinuity=boolean], [tangentContinuityType=int], [tangentScale1=float], [tangentScale2=float], [twist=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

alignSurface is undoable, queryable, and editable.

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.

Return value

In query mode, return type is based on queried flag.

Flags

Long name (short name)	Argument types	Properties
curvatureContinuity(cc)	boolean
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)	boolean
If true use U direction of surface and V direction otherwise. Default: true
joinParameter(jnp)	float
Parameter on reference surface where modified surface is to be aligned to. Default: 123456.0
positionalContinuity(pc)	boolean
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
reverse1(rv1)	boolean
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)	boolean
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)	boolean
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)	boolean
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)	boolean
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)	boolean
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
constructionHistory(ch)	boolean
Turn the construction history on or off.
name(n)	string
Sets the name of the newly-created node. If it contains namespace path, the new node will be created under the specified namespace; if the namespace does not exist, it will be created.
object(o)	boolean
Create the result, or just the dependency node.
replaceOriginal(rpo)	boolean
Create "in place" (i.e., replace).
Advanced flags
caching(cch)	boolean
Modifies the node caching mode. See the node documentation for more information. Note: For advanced users only.
nodeState(nds)	int
Modifies the node state. See the node documentation for more information. Note: For advanced users only.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# Do modify positional continuity on both active surfaces with no history:
cmds.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):
cmds.alignSurface( tc=True, tct=2 )