<!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: csSegment2 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>csSegment2 Class Reference<br> <small> [<a class="el" href="group__geom__utils.html">Geometry utilities</a>]</small> </h1><!-- doxytag: class="csSegment2" -->A 2D line segment. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="segment_8h-source.html">csgeom/segment.h</a>></code> <p> <p> <a href="classcsSegment2-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="classcsSegment2.html#8c06946d32a44a93b65809d8d72afcbd">csSegment2</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Make a new uninitialized segment. <a href="#8c06946d32a44a93b65809d8d72afcbd"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment2.html#483f7fdf58ec2287451eba2755073500">csSegment2</a> (const <a class="el" href="classcsVector2.html">csVector2</a> &s, const <a class="el" href="classcsVector2.html">csVector2</a> &e)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Make a new segment and initialize with the given values. <a href="#483f7fdf58ec2287451eba2755073500"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsVector2.html">csVector2</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment2.html#f922dbb01980721bc94e11f30ed07522">End</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the end of the segment. <a href="#f922dbb01980721bc94e11f30ed07522"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classcsVector2.html">csVector2</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment2.html#d2ec6a2367a75545af6d50913aca04b7">End</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the end of the segment. <a href="#d2ec6a2367a75545af6d50913aca04b7"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment2.html#4c7fac87d87a6a859e97e776a7954225">Set</a> (const <a class="el" href="classcsVector2.html">csVector2</a> &s, const <a class="el" href="classcsVector2.html">csVector2</a> &e)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set segment to given values. <a href="#4c7fac87d87a6a859e97e776a7954225"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment2.html#a71e23bd828229fb9e439b779e8a815f">SetEnd</a> (const <a class="el" href="classcsVector2.html">csVector2</a> &e)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the end of the segment. <a href="#a71e23bd828229fb9e439b779e8a815f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment2.html#0e2b0d0fb67363f272a4100b1c9f7dea">SetStart</a> (const <a class="el" href="classcsVector2.html">csVector2</a> &s)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the start of the segment. <a href="#0e2b0d0fb67363f272a4100b1c9f7dea"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsVector2.html">csVector2</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment2.html#1e8c2728674801630a94716014437d26">Start</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the start of the segment. <a href="#1e8c2728674801630a94716014437d26"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classcsVector2.html">csVector2</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment2.html#48ebbdb8de300930e733c0ba241d14df">Start</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the start of the segment. <a href="#48ebbdb8de300930e733c0ba241d14df"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment2.html#e0c6b169d55b3aa9a7382b1e3186cc83">~csSegment2</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#e0c6b169d55b3aa9a7382b1e3186cc83"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A 2D line segment. <p>Definition at line <a class="el" href="segment_8h-source.html#l00037">37</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="483f7fdf58ec2287451eba2755073500"></a><!-- doxytag: member="csSegment2::csSegment2" ref="483f7fdf58ec2287451eba2755073500" args="(const csVector2 &s, const csVector2 &e)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csSegment2::csSegment2 </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsVector2.html">csVector2</a> & </td> <td class="paramname"> <em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsVector2.html">csVector2</a> & </td> <td class="paramname"> <em>e</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> Make a new segment and initialize with the given values. <p> <p>Definition at line <a class="el" href="segment_8h-source.html#l00047">47</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p> </div> </div><p> <a class="anchor" name="8c06946d32a44a93b65809d8d72afcbd"></a><!-- doxytag: member="csSegment2::csSegment2" ref="8c06946d32a44a93b65809d8d72afcbd" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csSegment2::csSegment2 </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Make a new uninitialized segment. <p> <p>Definition at line <a class="el" href="segment_8h-source.html#l00049">49</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p> </div> </div><p> <a class="anchor" name="e0c6b169d55b3aa9a7382b1e3186cc83"></a><!-- doxytag: member="csSegment2::~csSegment2" ref="e0c6b169d55b3aa9a7382b1e3186cc83" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csSegment2::~csSegment2 </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Destructor. <p> <p>Definition at line <a class="el" href="segment_8h-source.html#l00051">51</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="f922dbb01980721bc94e11f30ed07522"></a><!-- doxytag: member="csSegment2::End" ref="f922dbb01980721bc94e11f30ed07522" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsVector2.html">csVector2</a>& csSegment2::End </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 end of the segment. <p> <p>Definition at line <a class="el" href="segment_8h-source.html#l00073">73</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p> </div> </div><p> <a class="anchor" name="d2ec6a2367a75545af6d50913aca04b7"></a><!-- doxytag: member="csSegment2::End" ref="d2ec6a2367a75545af6d50913aca04b7" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classcsVector2.html">csVector2</a>& csSegment2::End </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 end of the segment. <p> <p>Definition at line <a class="el" href="segment_8h-source.html#l00067">67</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p> <p>Referenced by <a class="el" href="math2d_8h-source.html#l00224">csIntersect2::SegmentPlane()</a>, <a class="el" href="math2d_8h-source.html#l00251">csIntersect2::SegmentPlaneNoTest()</a>, <a class="el" href="plane2_8h-source.html#l00076">csPlane2::Set()</a>, and <a class="el" href="math2d_8h-source.html#l00069">csMath2::WhichSide2D()</a>.</p> </div> </div><p> <a class="anchor" name="4c7fac87d87a6a859e97e776a7954225"></a><!-- doxytag: member="csSegment2::Set" ref="4c7fac87d87a6a859e97e776a7954225" args="(const csVector2 &s, const csVector2 &e)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csSegment2::Set </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsVector2.html">csVector2</a> & </td> <td class="paramname"> <em>s</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsVector2.html">csVector2</a> & </td> <td class="paramname"> <em>e</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> Set segment to given values. <p> <p>Definition at line <a class="el" href="segment_8h-source.html#l00054">54</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p> </div> </div><p> <a class="anchor" name="a71e23bd828229fb9e439b779e8a815f"></a><!-- doxytag: member="csSegment2::SetEnd" ref="a71e23bd828229fb9e439b779e8a815f" args="(const csVector2 &e)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csSegment2::SetEnd </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsVector2.html">csVector2</a> & </td> <td class="paramname"> <em>e</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the end of the segment. <p> <p>Definition at line <a class="el" href="segment_8h-source.html#l00061">61</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p> <p>Referenced by <a class="el" href="box_8h-source.html#l00187">csBox2::GetEdge()</a>.</p> </div> </div><p> <a class="anchor" name="0e2b0d0fb67363f272a4100b1c9f7dea"></a><!-- doxytag: member="csSegment2::SetStart" ref="0e2b0d0fb67363f272a4100b1c9f7dea" args="(const csVector2 &s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csSegment2::SetStart </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsVector2.html">csVector2</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> Set the start of the segment. <p> <p>Definition at line <a class="el" href="segment_8h-source.html#l00058">58</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p> <p>Referenced by <a class="el" href="box_8h-source.html#l00187">csBox2::GetEdge()</a>.</p> </div> </div><p> <a class="anchor" name="1e8c2728674801630a94716014437d26"></a><!-- doxytag: member="csSegment2::Start" ref="1e8c2728674801630a94716014437d26" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsVector2.html">csVector2</a>& csSegment2::Start </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 start of the segment. <p> <p>Definition at line <a class="el" href="segment_8h-source.html#l00070">70</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p> </div> </div><p> <a class="anchor" name="48ebbdb8de300930e733c0ba241d14df"></a><!-- doxytag: member="csSegment2::Start" ref="48ebbdb8de300930e733c0ba241d14df" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classcsVector2.html">csVector2</a>& csSegment2::Start </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 start of the segment. <p> <p>Definition at line <a class="el" href="segment_8h-source.html#l00064">64</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p> <p>Referenced by <a class="el" href="math2d_8h-source.html#l00224">csIntersect2::SegmentPlane()</a>, <a class="el" href="math2d_8h-source.html#l00251">csIntersect2::SegmentPlaneNoTest()</a>, <a class="el" href="plane2_8h-source.html#l00076">csPlane2::Set()</a>, and <a class="el" href="math2d_8h-source.html#l00069">csMath2::WhichSide2D()</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>csgeom/<a class="el" href="segment_8h-source.html">segment.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>