<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>ClanLib: CL_LineSegment3d Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ClanLib
 <span id="projectnumber">2.3.7</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="classCL__LineSegment3d-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CL_LineSegment3d Class Reference<div class="ingroups"><a class="el" href="group__clanCore__Math.html">clanCore Math</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>3D line segment - Double
<a href="classCL__LineSegment3d.html#details">More...</a></p>
<p><code>#include <<a class="el" href="line__segment_8h_source.html">line_segment.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for CL_LineSegment3d:</div>
<div class="dyncontent">
<div class="center"><img src="classCL__LineSegment3d__inherit__graph.png" border="0" usemap="#CL__LineSegment3d_inherit__map" alt="Inheritance graph"/></div>
<map name="CL__LineSegment3d_inherit__map" id="CL__LineSegment3d_inherit__map">
<area shape="rect" id="node2" href="classCL__LineSegment3x.html" title="CL_LineSegment3x\< double \>" alt="" coords="5,101,224,131"/><area shape="rect" id="node4" href="classCL__LineSegment3x.html" title="3D line segment " alt="" coords="13,5,216,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa809e27c40baa2dddd566838651fc11f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__LineSegment3d.html#aa809e27c40baa2dddd566838651fc11f">CL_LineSegment3d</a> ()</td></tr>
<tr class="separator:aa809e27c40baa2dddd566838651fc11f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a49f358531d52a9fe43655db3ec21d858"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__LineSegment3d.html#a49f358531d52a9fe43655db3ec21d858">CL_LineSegment3d</a> (const <a class="el" href="classCL__LineSegment3x.html">CL_LineSegment3x</a>< double > &copy)</td></tr>
<tr class="separator:a49f358531d52a9fe43655db3ec21d858"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac84d85335c20767daf3b7e7b8b63ee75"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__LineSegment3d.html#ac84d85335c20767daf3b7e7b8b63ee75">CL_LineSegment3d</a> (const <a class="el" href="classCL__Vec3.html">CL_Vec3</a>< double > &point_p, const <a class="el" href="classCL__Vec3.html">CL_Vec3</a>< double > &point_q)</td></tr>
<tr class="separator:ac84d85335c20767daf3b7e7b8b63ee75"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Attributes</div></td></tr>
<tr class="memitem:adb83f8fa4ee56e1fbb1cd51ac6044658"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCL__Vec3.html">CL_Vec3</a>< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__LineSegment3x.html#adb83f8fa4ee56e1fbb1cd51ac6044658">get_midpoint</a> () const</td></tr>
<tr class="memdesc:adb83f8fa4ee56e1fbb1cd51ac6044658"><td class="mdescLeft"> </td><td class="mdescRight">Get the midpoint of this line. <a href="#adb83f8fa4ee56e1fbb1cd51ac6044658">More...</a><br/></td></tr>
<tr class="separator:adb83f8fa4ee56e1fbb1cd51ac6044658"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff2f126534373b7d73e47cc83471ce2c"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__LineSegment3x.html#aff2f126534373b7d73e47cc83471ce2c">point_distance</a> (const <a class="el" href="classCL__Vec3.html">CL_Vec3</a>< double > &point, <a class="el" href="classCL__Vec3.html">CL_Vec3</a>< double > &dest_intercept) const</td></tr>
<tr class="memdesc:aff2f126534373b7d73e47cc83471ce2c"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the distance from a line segment to a point. <a href="#aff2f126534373b7d73e47cc83471ce2c">More...</a><br/></td></tr>
<tr class="separator:aff2f126534373b7d73e47cc83471ce2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Operators</div></td></tr>
<tr class="memitem:a1abb5b2e24d0763d826a782817267f71"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__LineSegment3x.html#a1abb5b2e24d0763d826a782817267f71">operator==</a> (const <a class="el" href="classCL__LineSegment3x.html">CL_LineSegment3x</a>< double > &line) const</td></tr>
<tr class="memdesc:a1abb5b2e24d0763d826a782817267f71"><td class="mdescLeft"> </td><td class="mdescRight">== operator. <a href="#a1abb5b2e24d0763d826a782817267f71">More...</a><br/></td></tr>
<tr class="separator:a1abb5b2e24d0763d826a782817267f71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad936ed296c30309d8bad7193e23dad35"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__LineSegment3x.html#ad936ed296c30309d8bad7193e23dad35">operator!=</a> (const <a class="el" href="classCL__LineSegment3x.html">CL_LineSegment3x</a>< double > &line) const</td></tr>
<tr class="memdesc:ad936ed296c30309d8bad7193e23dad35"><td class="mdescLeft"> </td><td class="mdescRight">!= operator. <a href="#ad936ed296c30309d8bad7193e23dad35">More...</a><br/></td></tr>
<tr class="separator:ad936ed296c30309d8bad7193e23dad35"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aa80c921330c3c0f30d617a1357884c35"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCL__Vec3.html">CL_Vec3</a>< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__LineSegment3x.html#aa80c921330c3c0f30d617a1357884c35">p</a></td></tr>
<tr class="memdesc:aa80c921330c3c0f30d617a1357884c35"><td class="mdescLeft"> </td><td class="mdescRight">Start point on the line. <a href="#aa80c921330c3c0f30d617a1357884c35">More...</a><br/></td></tr>
<tr class="separator:aa80c921330c3c0f30d617a1357884c35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6f520010b53fc3b35fdbcc5e5aeb1e43"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCL__Vec3.html">CL_Vec3</a>< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__LineSegment3x.html#a6f520010b53fc3b35fdbcc5e5aeb1e43">q</a></td></tr>
<tr class="separator:a6f520010b53fc3b35fdbcc5e5aeb1e43"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>3D line segment - Double </p>
<p>A line segment has a start point and an end point<br/>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa809e27c40baa2dddd566838651fc11f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CL_LineSegment3d::CL_LineSegment3d </td>
<td>(</td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a49f358531d52a9fe43655db3ec21d858"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CL_LineSegment3d::CL_LineSegment3d </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCL__LineSegment3x.html">CL_LineSegment3x</a>< double > & </td>
<td class="paramname"><em>copy</em>)</td><td></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ac84d85335c20767daf3b7e7b8b63ee75"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CL_LineSegment3d::CL_LineSegment3d </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCL__Vec3.html">CL_Vec3</a>< double > & </td>
<td class="paramname"><em>point_p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCL__Vec3.html">CL_Vec3</a>< double > & </td>
<td class="paramname"><em>point_q</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="adb83f8fa4ee56e1fbb1cd51ac6044658"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCL__Vec3.html">CL_Vec3</a><double > <a class="el" href="classCL__LineSegment3x.html">CL_LineSegment3x</a>< double >::get_midpoint </td>
<td>(</td>
<td class="paramname">)</td><td></td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the midpoint of this line. </p>
<dl class="section return"><dt>Returns</dt><dd>The midpoint </dd></dl>
</div>
</div>
<a class="anchor" id="ad936ed296c30309d8bad7193e23dad35"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classCL__LineSegment3x.html">CL_LineSegment3x</a>< double >::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCL__LineSegment3x.html">CL_LineSegment3x</a>< double > & </td>
<td class="paramname"><em>line</em>)</td><td></td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>!= operator. </p>
</div>
</div>
<a class="anchor" id="a1abb5b2e24d0763d826a782817267f71"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classCL__LineSegment3x.html">CL_LineSegment3x</a>< double >::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCL__LineSegment3x.html">CL_LineSegment3x</a>< double > & </td>
<td class="paramname"><em>line</em>)</td><td></td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>== operator. </p>
</div>
</div>
<a class="anchor" id="aff2f126534373b7d73e47cc83471ce2c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classCL__LineSegment3x.html">CL_LineSegment3x</a>< double >::point_distance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCL__Vec3.html">CL_Vec3</a>< double > & </td>
<td class="paramname"><em>point</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCL__Vec3.html">CL_Vec3</a>< double > & </td>
<td class="paramname"><em>dest_intercept</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the distance from a line segment to a point. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">point</td><td>= The point </td></tr>
<tr><td class="paramname">dest_intercept</td><td>= On Return: The point on the line closest to the point </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The Distance </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aa80c921330c3c0f30d617a1357884c35"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCL__Vec3.html">CL_Vec3</a><double > <a class="el" href="classCL__LineSegment3x.html">CL_LineSegment3x</a>< double >::p</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Start point on the line. </p>
</div>
</div>
<a class="anchor" id="a6f520010b53fc3b35fdbcc5e5aeb1e43"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCL__Vec3.html">CL_Vec3</a><double > <a class="el" href="classCL__LineSegment3x.html">CL_LineSegment3x</a>< double >::q</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="line__segment_8h_source.html">line_segment.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 14 2013 13:05:57 for ClanLib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
