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


offsetCurveOnSurface( [curve] , [caching=boolean], [checkPoints=int], [connectBreaks=int], [constructionHistory=boolean], [cutLoop=boolean], [distance=linear], [name=string], [nodeState=int], [object=boolean], [range=boolean], [stitch=boolean], [subdivisionDensity=int], [tolerance=linear])

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

offsetCurveOnSurface is undoable, queryable, and editable.

The offsetCurveOnSurface command offsets a curve on surface resulting in another curve on surface. The connecting type for breaks in offsets is off (no connection), circular (connect with an arc) or linear (connect linearly resulting in a sharp corner). If loop cutting is on then any loops in the offset curves are trimmed away and a sharp corner is created at each intersection. The subdivisionDensity flag is the maximum number of times the offset object can be subdivided (i.e. calculate the offset until the offset comes within tolerance or the iteration reaches this maximum.) The checkPoints flag sets the number of points per span at which the distance of the offset curve from the original curve is determined. The tolerance flag determines how accurately the offset curve should satisfy the required offset distance. A satisfactory offset curve is one for which all of the checkpoints are within the given tolerance of the required offset.

Return value

string[]Object name and node name

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




caching, checkPoints, connectBreaks, constructionHistory, cutLoop, distance, name, nodeState, object, range, stitch, subdivisionDensity, tolerance
Long name (short name) Argument types Properties
cutLoop(cl) boolean createqueryedit
Do loop cutting?
Default: false
connectBreaks(cb) int createqueryedit
Connect breaks method (between gaps): 0 - off, 1 - circular, 2 - linear
Default: 2
distance(d) linear createqueryedit
Offset distance
Default: 1.0
tolerance(tol) linear createqueryedit
Default: 0.01
subdivisionDensity(sd) int createqueryedit
Maximum subdivision density per span
Default: 5
checkPoints(cp) int createqueryedit
Checkpoints for fit quality per span. Not advisable to change this value.
Default: 3
stitch(st) boolean createqueryedit
Stitch curve segments together. Not advisable to change this value.
Default: true
Advanced flags
caching(cch) boolean createqueryedit
Modifies the node caching mode. See the node documentation for more information.
Note: For advanced users only.
nodeState(nds) int createqueryedit
Modifies the node state. See the node documentation for more information.
Note: For advanced users only.
Common flags
name(n) string create
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.
constructionHistory(ch) boolean create
Turn the construction history on or off
object(o) boolean create
Create the result, or just the dependency node
range(rn) boolean create
Force a curve range on complete input curve

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

cmds.nurbsPlane( ch=True, o=True, po=0, ax=(0, 1, 0), w=10, lr=2 )
cmds.circle( ch=True, o=True, nr=(0, 1, 0), r=3 )
cmds.projectCurve( 'nurbsCircle1', 'nurbsPlane1', ch=0, rn=False, un=False, tol=0.01 )

# Offset given curve to the specified distance at the specified tolerance:
cmds.offsetCurveOnSurface( 'nurbsPlaneShape1->projectionCurve1_1', d=0.12, tol=0.02 )

# Create offsets for the specified curve and turn loop cutting off:
cmds.offsetCurveOnSurface( 'nurbsPlaneShape1->projectionCurve1_1', cl=False )

# Create offsets with circular arcs at the breaks in the curves and trim
# away any loops in the offset curve:
cmds.offsetCurveOnSurface( 'nurbsPlaneShape1->projectionCurve1_1', cb=1, cl=False )