offsetCurve command

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

Synopsis

offsetCurve [-connectBreaks int] [-constructionHistory boolean] [-cutLoop boolean] [-cutRadius linear] [-distance linear] [-name string] [-normal float float float] [-normalX linear] [-normalY linear] [-normalZ linear] [-object boolean] [-parameter float] [-range boolean] [-reparameterize boolean] [-stitch boolean] [-subdivisionDensity int] [-tolerance linear] [-useGivenNormal boolean] [-useParameter boolean] [curve]

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.

Return value

string[] Object name and node name

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

offsetCurveOnSurface

Flags

connectBreaks, constructionHistory, cutLoop, cutRadius, distance, name, normal, normalX, normalY, normalZ, object, parameter, range, reparameterize, stitch, subdivisionDensity, tolerance, useGivenNormal, useParameter

Long name (short name) argument types Properties

-connectBreaks(-cb) int

Connect breaks method (between gaps): 0 - off, 1 - circular, 2 - linear
Default: 2

-reparameterize(-rp) boolean

Do reparameterization? Not advisable to change this value.
Default: false

-stitch(-st) boolean

Stitch curve segments together. Not advisable to change this value.
Default: true

-cutLoop(-cl) boolean

Do loop cutting?
Default: false

-cutRadius(-cr) linear

Loop cut radius. Only used if cutLoop attribute is set true.
Default: 0.0

-distance(-d) linear

Offset distance
Default: 1.0

-tolerance(-tol) linear

Tolerance
Default: 0.01

-subdivisionDensity(-sd) int

Maximum subdivision density per span
Default: 5

-useGivenNormal(-ugn) boolean

Use the given normal (or, alternativelly, geometry normal)
Default: 1

-normal(-nr) float float float

Offset plane normal

-normalX(-nrx) linear

X of the normal
Default: 0.0

-normalY(-nry) linear

Y of the normal
Default: 1.0

-normalZ(-nrz) linear

Z of the normal
Default: 0.0

-parameter(-p) float

parameter value on the curve to use while drawing manipulator on offset history
Default: 0.0

-useParameter(-up) boolean

use parameter value on the curve while drawing manipulator on offset history
Default: false

Common flags

-name(-n) string

Name the resulting object

-constructionHistory(-ch) boolean

Turn the construction history on or off

-object(-o) boolean

Create the result, or just the dependency node

-range(-rn) boolean

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 be used more than once in a command

MEL examples

// offset all active curves to the specified distance:
offsetCurve -d 4.0;

// create offsets for the specified curve and turn loop cutting off:
offsetCurve -cl off curve1;

// 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:
offsetCurve -cb 1 -cl on -cr 2.0 curve1;