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

Synopsis

offsetCurve( [curve] , [connectBreaks=int], [constructionHistory=boolean], [curveOnSurface=boolean], [cutLoop=boolean], [cutRadius=linear], [distance=linear], [name=string], [normal=[float, float, float]], [normalX=linear], [normalY=linear], [normalZ=linear], [object=boolean], [parameter=float], [polygon=int], [range=boolean], [rebuild=boolean], [reparameterize=boolean], [replaceOriginal=boolean], [stitch=boolean], [subdivisionDensity=int], [tolerance=linear], [useGivenNormal=boolean], [useParameter=boolean])

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

offsetCurve is undoable, queryable, and editable.

The offset command creates new offset curves from the selected curves. 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. For the default cut radius of 0.0 a sharp corner is created at each intersection. For values greater than 0.0 a small arc of that radius is created at each intersection. The cut radius value is only valid when loop cutting is on. Offsets (for planar curves) are calculated in the plane of that curve and 3d curves are offset in 3d. 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 reparameterize option allows the offset curve to have a different parameterization to the original curve. This avoids uneven parameter distributions in the offset curve that can occur with large offsets of curves, but is more expensive to compute.

Flags

connectBreaks, constructionHistory, curveOnSurface, cutLoop, cutRadius, distance, name, normal, normalX, normalY, normalZ, object, parameter, polygon, range, rebuild, reparameterize, replaceOriginal, stitch, subdivisionDensity, tolerance, useGivenNormal, useParameter
Long name (short name) [argument types] Properties
connectBreaks(cb) int queryedit
Connect breaks method (between gaps): 0 - off, 1 - circular, 2 - linear
Default: 2

In query mode, this flag needs a value.
reparameterize(rp) boolean queryedit
Do reparameterization? Not advisable to change this value.
Default: false

In query mode, this flag needs a value.
stitch(st) boolean queryedit
Stitch curve segments together. Not advisable to change this value.
Default: true

In query mode, this flag needs a value.
cutLoop(cl) boolean queryedit
Do loop cutting?
Default: false

In query mode, this flag needs a value.
cutRadius(cr) linear queryedit
Loop cut radius. Only used if cutLoop attribute is set true.
Default: 0.0

In query mode, this flag needs a value.
distance(d) linear queryedit
Offset distance
Default: 1.0

In query mode, this flag needs a value.
tolerance(tol) linear queryedit
Tolerance
Default: 0.01

In query mode, this flag needs a value.
subdivisionDensity(sd) int queryedit
Maximum subdivision density per span
Default: 5

In query mode, this flag needs a value.
useGivenNormal(ugn) boolean queryedit
Use the given normal (or, alternativelly, geometry normal)
Default: 1

In query mode, this flag needs a value.
normal(nr) [float, float, float] queryedit
Offset plane normal

In query mode, this flag needs a value.
normalX(nrx) linear queryedit
X of the normal
Default: 0.0

In query mode, this flag needs a value.
normalY(nry) linear queryedit
Y of the normal
Default: 1.0

In query mode, this flag needs a value.
normalZ(nrz) linear queryedit
Z of the normal
Default: 0.0

In query mode, this flag needs a value.
parameter(p) float queryedit
parameter value on the curve to use while drawing manipulator on offset history
Default: 0.0

In query mode, this flag needs a value.
useParameter(up) boolean queryedit
use parameter value on the curve while drawing manipulator on offset history
Default: false

In query mode, this flag needs a value.
name(n) string create
Name the resulting object
constructionHistory(ch) boolean create
Turn the construction history on or off (not available in all commands)
object(o) boolean create
Create the result, or just the dependency node (not available in all commands)
replaceOriginal(rpo) boolean create
Create "in place" (i.e., replace) (not available in all commands)
curveOnSurface(cos) boolean create
If possible, create 2D curve as a result (not available in all commands)
polygon(po) int create
The value of this argument controls the type of the object created by this operation (not available in all commands)
  • 0: nurbs surface
  • 1: polygon (use nurbsToPolygonsPref to set the parameters for the conversion)
  • 2: subdivision surface (use nurbsToSubdivPref to set the parameters for the conversion)
  • 3: Bezier surface
  • 4: subdivision surface solid (use nurbsToSubdivPref to set the parameters for the conversion)
range(rn) boolean create
Force a curve range on complete input curve (not available in all commands)
rebuild(rb) boolean create
Rebuild the input curve(s) before using them in the operation. Use nurbsCurveRebuildPref to set the parameters for the conversion. (not available in all commands)
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.

Return value


[string[]] (object name and node name)

Related

offsetCurveOnSurface

Python examples

import maya.cmds as cmds

# offset all active curves to the specified distance:
cmds.offsetCurve( d=4.0 )

# create offsets for the specified curve and turn loop cutting off:
cmds.offsetCurve( 'curve1', cl=False)

# create offsets with circular arcs at the breaks in the curve and use
# a cutting radius of 2.0 if there are any loops in the offsets:
cmds.offsetCurve( 'curve1', cb=1, cl=True, cr=2.0 )