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


offsetSurface( [surface] , [caching=boolean], [constructionHistory=boolean], [distance=linear], [method=int], [name=string], [nodeState=int], [object=boolean])

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

offsetSurface is undoable, queryable, and editable.

The offset command creates new offset surfaces from the selected surfaces. The default method is a surface offset, which offsets relative to the surface itself. The CV offset method offsets the CVs directly rather than the surface, so is usually slightly less accurate but is faster. The offset surface will always have the same degree, number of CVs and knot spacing as the original surface.

Return value

string[]Object name and node name

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


caching, constructionHistory, distance, method, name, nodeState, object
Long name (short name) Argument types Properties
distance(d) linear createqueryedit
Offset distance
Default: 1.0
method(m) int createqueryedit
Offset method 0 - Surface Fit 1 - CV Fit
Default: 0
Advanced flags
caching(cch) boolean createqueryedit
Modifies the node caching mode. See the node documentation for more information.
Note: For advanced users only.
nodeState(nds) int createqueryedit
Modifies the node state. See the node documentation for more information.
Note: For advanced users only.
Common flags
name(n) string create
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.
constructionHistory(ch) boolean create
Turn the construction history on or off
object(o) boolean create
Create the result, or just the dependency node

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.

Python examples

import maya.cmds as cmds

# To offset the active surface to the specified distance:
cmds.offsetSurface( d=4.0 )

# To create an offset using the surface fit offset method:
cmds.offsetSurface( 'surface1', m=0, d=2.0 )