pymel.core.modeling.offsetCurveOnSurface¶

offsetCurveOnSurface(*args, **kwargs)¶

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:

Long Name / Short Name		Argument Types	Properties
caching / cch		bool
	Toggle caching for all attributes so that no recomputation is needed
checkPoints / cp		int
	Checkpoints for fit quality per span. Not advisable to change this value. Default:3
connectBreaks / cb		int
	Connect breaks method (between gaps): 0 - off, 1 - circular, 2 - linear Default:2
constructionHistory / ch		bool
	Turn the construction history on or off.
cutLoop / cl		bool
	Do loop cutting. Default:false
distance / d		float
	Offset distance Default:1.0
frozen / fzn		bool
name / n		unicode
	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.
nodeState / nds		int
	Maya dependency nodes have 6 possible states. The Normal (0), HasNoEffect (1), and Blocking (2)states can be used to alter how the graph is evaluated. The Waiting-Normal (3), Waiting-HasNoEffect (4), Waiting-Blocking (5)are for internal use only. They temporarily shut off parts of the graph during interaction (e.g., manipulation). The understanding is that once the operation is done, the state will be reset appropriately, e.g. Waiting-Blockingwill reset back to Blocking. The Normaland Blockingcases apply to all nodes, while HasNoEffectis node specific; many nodes do not support this option. Plug-ins store state in the MPxNode::stateattribute. Anyone can set it or check this attribute. Additional details about each of these 3 states follow. StateDescriptionNormalThe normal node state. This is the default.HasNoEffectThe HasNoEffectoption (a.k.a. pass-through), is used in cases where there is an operation on an input producing an output of the same data type. Nearly all deformers support this state, as do a few other nodes. As stated earlier, it is not supported by all nodes. Its typical to implement support for the HasNoEffectstate in the nodes compute method and to perform appropriate operations. Plug-ins can also support HasNoEffect. The usual implementation of this state is to copy the input directly to the matching output without applying the algorithm in the node. For deformers, applying this state leaves the input geometry undeformed on the output. BlockingThis is implemented in the depend node base class and applies to all nodes. Blockingis applied during the evaluation phase to connections. An evaluation request to a blocked connection will return as failures, causing the destination plug to retain its current value. Dirty propagation is indirectly affected by this state since blocked connections are never cleaned. When a node is set to Blockingthe behavior is supposed to be the same as if all outgoing connections were broken. As long as nobody requests evaluation of the blocked node directly it wont evaluate after that. Note that a blocked node will still respond to getAttrrequests but a getAttron a downstream node will not reevaluate the blocked node. Setting the root transform of a hierarchy to Blockingwont automatically influence child transforms in the hierarchy. To do this, youd need to explicitly set all child nodes to the Blockingstate. For example, to set all child transforms to Blocking, you could use the following script. import maya.cmds as cmds def blockTree(root): nodesToBlock = [] for node in {child:1 for child in cmds.listRelatives( root, path=True, allDescendents=True )}.keys(): nodesToBlock += cmds.listConnections(node, source=True, destination=True ) for node in {source:1 for source in nodesToBlock}.keys(): cmds.setAttr( ‘%s.nodeState’ % node, 2 ) Applying this script would continue to draw objects but things would not be animated. Default:kdnNormal
object / o		bool
	Create the result, or just the dependency node.
range / rn		bool
	Force a curve range on complete input curve. Flag can have multiple arguments, passed either as a tuple or a list.
stitch / st		bool
	Stitch curve segments together. Not advisable to change this value. Default:true
subdivisionDensity / sd		int
	Maximum subdivision density per span Default:5
tolerance / tol		float
	Tolerance Default:0.01 Common flags

Derived from mel command maya.cmds.offsetCurveOnSurface

Example:

import pymel.core as pm

pm.nurbsPlane( ch=True, o=True, po=0, ax=(0, 1, 0), w=10, lr=2 )
# Result: [nt.Transform(u'nurbsPlane1'), nt.MakeNurbPlane(u'makeNurbPlane1')] #
pm.circle( ch=True, o=True, nr=(0, 1, 0), r=3 )
# Result: [nt.Transform(u'nurbsCircle1'), nt.MakeNurbCircle(u'makeNurbCircle1')] #
pm.projectCurve( 'nurbsCircle1', 'nurbsPlane1', ch=0, rn=False, un=False, tol=0.01 )
# Result: [nt.CurveVarGroup(u'nurbsPlaneShape1->projectionCurve1')] #

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

# Create offsets for the specified curve and turn loop cutting off:
pm.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:
pm.offsetCurveOnSurface( 'nurbsPlaneShape1-"projectionCurve1_1', cb=1, cl=False )