<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN" "http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd">
<html
	xmlns="http://www.w3.org/1999/xhtml"
	xmlns:mml="http://www.w3.org/1998/Math/MathML"
><head><title>gleHelicoid</title><link rel="stylesheet" href="style.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"/><link rel="home" href="index.xml" title="PyOpenGL 2.0.1.07 Man Pages"/><link rel="up" href="reference-GLE.xml" title="GLE"/><link rel="previous" href="gleExtrusion.3GLE.xml" title="gleExtrusion"/><link rel="next" href="gleLathe.3GLE.xml" title="gleLathe"/></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gleHelicoid</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gleExtrusion.3GLE.xml">Prev</a> </td><th width="60%" align="center">GLE</th><td width="20%" align="right"> <a accesskey="n" href="gleLathe.3GLE.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="gleHelicoid.3GLE"/><div class="titlepage"/><div class="refnamediv"><a name="gleHelicoid.3GLE-name"/><h2>Name</h2><p>gleHelicoid &#8212; Generalized torus, spiral with circle contour.</p></div><div class="refsynopsisdiv"><a name="gleHelicoid.3GLE-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>void <tt>gleHelicoid</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>gleDouble <i><tt>rToroid</tt></i>, gleDouble <i><tt>up</tt></i>[3], gleDouble <i><tt>startRadius</tt></i>, gleDouble <i><tt>drdTheta</tt></i>, gleDouble <i><tt>startZ</tt></i>, gleDouble <i><tt>dzdTheta</tt></i>, gleDouble <i><tt>startXform</tt></i>[2][3], gleDouble <i><tt>dXformdTheta</tt></i>[2][3], gleDouble <i><tt>startTheta</tt></i>, gleDouble <i><tt>sweepTheta</tt></i>);</code></td></tr></table></div><div class="refsynopsisdiv"><a name="gleHelicoid.3GLE-python_specification"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>gleHelicoid</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>rToroid</tt></i>, <i><tt>up</tt></i>[3], <i><tt>startRadius</tt></i>, <i><tt>drdTheta</tt></i>, <i><tt>startZ</tt></i>, <i><tt>dzdTheta</tt></i>, <i><tt>startXform</tt></i>[2][3], <i><tt>dXformdTheta</tt></i>[2][3], <i><tt>startTheta</tt></i>, <i><tt>sweepTheta</tt></i>) &#8594; <tt>None</tt></code></td></tr></table></div><div class="refsect1" lang="en"><a name="gleHelicoid.3GLE-parameters"/><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><i><tt>rToroid</tt></i></span></dt><dd>
						circle contour (torus) radius
					</dd><dt><span class="term"><i><tt>startRadius</tt></i></span></dt><dd>
						spiral starts in x-y plane
					</dd><dt><span class="term"><i><tt>drdTheta</tt></i></span></dt><dd>
						change in radius per revolution
					</dd><dt><span class="term"><i><tt>startZ</tt></i></span></dt><dd>
						starting z value
					</dd><dt><span class="term"><i><tt>dzdTheta</tt></i></span></dt><dd>
						change in Z per revolution
					</dd><dt><span class="term"><i><tt>startXform</tt></i></span></dt><dd>
						starting contour affine transformation
					</dd><dt><span class="term"><i><tt>dXformdTheta</tt></i></span></dt><dd>
						tangent change xform per revolution
					</dd><dt><span class="term"><i><tt>startTheta</tt></i></span></dt><dd>
						start angle in x-y plane
					</dd><dt><span class="term"><i><tt>sweepTheta</tt></i></span></dt><dd>
						degrees to spiral around
					</dd></dl></div></div><div class="refsect1" lang="en"><a name="gleHelicoid.3GLE-description"/><h2>Description</h2><p>
			Generalized Torus. Similar to <a href="gleSpiral.3GLE.xml"><tt>gleSpiral</tt></a>, except contour is a circle. Uses
			<a href="gleSpiral.3GLE.xml"><tt>gleSpiral</tt></a> to draw.
		</p></div><div class="refsect1" lang="en"><a name="gleHelicoid.3GLE-see_also"/><h2>See Also</h2><p>
			<span class="simplelist"><a href="gleSpiral.3GLE.xml">gleSpiral</a>, <a href="gleToroid.3GLE.xml">gleToroid</a></span>
		</p></div><div class="refsect1" lang="en"><a name="gleHelicoid.3GLE-author"/><h2>Author</h2><p>
			Linas Vepstas
		</p></div></div><div class="navfooter"><hr/><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gleExtrusion.3GLE.xml">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="reference-GLE.xml">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="gleLathe.3GLE.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gleExtrusion </td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top"> gleLathe</td></tr></table></div></body></html>