polyExtrudeFacet command

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

Synopsis

polyExtrudeFacet([attraction=float], [caching=boolean], [constructionHistory=boolean], [divisions=int], [gravity=[linear, linear, linear]], [gravityX=linear], [gravityY=linear], [gravityZ=linear], [inputCurve=name], [keepFacesTogether=boolean], [localDirection=[linear, linear, linear]], [localDirectionX=linear], [localDirectionY=linear], [localDirectionZ=linear], [localRotate=[angle, angle, angle]], [localRotateX=angle], [localRotateY=angle], [localRotateZ=angle], [localScale=[float, float, float]], [localScaleX=float], [localScaleY=float], [localScaleZ=float], [localTranslate=[linear, linear, linear]], [localTranslateX=linear], [localTranslateY=linear], [localTranslateZ=linear], [magnX=linear], [magnY=linear], [magnet=[linear, linear, linear]], [name=string], [nodeState=int], [offset=float], [pivot=[linear, linear, linear]], [pivotX=linear], [pivotY=linear], [pivotZ=linear], [random=float], [rotate=[angle, angle, angle]], [rotateX=angle], [rotateY=angle], [rotateZ=angle], [scale=[float, float, float]], [scaleX=float], [scaleY=float], [scaleZ=float], [smoothingAngle=angle], [translate=[linear, linear, linear]], [translateX=linear], [translateY=linear], [translateZ=linear], [weight=float], [worldSpace=boolean])

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

polyExtrudeFacet is undoable, queryable, and editable.

Extrude faces. Faces can be extruded separately or together, and manipulations can be performed either in world or object space.

Return value

string

The node name.

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

polyAppend, polyAppendVertex, polyBevel, polyChipOff, polyCreateFacet, polyExtrudeEdge, polySmooth, polySplit, polySplitVertex, polySubdivideEdge, polySubdivideFacet, polyTriangulate

Flags

attraction, caching, constructionHistory, divisions, gravity, gravityX, gravityY, gravityZ, inputCurve, keepFacesTogether, localDirection, localDirectionX, localDirectionY, localDirectionZ, localRotate, localRotateX, localRotateY, localRotateZ, localScale, localScaleX, localScaleY, localScaleZ, localTranslate, localTranslateX, localTranslateY, localTranslateZ, magnX, magnY, magnet, name, nodeState, offset, pivot, pivotX, pivotY, pivotZ, random, rotate, rotateX, rotateY, rotateZ, scale, scaleX, scaleY, scaleZ, smoothingAngle, translate, translateX, translateY, translateZ, weight, worldSpace

Long name (short name) Argument types Properties

keepFacesTogether(kft) boolean

This flag specifies how to extrude faces. If "on", faces are pulled together (connected ones stay connected and only outside edges form new faces), otherwise they are pulled independently (each edge on selected faces creates a new face and manipulations are performed on each selected face separately).
C: Default is "on".
Q: When queried, this flag returns an int.

worldSpace(ws) boolean

This flag specifies which reference to use. If "on" : all geometrical values are taken in world reference. If "off" : all geometrical values are taken in object reference.
C: Default is off.
Q: When queried, this flag returns an int.

random(ran) float

This flag specifies the random value for all parameters.
C: Default is 0.0. The range is [-10.0, 10.0].
Q: When queried, this flag returns a float.

inputCurve(inc) name

This flag specifies the name of the curve to be used as input for extrusion
C: The selected faces will be extruded along the curve. It will be useful to set a higher value (greater than 4) for the '-d/-divisions' flag, to get good results. The normal of the surface has to be aligned with the direction of the curve. The extrusion is evenly distributed in the curve's parameter space, and not on the curve's geometry space

divisions(d) int

This flag specifies the number of subdivisions.
C: Default is 1
Q: When queried, this flag returns an int.

smoothingAngle(sma) angle

This flag specifies smoothingAngle threshold used to determine whether newly created edges are hard or soft.
C: Default is 30.0. The range is [0, 180].
Q: When queried, this flag returns a float.

Global Values

translate(t) [linear, linear, linear]

This flag specifies the translation vector.
C: Default is 0.0 0.0 0.0.
Q: When queried, this flag returns a float[3].

translateX(tx) linear

This flag specifies the X translation vector.
C: Default is 0.0.
Q: When queried, this flag returns a float.

translateY(ty) linear

This flag specifies the Y translation vector.
C: Default is 0.0.
Q: When queried, this flag returns a float.

translateZ(tz) linear

This flag specifies the Z translation vector.
C: Default is 0.0.
Q: When queried, this flag returns a float.

rotate(ro) [angle, angle, angle]

This flag specifies the rotation angles around X, Y, Z.
C: Default is 0.0 0.0 0.0.
Q: When queried, this flag returns a float[3].

rotateX(rx) angle

This flag specifies the rotation angle around X.
C: Default is 0.0.
Q: When queried, this flag returns a float.

rotateY(ry) angle

This flag specifies the rotation angle around Y.
C: Default is 0.0.
Q: When queried, this flag returns a float.

rotateZ(rz) angle

This flag specifies the rotation angle around Z.
C: Default is 0.0.
Q: When queried, this flag returns a float.

scale(s) [float, float, float]

This flag specifies the scaling vector.
C: Default is 1.0 1.0 1.0.
Q: When queried, this flag returns a float[3].

scaleX(sx) float

This flag specifies X for scaling vector.
C: Default is 1.0.
Q: When queried, this flag returns a float.

scaleY(sy) float

This flag specifies Y for scaling vector.
C: Default is 1.0.
Q: When queried, this flag returns a float.

scaleZ(sz) float

This flag specifies Z for scaling vector.
C: Default is 1.0.
Q: When queried, this flag returns a float.

pivot(pvt) [linear, linear, linear]

This flag specifies the pivot for scaling and rotation.
C: Default is 0.0 0.0 0.0.
Q: When queried, this flag returns a float[3].

pivotX(pvx) linear

This flag specifies the X pivot for scaling and rotation.
C: Default is 0.0.
Q: When queried, this flag returns a float.

pivotY(pvy) linear

This flag specifies the Y pivot for scaling and rotation.
C: Default is 0.0.
Q: When queried, this flag returns a float.

pivotZ(pvz) linear

This flag specifies the Z pivot for scaling and rotation.
C: Default is 0.0.
Q: When queried, this flag returns a float.

Local Values

offset(off) float

This flag specifies the local offset. Each edge of each selected face moves towards the inside of the face by given distance (in local reference).
C: Default is 0.0.

localTranslate(lt) [linear, linear, linear]

This flag specifies the local translation vector.
C: Default is 0.0 0.0 0.0.
Q: When queried, this flag returns a float[3].

localTranslateX(ltx) linear

This flag specifies the X local translation vector.
C: Default is 0.0.
Q: When queried, this flag returns a float.

localTranslateY(lty) linear

This flag specifies the Y local translation vector.
C: Default is 0.0.
Q: When queried, this flag returns a float.

localTranslateZ(ltz) linear

This flag specifies the Z local translation vector.
C: Default is 0.0.
Q: When queried, this flag returns a float.

localRotate(lr) [angle, angle, angle]

This flag specifies the local rotations : (slantRot, slantRoll, twistRot).
C: Default is 0.0 0.0 0.0.
Q: When queried, this flag returns a float[3]. Local rotation (slantRot, slantRoll, twistRot).

localRotateX(lrx) angle

This flag specifies local rotation X angle (Slant Rot around slantAxis).
C: Default is 0.0. The range is [0, 360].
Q: When queried, this flag returns a float.

localRotateY(lry) angle

This flag specifies local rotation Y angle (Slant Roll of slantAxis).
C: Default is 0.0. The range is [0, 180].
Q: When queried, this flag returns a float.

localRotateZ(lrz) angle

This flag specifies local rotation Z angle (Twist around normal).
C: Default is 0.0. The range is [0, 360].
Q: When queried, this flag returns a float.

localDirection(ld) [linear, linear, linear]

This flag specifies the local slant axis (see local rotation).
C: Default is 0.0 0.0 1.0.
Q: When queried, this flag returns a float[3].

localDirectionX(ldx) linear

This flag specifies X for the local slant axis.
C: Default is 0.0.
Q: When queried, this flag returns a float.

localDirectionY(ldy) linear

This flag specifies Y for the local slant axis.
C: Default is 0.0.
Q: When queried, this flag returns a float.

localDirectionZ(ldz) linear

This flag specifies Z for the local slant axis.
C: Default is 1.0.
Q: When queried, this flag returns a float.

localScale(ls) [float, float, float]

This flag specifies the local scaling vector.
C: Default is 1.0 1.0 1.0.
Q: When queried, this flag returns a float[3].

localScaleX(lsx) float

This flag specifies X for local scaling vector.
C: Default is 1.0.
Q: When queried, this flag returns a float.

localScaleY(lsy) float

This flag specifies Y for local scaling vector.
C: Default is 1.0.
Q: When queried, this flag returns a float.

localScaleZ(lsz) float

This flag specifies Z for local scaling vector : Flattening.
C: Default is 1.0. The range is [0.0, 1.0].
Q: When queried, this flag returns a float.

Dynamic Values

weight(w) float

This flag specifies the weight, related to gravity.
C: Default is 0.0.
Q: When queried, this flag returns a float.

gravity(g) [linear, linear, linear]

This flag specifies the gravity vector.
C: Default is 0.0 -1.0 0.0.
Q: When queried, this flag returns a float[3].

gravityX(gx) linear

This flag specifies X for the gravity vector.
C: Default is 0.0.
Q: When queried, this flag returns a float.

gravityY(gy) linear

This flag specifies Y for the gravity vector.
C: Default is -1.0.
Q: When queried, this flag returns a float.

gravityZ(gz) linear

This flag specifies Z for the gravity vector.
C: Default is 0.0.
Q: When queried, this flag returns a float.

attraction(att) float

This flag specifies the attraction, related to magnet.
C: Default is 0.0. The range is [-2.0, 2.0].
Q: When queried, this flag returns a float.

magnet(m) [linear, linear, linear]

This flag specifies the magnet vector.
C: Default is 0.0 0.0 0.0.
Q: When queried, this flag returns a float[3].

magnX(mx) linear

This flag specifies X for the magnet vector.
C: Default is 0.0.
Q: When queried, this flag returns a float.

magnY(my) linear

This flag specifies Y for the magnet vector.
C: Default is 0.0.
Q: When queried, this flag returns a float.

Common flags

name(n) string

Give a name to the resulting node.

constructionHistory(ch) boolean

Turn the construction history on or off (where applicable). If construction history is on then the corresponding node will be inserted into the history chain for the mesh. If construction history is off then the operation will be performed directly on the object.
Note: If the object already has construction history then this flag is ignored and the node will always be inserted into the history chain.

caching(cch) boolean

Toggle caching for all attributes so that no recomputation is needed

nodeState(nds) int

Defines how to evaluate the node.

0: Normal
1: PassThrough
2: Blocking
3: Internally disabled. Will return to Normal state when enabled
4: Internally disabled. Will return to PassThrough state when enabled
5: Internally disabled. Will return to Blocking state when enabled

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

# Separate
cmds.polyPlane( n='plg', w=10, h=10 )
cmds.polyExtrudeFacet( 'plg.f[71:72]', 'plg.f[81:82]', kft=False, ltz=2, ls=(.5, .5, 0) )
# Facets are extruded then scaled separately


# Together
cmds.polyExtrudeFacet( 'plg.f[17:18]', 'plg.f[27:28]', kft=True, ltz=2, ls=(.5, .5, 0) )
# Facets are extruded then scaled together

command (Python)	MEL version
polyExtrudeFacet	In categories: Modeling, Polygons