pymel.core.modeling.offsetCurve

offsetCurve(*args, **kwargs)

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:
Long name (short name) Argument Types Properties
caching (cch) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Modifies the node caching mode. See the node documentation for more information. Note:For advanced users only.
connectBreaks (cb) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Connect breaks method (between gaps): 0 - off, 1 - circular, 2 - linear Default:2
constructionHistory (ch) bool ../../../_images/create.gif
 
Turn the construction history on or off
cutLoop (cl) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Do loop cutting? Default:false
cutRadius (cr) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Loop cut radius. Only used if cutLoop attribute is set true. Default:0.0
distance (d) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Offset distance Default:1.0
name (n) unicode ../../../_images/create.gif
 
Name the resulting object
nodeState (nds) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Modifies the node state. See the node documentation for more information. Note:For advanced users only. Common flags
normal (nr) float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Offset plane normal Advanced flags
object (o) bool ../../../_images/create.gif
 
Create the result, or just the dependency node
range (rn) bool ../../../_images/create.gif
 
Force a curve range on complete input curve Flag can have multiple arguments, passed either as a tuple or a list.
reparameterize (rp) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Do reparameterization? Not advisable to change this value. Default:false
stitch (st) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Stitch curve segments together. Not advisable to change this value. Default:true
subdivisionDensity (sd) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Maximum subdivision density per span Default:5
tolerance (tol) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Tolerance Default:0.01
useGivenNormal (ugn) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Use the given normal (or, alternativelly, geometry normal) Default:1

Derived from mel command maya.cmds.offsetCurve

Example:

import pymel.core as pm

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

# create offsets for the specified curve and turn loop cutting off:
pm.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:
pm.offsetCurve( 'curve1', cb=1, cl=True, cr=2.0 )

Previous topic

pymel.core.modeling.nurbsUVSet

Next topic

pymel.core.modeling.offsetCurveOnSurface

Core

Core Modules

Other Modules

This Page