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

Synopsis

offsetCurveOnSurface [-checkPoints] [-connectBreaks int] [-constructionHistory boolean] [-curveOnSurface boolean] [-cutLoop boolean] [-distance linear] [-name string] [-object boolean] [-polygon int] [-range boolean] [-rebuild boolean] [-replaceOriginal boolean] [-stitch boolean] [-subdivisionDensity int] [-tolerance linear] [curve]

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.

Flags

checkPoints, connectBreaks, constructionHistory, curveOnSurface, cutLoop, distance, name, object, polygon, range, rebuild, replaceOriginal, stitch, subdivisionDensity, tolerance
Long name (short name) [argument types] Properties
-cutLoop(-cl) boolean queryedit
Do loop cutting?
Default: false

In query mode, this flag needs a value.
-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.
-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.
-checkPoints(-cp) queryedit
Checkpoints for fit quality per span. Not advisable to change this value.
Default: 3

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

Return value


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

Related

offsetCurve

MEL examples

nurbsPlane -ch on -o on -po 0 -ax 0 1 0 -w 10 -lr 2 ;
circle -ch on -o on -nr 0 1 0 -r 3 ;
projectCurve -ch 0 -rn false -un false -tol 0.01 "nurbsCircle1" "nurbsPlane1" ;

// Offset given curve to the specified distance at the specified tolerance:
offsetCurveOnSurface -d 0.12 -tol 0.02 nurbsPlaneShape1->projectionCurve1_1;

// Create offsets for the specified curve and turn loop cutting off:
offsetCurveOnSurface -cl off nurbsPlaneShape1->projectionCurve1_1;

// Create offsets with circular arcs at the breaks in the curves and trim
// away any loops in the offset curve:
offsetCurveOnSurface -cb 1 -cl on nurbsPlaneShape1->projectionCurve1_1;