pymel.core.modeling.polyHelix

polyHelix(*args, **kwargs)

The polyHelix command creates a new polygonal helix.

Flags:

Long name (short name)		Argument Types	Properties
axis (ax)		float, float, float
	This flag specifies the primitive axis used to build the helix. Q: When queried, this flag returns a float[3].
caching (cch)		bool
coils (c)		float
	This flag specifies the number of coils in helix. C: Default is 1.0 Q: When queried, this flag returns a float.
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. Flag can have multiple arguments, passed either as a tuple or a list.
createUVs (cuv)		int
	This flag alows a specific UV mechanism to be selected, while creating the helix. The valid values are 0, 1, 2 or 3. 0 implies that no UVs will be generated (No texture to be applied). 1 implies UVs should be created for the object as a whole without any normalization. The helix will be unwrapped and then the texture will be applied without any distortion. In the unwrapped helix, the shared edges will have shared UVs. 2 implies the UVs should be normalized. This will normalize the U and V direction separately, thereby resulting in distortion of textures. 4 implies UVs are created so that the texture will not be distorted when applied. The texture lying outside the UV range will be truncated (since that cannot be squeezed in, without distorting the texture. For better understanding of these options, you may have to open the texture view windowC: Default is 3
direction (d)		int
	This flag alows a direction of coil to be selected, while creating the helix. The valid values are 0 or 1. 0 implies clockwise direction. 1 implies CounterClockwise direction. C: Default is 1
height (h)		float
	This flag specifies the height of the helix. C: Default is 2.0. Q: When queried, this flag returns a float.
name (n)		unicode
	Give a name to the resulting node.
nodeState (nds)		int
object (o)		bool
	Create the result, or just the dependency node (where applicable). Common flags
radius (r)		float
	This flag specifies the radius of helix tube. C: Default is 1.0. Q: When queried, this flag returns an float.
roundCap (rcp)		bool
subdivisionsAxis (sa)		int
	This specifies the number of subdivisions around the axis of the helix. C: Default is 8. Q: When queried, this flag returns an int.
subdivisionsCaps (sc)		int
	This flag specifies the number of subdivisions along the thickness of the coil. C: Default is 0. Q: When queried, this flag returns an int.
subdivisionsCoil (sco)		int
	This flag specifies the number of subdivisions along the coil of the helix. C: Default is 50. Q: When queried, this flag returns an int.
texture (tx)		int
	This flag is obsolete and will be removed in the next release. The -cuv/createUVs flag should be used instead. Common flags
useOldInitBehaviour (oib)		bool
width (w)		float
	This specifies the width of the helix. C: Default is 1.0. Q: When queried, this flag returns an float.

Derived from mel command maya.cmds.polyHelix

Example:

import pymel.core as pm

# Create a helix with radius 1.0 in anti clockwise direction with no UV's for texture.
pm.polyHelix(r=1, d=1, cuv=0)

# Create a helix, called "myHelix" with default values.
pm.polyHelix(n='myHelix')