Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 1012

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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: csSegment3 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&nbsp;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&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>csSegment3 Class Reference<br>
<small>
[<a class="el" href="group__geom__utils.html">Geometry utilities</a>]</small>
</h1><!-- doxytag: class="csSegment3" -->A 3D line segment.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="segment_8h-source.html">csgeom/segment.h</a>&gt;</code>
<p>

<p>
<a href="classcsSegment3-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment3.html#bf767988527a9c2c5ff7adf06e8f182c">csSegment3</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Make a new uninitialized segment.  <a href="#bf767988527a9c2c5ff7adf06e8f182c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment3.html#552a2298494e1e5dea9ee788922380f7">csSegment3</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &amp;s, const <a class="el" href="classcsVector3.html">csVector3</a> &amp;e)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Make a new segment and initialize with the given values.  <a href="#552a2298494e1e5dea9ee788922380f7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment3.html#1ac618fc28a7bc0aea50302d4aebeed0">End</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the end of the segment.  <a href="#1ac618fc28a7bc0aea50302d4aebeed0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment3.html#86a7c7129da99c2c29cc83213cef732d">End</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the end of the segment.  <a href="#86a7c7129da99c2c29cc83213cef732d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment3.html#f026621bea02b8e3ba4ec9c71b0c03cc">Set</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &amp;s, const <a class="el" href="classcsVector3.html">csVector3</a> &amp;e)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set segment to given values.  <a href="#f026621bea02b8e3ba4ec9c71b0c03cc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment3.html#2ab9dca69f3ae9ebc6ab785cf5778372">SetEnd</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &amp;e)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the end of the segment.  <a href="#2ab9dca69f3ae9ebc6ab785cf5778372"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment3.html#714730c8fd12992dd5f129bd178f16d1">SetStart</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &amp;s)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the start of the segment.  <a href="#714730c8fd12992dd5f129bd178f16d1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment3.html#ae83e31f88da2071261024df2860c19b">Start</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the start of the segment.  <a href="#ae83e31f88da2071261024df2860c19b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSegment3.html#e8e48008356e3415af9029e97b36b4fe">Start</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the start of the segment.  <a href="#e8e48008356e3415af9029e97b36b4fe"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A 3D line segment. 
<p>Definition at line <a class="el" href="segment_8h-source.html#l00079">79</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="552a2298494e1e5dea9ee788922380f7"></a><!-- doxytag: member="csSegment3::csSegment3" ref="552a2298494e1e5dea9ee788922380f7" args="(const csVector3 &amp;s, const csVector3 &amp;e)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csSegment3::csSegment3           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>s</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>e</em></td><td>&nbsp;</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#l00089">89</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="bf767988527a9c2c5ff7adf06e8f182c"></a><!-- doxytag: member="csSegment3::csSegment3" ref="bf767988527a9c2c5ff7adf06e8f182c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csSegment3::csSegment3           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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#l00091">91</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="1ac618fc28a7bc0aea50302d4aebeed0"></a><!-- doxytag: member="csSegment3::End" ref="1ac618fc28a7bc0aea50302d4aebeed0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsVector3.html">csVector3</a>&amp; csSegment3::End           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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#l00113">113</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="86a7c7129da99c2c29cc83213cef732d"></a><!-- doxytag: member="csSegment3::End" ref="86a7c7129da99c2c29cc83213cef732d" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classcsVector3.html">csVector3</a>&amp; csSegment3::End           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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#l00107">107</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p>

<p>Referenced by <a class="el" href="math3d_8h-source.html#l00548">csIntersect3::SegmentXFrustum()</a>, <a class="el" href="math3d_8h-source.html#l00461">csIntersect3::SegmentXPlane()</a>, <a class="el" href="math3d_8h-source.html#l00565">csIntersect3::SegmentYFrustum()</a>, <a class="el" href="math3d_8h-source.html#l00486">csIntersect3::SegmentYPlane()</a>, <a class="el" href="math3d_8h-source.html#l00437">csIntersect3::SegmentZ0Plane()</a>, and <a class="el" href="math3d_8h-source.html#l00511">csIntersect3::SegmentZPlane()</a>.</p>

</div>
</div><p>
<a class="anchor" name="f026621bea02b8e3ba4ec9c71b0c03cc"></a><!-- doxytag: member="csSegment3::Set" ref="f026621bea02b8e3ba4ec9c71b0c03cc" args="(const csVector3 &amp;s, const csVector3 &amp;e)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csSegment3::Set           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>s</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>e</em></td><td>&nbsp;</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#l00094">94</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="2ab9dca69f3ae9ebc6ab785cf5778372"></a><!-- doxytag: member="csSegment3::SetEnd" ref="2ab9dca69f3ae9ebc6ab785cf5778372" args="(const csVector3 &amp;e)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csSegment3::SetEnd           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>e</em>          </td>
          <td>&nbsp;)&nbsp;</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#l00101">101</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#l00763">csBox3::GetEdge()</a>.</p>

</div>
</div><p>
<a class="anchor" name="714730c8fd12992dd5f129bd178f16d1"></a><!-- doxytag: member="csSegment3::SetStart" ref="714730c8fd12992dd5f129bd178f16d1" args="(const csVector3 &amp;s)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csSegment3::SetStart           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>s</em>          </td>
          <td>&nbsp;)&nbsp;</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#l00098">98</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#l00763">csBox3::GetEdge()</a>.</p>

</div>
</div><p>
<a class="anchor" name="ae83e31f88da2071261024df2860c19b"></a><!-- doxytag: member="csSegment3::Start" ref="ae83e31f88da2071261024df2860c19b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsVector3.html">csVector3</a>&amp; csSegment3::Start           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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#l00110">110</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="e8e48008356e3415af9029e97b36b4fe"></a><!-- doxytag: member="csSegment3::Start" ref="e8e48008356e3415af9029e97b36b4fe" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classcsVector3.html">csVector3</a>&amp; csSegment3::Start           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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#l00104">104</a> of file <a class="el" href="segment_8h-source.html">segment.h</a>.</p>

<p>Referenced by <a class="el" href="math3d_8h-source.html#l00548">csIntersect3::SegmentXFrustum()</a>, <a class="el" href="math3d_8h-source.html#l00461">csIntersect3::SegmentXPlane()</a>, <a class="el" href="math3d_8h-source.html#l00565">csIntersect3::SegmentYFrustum()</a>, <a class="el" href="math3d_8h-source.html#l00486">csIntersect3::SegmentYPlane()</a>, <a class="el" href="math3d_8h-source.html#l00437">csIntersect3::SegmentZ0Plane()</a>, and <a class="el" href="math3d_8h-source.html#l00511">csIntersect3::SegmentZPlane()</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>