<!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: csSphere 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>csSphere Class Reference<br> <small> [<a class="el" href="group__geom__utils.html">Geometry utilities</a>]</small> </h1><!-- doxytag: class="csSphere" -->This class represents a sphere. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="sphere_8h-source.html">csgeom/sphere.h</a>></code> <p> <p> <a href="classcsSphere-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSphere.html#e26d4bdfb4a988e0c2d17f66c843daa2">csSphere</a> (const <a class="el" href="classcsSphere.html">csSphere</a> &s)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Copy Constructor. <a href="#e26d4bdfb4a988e0c2d17f66c843daa2"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSphere.html#1811595a93da34a3f1148ac27d29e395">csSphere</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &center, float radius)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new sphere. <a href="#1811595a93da34a3f1148ac27d29e395"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSphere.html#10c03039a4b34a1114e9b8b14dc7917b">csSphere</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new empty sphere at (0,0,0). <a href="#10c03039a4b34a1114e9b8b14dc7917b"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classcsVector3.html">csVector3</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSphere.html#7b346e5242dbdd445a728c0e44ea3011">GetCenter</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the center of this sphere. <a href="#7b346e5242dbdd445a728c0e44ea3011"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsVector3.html">csVector3</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSphere.html#1a4ea46a8ef97fabf22cb415b280ce27">GetCenter</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the center of this sphere. <a href="#1a4ea46a8ef97fabf22cb415b280ce27"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSphere.html#91a6e134fce3e1dbe2458f2ccd732f0f">GetRadius</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the radius of this sphere. <a href="#91a6e134fce3e1dbe2458f2ccd732f0f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsSphere.html">csSphere</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSphere.html#a4040ffe66d98e952e88d5012e0ef2e5">operator+=</a> (const <a class="el" href="classcsSphere.html">csSphere</a> &s)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Calculate the union of this sphere and another one. <a href="#a4040ffe66d98e952e88d5012e0ef2e5"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSphere.html#44e6edc6b560250ee23e31e2100d51ef">SetCenter</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &c)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the center of this sphere. <a href="#44e6edc6b560250ee23e31e2100d51ef"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSphere.html#7b9731465d0e7a4e5a99d353e2ea9cab">SetRadius</a> (float r)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the radius of this sphere. <a href="#7b9731465d0e7a4e5a99d353e2ea9cab"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSphere.html#8ef2cf230c648e3a2a0960000e2211de">TestIntersect</a> (const <a class="el" href="classcsSphere.html">csSphere</a> &sphere) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Test if the two spheres have an intersection. <a href="#8ef2cf230c648e3a2a0960000e2211de"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSphere.html#2a7ec086dd686f08b83d6370c3d40c2e">Union</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &ocenter, float oradius)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Calculate the union of this sphere and another. <a href="#2a7ec086dd686f08b83d6370c3d40c2e"></a><br></td></tr> <tr><td colspan="2"><br><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsSphere.html">csSphere</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSphere.html#4aff0fd05fd363b130dd36532c0b9e3d">operator+</a> (const <a class="el" href="classcsSphere.html">csSphere</a> &s1, const <a class="el" href="classcsSphere.html">csSphere</a> &s2)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Calculate the union of two spheres. <a href="#4aff0fd05fd363b130dd36532c0b9e3d"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> This class represents a sphere. <p>Definition at line <a class="el" href="sphere_8h-source.html#l00040">40</a> of file <a class="el" href="sphere_8h-source.html">sphere.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="10c03039a4b34a1114e9b8b14dc7917b"></a><!-- doxytag: member="csSphere::csSphere" ref="10c03039a4b34a1114e9b8b14dc7917b" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csSphere::csSphere </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create a new empty sphere at (0,0,0). <p> <p>Definition at line <a class="el" href="sphere_8h-source.html#l00048">48</a> of file <a class="el" href="sphere_8h-source.html">sphere.h</a>.</p> </div> </div><p> <a class="anchor" name="1811595a93da34a3f1148ac27d29e395"></a><!-- doxytag: member="csSphere::csSphere" ref="1811595a93da34a3f1148ac27d29e395" args="(const csVector3 &center, float radius)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csSphere::csSphere </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> & </td> <td class="paramname"> <em>center</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>radius</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create a new sphere. <p> <p>Definition at line <a class="el" href="sphere_8h-source.html#l00055">55</a> of file <a class="el" href="sphere_8h-source.html">sphere.h</a>.</p> </div> </div><p> <a class="anchor" name="e26d4bdfb4a988e0c2d17f66c843daa2"></a><!-- doxytag: member="csSphere::csSphere" ref="e26d4bdfb4a988e0c2d17f66c843daa2" args="(const csSphere &s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csSphere::csSphere </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsSphere.html">csSphere</a> & </td> <td class="paramname"> <em>s</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Copy Constructor. <p> <p>Definition at line <a class="el" href="sphere_8h-source.html#l00062">62</a> of file <a class="el" href="sphere_8h-source.html">sphere.h</a>.</p> <p>References <a class="el" href="sphere_8h-source.html#l00043">center</a>, and <a class="el" href="sphere_8h-source.html#l00044">radius</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="7b346e5242dbdd445a728c0e44ea3011"></a><!-- doxytag: member="csSphere::GetCenter" ref="7b346e5242dbdd445a728c0e44ea3011" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classcsVector3.html">csVector3</a>& csSphere::GetCenter </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the center of this sphere. <p> <p>Definition at line <a class="el" href="sphere_8h-source.html#l00067">67</a> of file <a class="el" href="sphere_8h-source.html">sphere.h</a>.</p> </div> </div><p> <a class="anchor" name="1a4ea46a8ef97fabf22cb415b280ce27"></a><!-- doxytag: member="csSphere::GetCenter" ref="1a4ea46a8ef97fabf22cb415b280ce27" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsVector3.html">csVector3</a>& csSphere::GetCenter </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the center of this sphere. <p> <p>Definition at line <a class="el" href="sphere_8h-source.html#l00065">65</a> of file <a class="el" href="sphere_8h-source.html">sphere.h</a>.</p> </div> </div><p> <a class="anchor" name="91a6e134fce3e1dbe2458f2ccd732f0f"></a><!-- doxytag: member="csSphere::GetRadius" ref="91a6e134fce3e1dbe2458f2ccd732f0f" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">float csSphere::GetRadius </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the radius of this sphere. <p> <p>Definition at line <a class="el" href="sphere_8h-source.html#l00071">71</a> of file <a class="el" href="sphere_8h-source.html">sphere.h</a>.</p> </div> </div><p> <a class="anchor" name="a4040ffe66d98e952e88d5012e0ef2e5"></a><!-- doxytag: member="csSphere::operator+=" ref="a4040ffe66d98e952e88d5012e0ef2e5" args="(const csSphere &s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsSphere.html">csSphere</a>& csSphere::operator+= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsSphere.html">csSphere</a> & </td> <td class="paramname"> <em>s</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Calculate the union of this sphere and another one. <p> <p>Definition at line <a class="el" href="sphere_8h-source.html#l00082">82</a> of file <a class="el" href="sphere_8h-source.html">sphere.h</a>.</p> <p>References <a class="el" href="sphere_8h-source.html#l00043">center</a>, and <a class="el" href="sphere_8h-source.html#l00044">radius</a>.</p> </div> </div><p> <a class="anchor" name="44e6edc6b560250ee23e31e2100d51ef"></a><!-- doxytag: member="csSphere::SetCenter" ref="44e6edc6b560250ee23e31e2100d51ef" args="(const csVector3 &c)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csSphere::SetCenter </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> & </td> <td class="paramname"> <em>c</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the center of this sphere. <p> <p>Definition at line <a class="el" href="sphere_8h-source.html#l00069">69</a> of file <a class="el" href="sphere_8h-source.html">sphere.h</a>.</p> </div> </div><p> <a class="anchor" name="7b9731465d0e7a4e5a99d353e2ea9cab"></a><!-- doxytag: member="csSphere::SetRadius" ref="7b9731465d0e7a4e5a99d353e2ea9cab" args="(float r)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csSphere::SetRadius </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"> <em>r</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the radius of this sphere. <p> <p>Definition at line <a class="el" href="sphere_8h-source.html#l00073">73</a> of file <a class="el" href="sphere_8h-source.html">sphere.h</a>.</p> </div> </div><p> <a class="anchor" name="8ef2cf230c648e3a2a0960000e2211de"></a><!-- doxytag: member="csSphere::TestIntersect" ref="8ef2cf230c648e3a2a0960000e2211de" args="(const csSphere &sphere) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool csSphere::TestIntersect </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsSphere.html">csSphere</a> & </td> <td class="paramname"> <em>sphere</em> </td> <td> ) </td> <td width="100%"> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Test if the two spheres have an intersection. <p> <p>Definition at line <a class="el" href="sphere_8h-source.html#l00089">89</a> of file <a class="el" href="sphere_8h-source.html">sphere.h</a>.</p> <p>References <a class="el" href="sphere_8h-source.html#l00043">center</a>, <a class="el" href="math_8h-source.html#l00120">csSquare()</a>, <a class="el" href="math3d_8h-source.html#l00232">csSquaredDist::PointPoint()</a>, and <a class="el" href="sphere_8h-source.html#l00044">radius</a>.</p> </div> </div><p> <a class="anchor" name="2a7ec086dd686f08b83d6370c3d40c2e"></a><!-- doxytag: member="csSphere::Union" ref="2a7ec086dd686f08b83d6370c3d40c2e" args="(const csVector3 &ocenter, float oradius)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csSphere::Union </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> & </td> <td class="paramname"> <em>ocenter</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>oradius</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Calculate the union of this sphere and another. <p> </div> </div><p> <hr><h2>Friends And Related Function Documentation</h2> <a class="anchor" name="4aff0fd05fd363b130dd36532c0b9e3d"></a><!-- doxytag: member="csSphere::operator+" ref="4aff0fd05fd363b130dd36532c0b9e3d" args="(const csSphere &s1, const csSphere &s2)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsSphere.html">csSphere</a> operator+ </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsSphere.html">csSphere</a> & </td> <td class="paramname"> <em>s1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsSphere.html">csSphere</a> & </td> <td class="paramname"> <em>s2</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Calculate the union of two spheres. <p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>csgeom/<a class="el" href="sphere_8h-source.html">sphere.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>