[clinton/guile-figl.git] / upstream-doc / man2 / gluPartialDisk.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="gluPartialDisk">
    <refmeta>
        <refmetainfo>
            <copyright>
                <year>1991-2006</year>
                <holder>Silicon Graphics, Inc.</holder>
            </copyright>
        </refmetainfo>
        <refentrytitle>gluPartialDisk</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>gluPartialDisk</refname>
        <refpurpose>draw an arc of a disk</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>gluPartialDisk</function></funcdef>
                <paramdef>GLUquadric* <parameter>quad</parameter></paramdef>
                <paramdef>GLdouble <parameter>inner</parameter></paramdef>
                <paramdef>GLdouble <parameter>outer</parameter></paramdef>
                <paramdef>GLint <parameter>slices</parameter></paramdef>
                <paramdef>GLint <parameter>loops</parameter></paramdef>
                <paramdef>GLdouble <parameter>start</parameter></paramdef>
                <paramdef>GLdouble <parameter>sweep</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <!-- eqn: ignoring delim $$ -->
    <refsect1 id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>quad</parameter></term>
            <listitem>
                <para>
                    Specifies a quadrics object (created with <citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>).
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>inner</parameter></term>
            <listitem>
                <para>
                    Specifies the inner radius of the partial disk (can be 0).
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>outer</parameter></term>
            <listitem>
                <para>
                    Specifies the outer radius of the partial disk.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>slices</parameter></term>
            <listitem>
                <para>
                    Specifies the number of subdivisions around the <emphasis>z</emphasis> axis.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>loops</parameter></term>
            <listitem>
                <para>
                    Specifies the number of concentric rings about the origin into which
                    the partial disk is subdivided.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>start</parameter></term>
            <listitem>
                <para>
                    Specifies the starting angle, in degrees, of the disk portion.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>sweep</parameter></term>
            <listitem>
                <para>
                    Specifies the sweep angle, in degrees, of the disk portion.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>gluPartialDisk</function> renders a partial disk on the 
            <inlineequation><mml:math>
                <!-- eqn: z  =  0:-->
                <mml:mrow>
                    <mml:mi mathvariant="italic">z</mml:mi>
                    <mml:mo>=</mml:mo>
                    <mml:mn>0</mml:mn>
                </mml:mrow>
            </mml:math></inlineequation>
            plane. A partial disk is 
            similar to a full disk, except that only the subset of the disk from
            <parameter>start</parameter> through <parameter>start</parameter> + <parameter>sweep</parameter> is included (where 0 degrees is along the 
            +\f2y\f axis,
            90 degrees along the +<emphasis>x</emphasis> axis, 180 degrees along the \-<emphasis>y</emphasis> axis, and 
            270 degrees along the \-<emphasis>x</emphasis> axis).
        </para>
        <para>
            The partial disk has a radius of 
            <parameter>outer</parameter> and contains a concentric circular hole with a radius 
            of <parameter>inner</parameter>. If <parameter>inner</parameter> is 0, then no hole is generated. The partial disk is
            subdivided around the <emphasis>z</emphasis> axis into slices (like pizza slices) and also
            about the <emphasis>z</emphasis> axis into rings 
            (as specified by <parameter>slices</parameter> and <parameter>loops</parameter>, respectively).
        </para>
        <para>
            With respect to orientation, the +<emphasis>z</emphasis> 
            side of the partial disk is considered to 
            be outside (see <citerefentry><refentrytitle>gluQuadricOrientation</refentrytitle></citerefentry>).
            This means that if the 
            orientation is set to <constant>GLU_OUTSIDE</constant>, then any normals generated 
            point along the +<emphasis>z</emphasis> axis. Otherwise, they point along the \-<emphasis>z</emphasis> 
            axis.
        </para>
        <para>
            If texturing is turned on (with <citerefentry><refentrytitle>gluQuadricTexture</refentrytitle></citerefentry>), texture
            coordinates are generated
            linearly such that where 
            <inlineequation><mml:math>
                <!-- eqn: r  =  outer:-->
                <mml:mrow>
                    <mml:mi mathvariant="italic">r</mml:mi>
                    <mml:mo>=</mml:mo>
                    <mml:mi mathvariant="italic">outer</mml:mi>
                </mml:mrow>
            </mml:math></inlineequation>,
            the value at (<emphasis>r</emphasis>, 0, 0) is 
            (1.0, 0.5), at (0, <emphasis>r</emphasis>, 0) it is (0.5, 1.0), at (\-<emphasis>r</emphasis>, 0, 0) 
            it is (0.0, 0.5), and 
            at (0, \-<emphasis>r</emphasis>, 0) it is (0.5, 0.0).
        </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>gluCylinder</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>gluDisk</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>gluQuadricOrientation</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>gluQuadricTexture</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>gluSphere</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 1991-2006
            Silicon Graphics, Inc. This document is licensed under the SGI
            Free Software B License. For details, see
            <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
        </para>
    </refsect1>
</refentry>
Commit	Line	Data
7faf1d71 AW	1	<?xml version="1.0" encoding="UTF-8"?>
	2	<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
	3	"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
	4	<refentry id="gluPartialDisk">
	5	<refmeta>
	6	<refmetainfo>
	7	<copyright>
	8	<year>1991-2006</year>
	9	<holder>Silicon Graphics, Inc.</holder>
	10	</copyright>
	11	</refmetainfo>
	12	<refentrytitle>gluPartialDisk</refentrytitle>
	13	<manvolnum>3G</manvolnum>
	14	</refmeta>
	15	<refnamediv>
	16	<refname>gluPartialDisk</refname>
	17	<refpurpose>draw an arc of a disk</refpurpose>
	18	</refnamediv>
	19	<refsynopsisdiv><title>C Specification</title>
	20	<funcsynopsis>
	21	<funcprototype>
	22	<funcdef>void <function>gluPartialDisk</function></funcdef>
	23	<paramdef>GLUquadric* <parameter>quad</parameter></paramdef>
	24	<paramdef>GLdouble <parameter>inner</parameter></paramdef>
	25	<paramdef>GLdouble <parameter>outer</parameter></paramdef>
	26	<paramdef>GLint <parameter>slices</parameter></paramdef>
	27	<paramdef>GLint <parameter>loops</parameter></paramdef>
	28	<paramdef>GLdouble <parameter>start</parameter></paramdef>
	29	<paramdef>GLdouble <parameter>sweep</parameter></paramdef>
	30	</funcprototype>
	31	</funcsynopsis>
	32	</refsynopsisdiv>
	33	<!-- eqn: ignoring delim $$ -->
	34	<refsect1 id="parameters"><title>Parameters</title>
	35	<variablelist>
	36	<varlistentry>
	37	<term><parameter>quad</parameter></term>
	38	<listitem>
	39	<para>
	40	Specifies a quadrics object (created with <citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>).
	41	</para>
	42	</listitem>
	43	</varlistentry>
	44	<varlistentry>
	45	<term><parameter>inner</parameter></term>
	46	<listitem>
	47	<para>
	48	Specifies the inner radius of the partial disk (can be 0).
	49	</para>
	50	</listitem>
	51	</varlistentry>
	52	<varlistentry>
	53	<term><parameter>outer</parameter></term>
	54	<listitem>
	55	<para>
	56	Specifies the outer radius of the partial disk.
	57	</para>
	58	</listitem>
	59	</varlistentry>
	60	<varlistentry>
	61	<term><parameter>slices</parameter></term>
	62	<listitem>
	63	<para>
	64	Specifies the number of subdivisions around the <emphasis>z</emphasis> axis.
65	</para>
66	</listitem>
67	</varlistentry>
68	<varlistentry>
69	<term><parameter>loops</parameter></term>
70	<listitem>
71	<para>
72	Specifies the number of concentric rings about the origin into which
73	the partial disk is subdivided.
74	</para>
75	</listitem>
76	</varlistentry>
77	<varlistentry>
78	<term><parameter>start</parameter></term>
79	<listitem>
80	<para>
81	Specifies the starting angle, in degrees, of the disk portion.
82	</para>
83	</listitem>
84	</varlistentry>
85	<varlistentry>
86	<term><parameter>sweep</parameter></term>
87	<listitem>
88	<para>
89	Specifies the sweep angle, in degrees, of the disk portion.
90	</para>
91	</listitem>
92	</varlistentry>
93	</variablelist>
94	</refsect1>
95	<refsect1 id="description"><title>Description</title>
96	<para>
97	<function>gluPartialDisk</function> renders a partial disk on the
98	<inlineequation><mml:math>
99	<!-- eqn: z = 0:-->
100	<mml:mrow>
101	<mml:mi mathvariant="italic">z</mml:mi>
102	<mml:mo>=</mml:mo>
103	<mml:mn>0</mml:mn>
104	</mml:mrow>
105	</mml:math></inlineequation>
106	plane. A partial disk is
107	similar to a full disk, except that only the subset of the disk from
108	<parameter>start</parameter> through <parameter>start</parameter> + <parameter>sweep</parameter> is included (where 0 degrees is along the
109	+\f2y\f axis,
110	90 degrees along the +<emphasis>x</emphasis> axis, 180 degrees along the \-<emphasis>y</emphasis> axis, and
111	270 degrees along the \-<emphasis>x</emphasis> axis).
112	</para>
113	<para>
114	The partial disk has a radius of
115	<parameter>outer</parameter> and contains a concentric circular hole with a radius
116	of <parameter>inner</parameter>. If <parameter>inner</parameter> is 0, then no hole is generated. The partial disk is
117	subdivided around the <emphasis>z</emphasis> axis into slices (like pizza slices) and also
118	about the <emphasis>z</emphasis> axis into rings
119	(as specified by <parameter>slices</parameter> and <parameter>loops</parameter>, respectively).
120	</para>
121	<para>
122	With respect to orientation, the +<emphasis>z</emphasis>
123	side of the partial disk is considered to
124	be outside (see <citerefentry><refentrytitle>gluQuadricOrientation</refentrytitle></citerefentry>).
125	This means that if the
126	orientation is set to <constant>GLU_OUTSIDE</constant>, then any normals generated
127	point along the +<emphasis>z</emphasis> axis. Otherwise, they point along the \-<emphasis>z</emphasis>
128	axis.
129	</para>
130	<para>
131	If texturing is turned on (with <citerefentry><refentrytitle>gluQuadricTexture</refentrytitle></citerefentry>), texture
132	coordinates are generated
133	linearly such that where
134	<inlineequation><mml:math>
135	<!-- eqn: r = outer:-->
136	<mml:mrow>
137	<mml:mi mathvariant="italic">r</mml:mi>
138	<mml:mo>=</mml:mo>
139	<mml:mi mathvariant="italic">outer</mml:mi>
140	</mml:mrow>
141	</mml:math></inlineequation>,
142	the value at (<emphasis>r</emphasis>, 0, 0) is
143	(1.0, 0.5), at (0, <emphasis>r</emphasis>, 0) it is (0.5, 1.0), at (\-<emphasis>r</emphasis>, 0, 0)
144	it is (0.0, 0.5), and
145	at (0, \-<emphasis>r</emphasis>, 0) it is (0.5, 0.0).
146	</para>
147	</refsect1>
148	<refsect1 id="seealso"><title>See Also</title>
149	<para>
150	<citerefentry><refentrytitle>gluCylinder</refentrytitle></citerefentry>,
151	<citerefentry><refentrytitle>gluDisk</refentrytitle></citerefentry>,
152	<citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>,
153	<citerefentry><refentrytitle>gluQuadricOrientation</refentrytitle></citerefentry>,
154	<citerefentry><refentrytitle>gluQuadricTexture</refentrytitle></citerefentry>,
155	<citerefentry><refentrytitle>gluSphere</refentrytitle></citerefentry>
156	</para>
157	</refsect1>
158	<refsect1 id="Copyright"><title>Copyright</title>
159	<para>
160	Copyright <trademark class="copyright"></trademark> 1991-2006
161	Silicon Graphics, Inc. This document is licensed under the SGI
162	Free Software B License. For details, see
163	<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
164	</para>
165	</refsect1>
166	</refentry>