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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
This flag specifies the primitive axis used to build the helix.Q: When queried, this flag returns a float[3].
caching (cch) bool ../../../_images/query.gif ../../../_images/edit.gif
   
coils (c) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
This flag specifies the number of coils in helix.C: Default is 1.0Q: When queried, this flag returns a float.
constructionHistory (ch) bool ../../../_images/create.gif ../../../_images/query.gif
 

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 appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

createUVs (cuv) int ../../../_images/create.gif
 

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 appliedwithout any distortion.In the unwrapped helix, the shared edges will have shared UVs.2 implies the UVs should be normalized. This will normalize theU 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 besqueezed in, without distorting the texture.For better understanding of these options, you may have to open thetexture view windowC: Default is 3

direction (d) int ../../../_images/create.gif
 

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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
This flag specifies the height of the helix.C: Default is 2.0.Q: When queried, this flag returns a float.
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/query.gif ../../../_images/edit.gif
   
object (o) bool ../../../_images/create.gif
 
Create the result, or just the dependency node (where applicable).Common flags
radius (r) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
This flag specifies the radius of helix tube.C: Default is 1.0.Q: When queried, this flag returns an float.
roundCap (rcp) bool ../../../_images/query.gif ../../../_images/edit.gif
   
subdivisionsAxis (sa) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif
 
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 ../../../_images/query.gif ../../../_images/edit.gif
   
width (w) float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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')

Previous topic

pymel.core.modeling.polyGeoSampler

Next topic

pymel.core.modeling.polyHole

Core

Core Modules

Other Modules

This Page