extrude command

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

Synopsis

extrude( curve1 [curve2] , [constructionHistory=boolean], [curveOnSurface=boolean], [degreeAlongLength=boolean], [direction=[float, float, float]], [directionX=linear], [directionY=linear], [directionZ=linear], [extrudeType=int], [fixedPath=boolean], [length=linear], [name=string], [object=boolean], [pivot=[float, float, float]], [pivotX=linear], [pivotY=linear], [pivotZ=linear], [polygon=int], [range=boolean], [rebuild=boolean], [replaceOriginal=boolean], [reverseSurfaceIfPathReversed=boolean], [rotation=angle], [scale=float], [subCurveSubSurface=boolean], [useComponentPivot=int], [useProfileNormal=boolean])

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

extrude is undoable, queryable, and editable.

This command computes a surface given a profile curve and possibly a path curve. There are three ways to extrude a profile curve. The most basic method is called a "distance" extrude where direction and length are specified. No path curve is necessary in this case. The second method is called "flat" extrude. This method sweeps the profile curve down the path curve without changing the orientation of the profile curve. Finally, the third method is called "tube" extrude. This method sweeps a profile curve down a path curve while the profile curve rotates so that it maintains a relationship with the path curve.

Flags

constructionHistory, curveOnSurface, degreeAlongLength, direction, directionX, directionY, directionZ, extrudeType, fixedPath, length, name, object, pivot, pivotX, pivotY, pivotZ, polygon, range, rebuild, replaceOriginal, reverseSurfaceIfPathReversed, rotation, scale, subCurveSubSurface, useComponentPivot, useProfileNormal

Long name (short name) [argument types] Properties

extrudeType(et) int

The extrude type (distance-0, flat-1, or tube-2)
Default: 2

In query mode, this flag needs a value.

fixedPath(fpt) boolean

If true, the resulting surface will be placed at the path curve. Otherwise, the resulting surface will be placed at the profile curve.
Default: false

In query mode, this flag needs a value.

useComponentPivot(ucp) int

Use closest endpoint of the path - 0, component pivot - 1 or the center of the bounding box of the profile - 2
Default: 0

In query mode, this flag needs a value.

useProfileNormal(upn) boolean

If true, use the profile curve normal for the direction in which to extrude. Use only for distance or tube extrudeType.
Default: false

In query mode, this flag needs a value.

direction(d) [float, float, float]

The direction in which to extrude. Use only for distance extrudeType and useProfileNormal off

In query mode, this flag needs a value.

directionX(dx) linear

X of the direction
Default: 0

In query mode, this flag needs a value.

directionY(dy) linear

Y of the direction
Default: 1

In query mode, this flag needs a value.

directionZ(dz) linear

Z of the direction
Default: 0

In query mode, this flag needs a value.

length(l) linear

The distance to extrude. Use only for distance extrudeType
Default: 1

In query mode, this flag needs a value.

pivot(p) [float, float, float]

The pivot point used for tube extrudeType

In query mode, this flag needs a value.

pivotX(px) linear

X of the pivot
Default: 0

In query mode, this flag needs a value.

pivotY(py) linear

Y of the pivot
Default: 0

In query mode, this flag needs a value.

pivotZ(pz) linear

Z of the pivot
Default: 0

In query mode, this flag needs a value.

rotation(ro) angle

Amount to rotate the profile curve as it sweeps along the path curve.
Default: 0.0

In query mode, this flag needs a value.

scale(sc) float

Amount to scale the profile curve as it sweeps along the path curve.
Default: 1.0

In query mode, this flag needs a value.

reverseSurfaceIfPathReversed(rsp) boolean

If true, extrude type is tube (2) and path has been internally reversed then computed surface is reversed in the direction corresponding to the path.
Default: false

In query mode, this flag needs a value.

degreeAlongLength(dl) boolean

Surface degree along the distance when a distance extrude is performed
Default: 1

In query mode, this flag needs a value.

subCurveSubSurface(scs) boolean

If true, curve range on the path will get applied to the resulting surface instead of cut before the extrude.
Default: false

In query mode, this flag needs a value.

name(n) string

Name the resulting object

constructionHistory(ch) boolean

Turn the construction history on or off (not available in all commands)

object(o) boolean

Create the result, or just the dependency node (not available in all commands)

replaceOriginal(rpo) boolean

Create "in place" (i.e., replace) (not available in all commands)

curveOnSurface(cos) boolean

If possible, create 2D curve as a result (not available in all commands)

polygon(po) int

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

Force a curve range on complete input curve (not available in all commands)

rebuild(rb) boolean

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 have multiple arguments, passed either as a tuple or a list.

Return value

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

Related

singleProfileBirailSurface

Python examples

import maya.cmds as cmds

# extrude profile curve "distance" 5 units along x axis
cmds.extrude ('profile', et = 0, d= (1, 0, 0), l= 5)

# extrude profile curve along path curve using "flat" method
cmds.extrude( 'profile', 'path', et=1 )

# extrude profile curve along path curve using "tube" method
cmds.extrude( 'profile', 'path', et=2 )

Return to Autodesk Index