pymel.core.modeling.extrude

extrude(*args, **kwargs)

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:
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.
constructionHistory (ch) bool ../../../_images/create.gif
 
Turn the construction history on or off
degreeAlongLength (dl) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Surface degree along the distance when a distance extrude is performedDefault:1
direction (d) float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The direction in which to extrude. Use only for distance extrudeType and useProfileNormal off
directionX (dx) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
X of the directionDefault:0
directionY (dy) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Y of the directionDefault:1
directionZ (dz) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Z of the directionDefault:0
extrudeType (et) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The extrude type (distance-0, flat-1, or tube-2)Default:2
fixedPath (fpt) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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
length (l) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The distance to extrude. Use only for distance extrudeTypeDefault:1
mergeItems (mi) bool  
   
name (n) unicode ../../../_images/create.gif
 

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 ../../../_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
object (o) bool ../../../_images/create.gif
 
Create the result, or just the dependency node
pivot (p) float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
The pivot point used for tube extrudeType
polygon (po) int ../../../_images/create.gif
 

The value of this argument controls the type of the object created by this operation 0: nurbs surface1: polygon (use nurbsToPolygonsPref to set the parameters for the conversion)2: subdivision surface (use nurbsToSubdivPref to set the parameters for the conversion)3: Bezier surface4: subdivision surface solid (use nurbsToSubdivPref to set the parameters for the conversion)

range (rn) bool ../../../_images/create.gif
 
Force a curve range on complete input curve
rebuild (rb) bool ../../../_images/create.gif
 

Rebuild the input curve(s) before using them in the operation. Use nurbsCurveRebuildPref to set the parameters for the conversion.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

reverseSurfaceIfPathReversed (rsp) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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
rotation (ro) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Amount to rotate the profile curve as it sweeps along the path curve.Default:0.0
scale (sc) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Amount to scale the profile curve as it sweeps along the path curve.Default:1.0
subCurveSubSurface (scs) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
If true, curve range on the path will get applied to the resulting surface instead of cut before the extrude.Default:falseAdvanced flags
useComponentPivot (ucp) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Use closest endpoint of the path - 0, component pivot - 1 or the center of the bounding box of the profile - 2Default:0
useProfileNormal (upn) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
If true, use the profile curve normal for the direction in which to extrude. Use only for distance or tube extrudeType.Default:false

Derived from mel command maya.cmds.extrude

Example:

import pymel.core as pm

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

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

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

Previous topic

pymel.core.modeling.extendSurface

Next topic

pymel.core.modeling.filletCurve

Core

Core Modules

Other Modules

This Page