| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>model::referring_segment</title> |
| <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> |
| <link rel="home" href="../../../index.html" title="Chapter 1. Geometry"> |
| <link rel="up" href="../models.html" title="Models"> |
| <link rel="prev" href="model_segment.html" title="model::segment"> |
| <link rel="next" href="../spatial_indexes.html" title="Spatial Indexes"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> |
| <td align="center"><a href="../../../../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="model_segment.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../models.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../spatial_indexes.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h4 class="title"> |
| <a name="geometry.reference.models.model_referring_segment"></a><a class="link" href="model_referring_segment.html" title="model::referring_segment">model::referring_segment</a> |
| </h4></div></div></div> |
| <p> |
| <a class="indexterm" name="idp125642880"></a><a class="indexterm" name="idp125643568"></a> |
| Class segment: small class containing two (templatized) point references. |
| </p> |
| <h6> |
| <a name="geometry.reference.models.model_referring_segment.h0"></a> |
| <span class="phrase"><a name="geometry.reference.models.model_referring_segment.description"></a></span><a class="link" href="model_referring_segment.html#geometry.reference.models.model_referring_segment.description">Description</a> |
| </h6> |
| <p> |
| From Wikipedia: In geometry, a line segment is a part of a line that is |
| bounded by two distinct end points, and contains every point on the line |
| between its end points. |
| </p> |
| <h6> |
| <a name="geometry.reference.models.model_referring_segment.h1"></a> |
| <span class="phrase"><a name="geometry.reference.models.model_referring_segment.synopsis"></a></span><a class="link" href="model_referring_segment.html#geometry.reference.models.model_referring_segment.synopsis">Synopsis</a> |
| </h6> |
| <p> |
| </p> |
| <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">ConstOrNonConstPoint</span><span class="special">></span> |
| <span class="keyword">class</span> <span class="identifier">model</span><span class="special">::</span><span class="identifier">referring_segment</span> |
| <span class="special">{</span> |
| <span class="comment">// ...</span> |
| <span class="special">};</span> |
| </pre> |
| <p> |
| </p> |
| <h6> |
| <a name="geometry.reference.models.model_referring_segment.h2"></a> |
| <span class="phrase"><a name="geometry.reference.models.model_referring_segment.template_parameter_s_"></a></span><a class="link" href="model_referring_segment.html#geometry.reference.models.model_referring_segment.template_parameter_s_">Template |
| parameter(s)</a> |
| </h6> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Parameter |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| </tr></thead> |
| <tbody><tr> |
| <td> |
| <p> |
| typename ConstOrNonConstPoint |
| </p> |
| </td> |
| <td> |
| <p> |
| point type of the segment, maybe a point or a const point |
| </p> |
| </td> |
| </tr></tbody> |
| </table></div> |
| <h6> |
| <a name="geometry.reference.models.model_referring_segment.h3"></a> |
| <span class="phrase"><a name="geometry.reference.models.model_referring_segment.constructor_s_"></a></span><a class="link" href="model_referring_segment.html#geometry.reference.models.model_referring_segment.constructor_s_">Constructor(s)</a> |
| </h6> |
| <div class="informaltable"><table class="table"> |
| <colgroup> |
| <col> |
| <col> |
| <col> |
| </colgroup> |
| <thead><tr> |
| <th> |
| <p> |
| Function |
| </p> |
| </th> |
| <th> |
| <p> |
| Description |
| </p> |
| </th> |
| <th> |
| <p> |
| Parameters |
| </p> |
| </th> |
| </tr></thead> |
| <tbody><tr> |
| <td> |
| <p> |
| </p> |
| <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">referring_segment</span><span class="special">(</span><span class="identifier">point_type</span> <span class="special">&</span> <span class="identifier">p1</span><span class="special">,</span> <span class="identifier">point_type</span> <span class="special">&</span> <span class="identifier">p2</span><span class="special">)</span></pre> |
| <p> |
| </p> |
| </td> |
| <td> |
| </td> |
| <td> |
| <p> |
| <span class="bold"><strong>point_type &</strong></span>: <span class="emphasis"><em>p1</em></span>: |
| </p> |
| <p> |
| <span class="bold"><strong>point_type &</strong></span>: <span class="emphasis"><em>p2</em></span>: |
| </p> |
| </td> |
| </tr></tbody> |
| </table></div> |
| <h6> |
| <a name="geometry.reference.models.model_referring_segment.h4"></a> |
| <span class="phrase"><a name="geometry.reference.models.model_referring_segment.header"></a></span><a class="link" href="model_referring_segment.html#geometry.reference.models.model_referring_segment.header">Header</a> |
| </h6> |
| <p> |
| Either |
| </p> |
| <p> |
| <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> |
| </p> |
| <p> |
| Or |
| </p> |
| <p> |
| <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">segment</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> |
| </p> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2009-2015 Barend Gehrels, Bruno Lalande, |
| Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its affiliates<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="model_segment.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../models.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../spatial_indexes.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
