AddSpiral

Adds a spiral or helical curve object to the document.

Syntax

rhinoscriptsyntax.AddSpiral (point0, point1, pitch, turns, radius0, radius1=None)

rhinoscript.curve.AddSpiral (point0, point1, pitch, turns, radius0, radius1=None)

Parameters

point0

Required.  list of three numbers or Point3d.  Helix's axis starting point or center of spiral.

point1

Required.  list of three numbers or Point3d.  Helix's axis end point or point normal to spiral's plane.

pitch

Required.  Number.  The pitch, or distance between turns. If 0, then a spiral. If > 0, then the distance between helix's "threads".

turns

Required.  Number.  A non-zero value indicating the number of turns in spiral or helix. Values > 0 will produce a right-handed, or counter-clockwise, orientation. A value < 0 will produce a left-handed, or clockwise, orientation. Note, for a helix, pitch * turns = length of the helix's axis.

radius0

Required.  Number.  The starting radius.  Note, for a helix, you may have radius0 = radius1. For a spiral, radius0 = radius1 produces a circle. Zero and negative radii are permissible.  At least one radii must be non-zero.

radius1

Optional.  Number.  The ending radius.  If omitted, radius1 = radius0.

Returns

Guid

The identifier of the new object if successful.

None

If not successful, or on error.

Example

import rhinoscriptsyntax as rs

point0 = (0,0,0)

point1 = (0,0,10)

pitch = 1

turns = 10

radius0 = 5.0

radius1 = 8.0

rs.AddSpiral(point0, point1, pitch, turns, radius0, radius1)

Also See

AddSpiral2