<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: csPrimitives Class Reference (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <h1>csPrimitives Class Reference</h1><!-- doxytag: class="csPrimitives" -->A primitive mesh generator. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="primitives_8h-source.html">cstool/primitives.h</a>></code> <p> <p> <a href="classcsPrimitives-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPrimitives.html#8713a0a6a6f9b62f4b706b79d9317f23">GenerateBox</a> (const <a class="el" href="classcsBox3.html">csBox3</a> &box, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > &mesh_vertices, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector2.html">csVector2</a> > &mesh_texels, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > &mesh_normals, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="structcsTriangle.html">csTriangle</a> > &mesh_triangles)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Generate a box with 24 vertices and 12 triangles so that the normals of every face point outwards (the normals of the vertices belonging to a face will point with the correct normal of the face). <a href="#8713a0a6a6f9b62f4b706b79d9317f23"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPrimitives.html#5e1cf321d2704f25d2d74cb0ac86a44f">GenerateCapsule</a> (float l, float r, <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> sides, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > &mesh_vertices, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector2.html">csVector2</a> > &mesh_texels, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > &mesh_normals, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="structcsTriangle.html">csTriangle</a> > &mesh_triangles)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Generate a capsule of given length and radius. <a href="#5e1cf321d2704f25d2d74cb0ac86a44f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPrimitives.html#57712ad78030404cf0c6f6216aa5b95e">GenerateQuad</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &v1, const <a class="el" href="classcsVector3.html">csVector3</a> &v2, const <a class="el" href="classcsVector3.html">csVector3</a> &v3, const <a class="el" href="classcsVector3.html">csVector3</a> &v4, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > &mesh_vertices, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector2.html">csVector2</a> > &mesh_texels, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > &mesh_normals, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="structcsTriangle.html">csTriangle</a> > &mesh_triangles)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Generate quad. <a href="#57712ad78030404cf0c6f6216aa5b95e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPrimitives.html#fc566b55c3c8fc63512206f3c00ea11d">GenerateSphere</a> (const <a class="el" href="classcsEllipsoid.html">csEllipsoid</a> &ellips, int num, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > &mesh_vertices, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector2.html">csVector2</a> > &mesh_texels, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > &mesh_normals, <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="structcsTriangle.html">csTriangle</a> > &mesh_triangles, bool cyl_mapping=false, bool toponly=false, bool reversed=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Generate a sphere with 'num' vertices on the rim. <a href="#fc566b55c3c8fc63512206f3c00ea11d"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A primitive mesh generator. <p>Definition at line <a class="el" href="primitives_8h-source.html#l00039">39</a> of file <a class="el" href="primitives_8h-source.html">primitives.h</a>.</p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="8713a0a6a6f9b62f4b706b79d9317f23"></a><!-- doxytag: member="csPrimitives::GenerateBox" ref="8713a0a6a6f9b62f4b706b79d9317f23" args="(const csBox3 &box, csDirtyAccessArray< csVector3 > &mesh_vertices, csDirtyAccessArray< csVector2 > &mesh_texels, csDirtyAccessArray< csVector3 > &mesh_normals, csDirtyAccessArray< csTriangle > &mesh_triangles)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static void csPrimitives::GenerateBox </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsBox3.html">csBox3</a> & </td> <td class="paramname"> <em>box</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > & </td> <td class="paramname"> <em>mesh_vertices</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector2.html">csVector2</a> > & </td> <td class="paramname"> <em>mesh_texels</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > & </td> <td class="paramname"> <em>mesh_normals</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="structcsTriangle.html">csTriangle</a> > & </td> <td class="paramname"> <em>mesh_triangles</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Generate a box with 24 vertices and 12 triangles so that the normals of every face point outwards (the normals of the vertices belonging to a face will point with the correct normal of the face). <p> </div> </div><p> <a class="anchor" name="5e1cf321d2704f25d2d74cb0ac86a44f"></a><!-- doxytag: member="csPrimitives::GenerateCapsule" ref="5e1cf321d2704f25d2d74cb0ac86a44f" args="(float l, float r, uint sides, csDirtyAccessArray< csVector3 > &mesh_vertices, csDirtyAccessArray< csVector2 > &mesh_texels, csDirtyAccessArray< csVector3 > &mesh_normals, csDirtyAccessArray< csTriangle > &mesh_triangles)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static void csPrimitives::GenerateCapsule </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>l</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>r</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td> <td class="paramname"> <em>sides</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > & </td> <td class="paramname"> <em>mesh_vertices</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector2.html">csVector2</a> > & </td> <td class="paramname"> <em>mesh_texels</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > & </td> <td class="paramname"> <em>mesh_normals</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="structcsTriangle.html">csTriangle</a> > & </td> <td class="paramname"> <em>mesh_triangles</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Generate a capsule of given length and radius. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>l</em> </td><td>Capsule length. </td></tr> <tr><td valign="top"></td><td valign="top"><em>r</em> </td><td>Capsule radius. </td></tr> <tr><td valign="top"></td><td valign="top"><em>sides</em> </td><td>Number of sides. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="57712ad78030404cf0c6f6216aa5b95e"></a><!-- doxytag: member="csPrimitives::GenerateQuad" ref="57712ad78030404cf0c6f6216aa5b95e" args="(const csVector3 &v1, const csVector3 &v2, const csVector3 &v3, const csVector3 &v4, csDirtyAccessArray< csVector3 > &mesh_vertices, csDirtyAccessArray< csVector2 > &mesh_texels, csDirtyAccessArray< csVector3 > &mesh_normals, csDirtyAccessArray< csTriangle > &mesh_triangles)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static void csPrimitives::GenerateQuad </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> & </td> <td class="paramname"> <em>v1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> & </td> <td class="paramname"> <em>v2</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> & </td> <td class="paramname"> <em>v3</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> & </td> <td class="paramname"> <em>v4</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > & </td> <td class="paramname"> <em>mesh_vertices</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector2.html">csVector2</a> > & </td> <td class="paramname"> <em>mesh_texels</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > & </td> <td class="paramname"> <em>mesh_normals</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="structcsTriangle.html">csTriangle</a> > & </td> <td class="paramname"> <em>mesh_triangles</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Generate quad. <p> </div> </div><p> <a class="anchor" name="fc566b55c3c8fc63512206f3c00ea11d"></a><!-- doxytag: member="csPrimitives::GenerateSphere" ref="fc566b55c3c8fc63512206f3c00ea11d" args="(const csEllipsoid &ellips, int num, csDirtyAccessArray< csVector3 > &mesh_vertices, csDirtyAccessArray< csVector2 > &mesh_texels, csDirtyAccessArray< csVector3 > &mesh_normals, csDirtyAccessArray< csTriangle > &mesh_triangles, bool cyl_mapping=false, bool toponly=false, bool reversed=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static void csPrimitives::GenerateSphere </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsEllipsoid.html">csEllipsoid</a> & </td> <td class="paramname"> <em>ellips</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>num</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > & </td> <td class="paramname"> <em>mesh_vertices</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector2.html">csVector2</a> > & </td> <td class="paramname"> <em>mesh_texels</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="classcsVector3.html">csVector3</a> > & </td> <td class="paramname"> <em>mesh_normals</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>< <a class="el" href="structcsTriangle.html">csTriangle</a> > & </td> <td class="paramname"> <em>mesh_triangles</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>cyl_mapping</em> = <code>false</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>toponly</em> = <code>false</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>reversed</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Generate a sphere with 'num' vertices on the rim. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>ellips</em> </td><td>Properties of the ellipsoid to create. </td></tr> <tr><td valign="top"></td><td valign="top"><em>num</em> </td><td>Number of vertices in the generated mesh. </td></tr> <tr><td valign="top"></td><td valign="top"><em>mesh_vertices</em> </td><td>Returns the generated vertices. </td></tr> <tr><td valign="top"></td><td valign="top"><em>mesh_texels</em> </td><td>Returns the generated texture coordinates. </td></tr> <tr><td valign="top"></td><td valign="top"><em>mesh_normals</em> </td><td>Returns the generated normals. </td></tr> <tr><td valign="top"></td><td valign="top"><em>mesh_triangles</em> </td><td>Returns the generated triangles. </td></tr> <tr><td valign="top"></td><td valign="top"><em>cyl_mapping</em> </td><td>if true then use cylindrical texture mapping. </td></tr> <tr><td valign="top"></td><td valign="top"><em>toponly</em> </td><td>if true then only generate the top half of the sphere. </td></tr> <tr><td valign="top"></td><td valign="top"><em>reversed</em> </td><td>if true then generate the sphere so it is visible from the inside. </td></tr> </table> </dl> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>cstool/<a class="el" href="primitives_8h-source.html">primitives.h</a></ul> <hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>