pymel.core.modeling.polyChipOff

polyChipOff(*args, **kwargs)

Extract facets. Faces can be extracted separately or together, and manipulations can be performed either in world or object space.

Flags:

Long name (short name)		Argument Types	Properties
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.
caching (cch)		bool
	Toggle caching for all attributes so that no recomputation is needed
constructionHistory (ch)		bool
	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.
duplicate (dup)		bool
	If on, facets are duplicated, otherwise original facets are removed. C: Default is on. Q: When queried, this flag returns an int.
gain (ga)		float
gravity (g)		float, float, float
	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)		float
	This flag specifies X for the gravity vector. C: Default is 0.0. Q: When queried, this flag returns a float.
gravityY (gy)		float
	This flag specifies Y for the gravity vector. C: Default is -1.0. Q: When queried, this flag returns a float.
gravityZ (gz)		float
	This flag specifies Z for the gravity vector. C: Default is 0.0. Q: When queried, this flag returns a float.
keepFacesTogether (kft)		bool
	This flag specifies how to chip off facets. If on, facets are pulled together (connected ones stay connected), otherwise they are pulled independentely. C: Default is on. Q: When queried, this flag returns an int.
keepFacetTogether (xft)		bool
localCenter (lc)		int
localDirection (ld)		float, float, float
	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)		float
	This flag specifies X for the local slant axis. C: Default is 0.0. Q: When queried, this flag returns a float.
localDirectionY (ldy)		float
	This flag specifies Y for the local slant axis. C: Default is 0.0. Q: When queried, this flag returns a float.
localDirectionZ (ldz)		float
	This flag specifies Y for the local slant axis. C: Default is 1.0. Q: When queried, this flag returns a float.
localRotate (lr)		float, float, float
	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)		float
	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)		float
	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)		float
	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.
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
localTranslate (lt)		float, float, float
	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)		float
	This flag specifies the X local translation vector. C: Default is 0.0. Q: When queried, this flag returns a float.
localTranslateY (lty)		float
	This flag specifies the Y local translation vector. C: Default is 0.0. Q: When queried, this flag returns a float.
localTranslateZ (ltz)		float
	This flag specifies the Z local translation vector. C: Default is 0.0. Q: When queried, this flag returns a float.
magnX (mx)		float
	This flag specifies X for the magnet vector. C: Default is 0.0. Q: When queried, this flag returns a float.
magnY (my)		float
	This flag specifies Y for the magnet vector. C: Default is 0.0. Q: When queried, this flag returns a float.
magnZ (mz)		float
	This flag specifies Z for the magnet vector. C: Default is 0.0. Q: When queried, this flag returns a float. Common flags
magnet (m)		float, float, float
	This flag specifies the magnet vector. C: Default is 0.0 0.0 0.0. Q: When queried, this flag returns a float[3].
name (n)		unicode
	Give a name to the resulting node.
nodeState (nds)		int
	Defines how to evaluate the node. 0: Normal1: PassThrough2: Blocking3: Internally disabled. Will return to Normal state when enabled4: Internally disabled. Will return to PassThrough state when enabled5: Internally disabled. Will return to Blocking state when enabledFlag can have multiple arguments, passed either as a tuple or a list.
offset (off)		float
	This flag specifies the local offset. C: Default is 0.0. Q: When queried, this flag returns a float.
pivot (pvt)		float, float, float
	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)		float
	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)		float
	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)		float
	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
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. Global Values
rotate (ro)		float, float, float
	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)		float
	This flag specifies the rotation angle around X. C: Default is 0.0. Q: When queried, this flag returns a float.
rotateY (ry)		float
	This flag specifies the rotation angle around Y. C: Default is 0.0. Q: When queried, this flag returns a float.
rotateZ (rz)		float
	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.
translate (t)		float, float, float
	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)		float
	This flag specifies the X translation vector. C: Default is 0.0. Q: When queried, this flag returns a float.
translateY (ty)		float
	This flag specifies the Y translation vector. C: Default is 0.0. Q: When queried, this flag returns a float.
translateZ (tz)		float
	This flag specifies the Z translation vector. C: Default is 0.0. Q: When queried, this flag returns a float.
weight (w)		float
	This flag specifies the weight, related to gravity. C: Default is 0.0. Q: When queried, this flag returns a float.
worldSpace (ws)		bool
	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.

Derived from mel command maya.cmds.polyChipOff

Example:

import pymel.core as pm

# Duplicate
pm.polyPlane( n='plg', w=10, h=10 )
pm.polyChipOff( 'plg.f[71:72]', 'plg.f[81:82]', dup=True, ltz=1 )
#facets are duplicated and translated in local space

# Extract
pm.polyChipOff( 'plg.f[11:12]', 'plg.f[21:22]', dup=False, ty=1 )
#facets are extracted and translated in world space

# Separate
pm.polyChipOff( 'plg.f[15:16]', 'plg.f[23:24]', dup=False, kft=False, ls=(.5, .5, 0) )
#facets are extracted then scaled separately

# Together
pm.polyChipOff( 'plg.f[73:74]', 'plg.f[83:84]', dup=False, kft=True, ls=(.5, .5, 0) )
#facets are extracted then scaled together