libs/geometry/doc/html/geometry/reference/models/model_segment.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>model::segment</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Geometry">
   8 <link rel="up" href="../models.html" title="Models">
   9 <link rel="prev" href="model_ring.html" title="model::ring">
  10 <link rel="next" href="model_referring_segment.html" title="model::referring_segment">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="model_ring.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="model_referring_segment.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="geometry.reference.models.model_segment"></a><a class="link" href="model_segment.html" title="model::segment">model::segment</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp127793936"></a><a class="indexterm" name="idp127794624"></a>
  31 Class segment: small class containing two points.
  32         </p>
  33 <h6>
  34 <a name="geometry.reference.models.model_segment.h0"></a>
  35           <span class="phrase"><a name="geometry.reference.models.model_segment.description"></a></span><a class="link" href="model_segment.html#geometry.reference.models.model_segment.description">Description</a>
  36         </h6>
  37 <p>
  38           From Wikipedia: In geometry, a line segment is a part of a line that is
  39           bounded by two distinct end points, and contains every point on the line
  40           between its end points.
  41         </p>
  42 <h6>
  43 <a name="geometry.reference.models.model_segment.h1"></a>
  44           <span class="phrase"><a name="geometry.reference.models.model_segment.synopsis"></a></span><a class="link" href="model_segment.html#geometry.reference.models.model_segment.synopsis">Synopsis</a>
  45         </h6>
  46 <p>
  47 </p>
  48 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Point</span><span class="special">&gt;</span>
  49 <span class="keyword">class</span> <span class="identifier">model</span><span class="special">::</span><span class="identifier">segment</span>
  50       <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">Point</span><span class="special">,</span> <span class="identifier">Point</span> <span class="special">&gt;</span>
  51 <span class="special">{</span>
  52   <span class="comment">// ...</span>
  53 <span class="special">};</span>
  54 </pre>
  55 <p>
  56         </p>
  57 <h6>
  58 <a name="geometry.reference.models.model_segment.h2"></a>
  59           <span class="phrase"><a name="geometry.reference.models.model_segment.template_parameter_s_"></a></span><a class="link" href="model_segment.html#geometry.reference.models.model_segment.template_parameter_s_">Template
  60           parameter(s)</a>
  61         </h6>
  62 <div class="informaltable"><table class="table">
  63 <colgroup>
  64 <col>
  65 <col>
  66 </colgroup>
  67 <thead><tr>
  68 <th>
  69                   <p>
  70                     Parameter
  71                   </p>
  72                 </th>
  73 <th>
  74                   <p>
  75                     Description
  76                   </p>
  77                 </th>
  78 </tr></thead>
  79 <tbody><tr>
  80 <td>
  81                   <p>
  82                     typename Point
  83                   </p>
  84                 </td>
  85 <td>
  86                 </td>
  87 </tr></tbody>
  88 </table></div>
  89 <h6>
  90 <a name="geometry.reference.models.model_segment.h3"></a>
  91           <span class="phrase"><a name="geometry.reference.models.model_segment.constructor_s_"></a></span><a class="link" href="model_segment.html#geometry.reference.models.model_segment.constructor_s_">Constructor(s)</a>
  92         </h6>
  93 <div class="informaltable"><table class="table">
  94 <colgroup>
  95 <col>
  96 <col>
  97 <col>
  98 </colgroup>
  99 <thead><tr>
 100 <th>
 101                   <p>
 102                     Function
 103                   </p>
 104                 </th>
 105 <th>
 106                   <p>
 107                     Description
 108                   </p>
 109                 </th>
 110 <th>
 111                   <p>
 112                     Parameters
 113                   </p>
 114                 </th>
 115 </tr></thead>
 116 <tbody>
 117 <tr>
 118 <td>
 119                   <p>
 120 </p>
 121 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">segment</span><span class="special">()</span></pre>
 122 <p>
 123                   </p>
 124                 </td>
 125 <td>
 126                 </td>
 127 <td>
 128                 </td>
 129 </tr>
 130 <tr>
 131 <td>
 132                   <p>
 133 </p>
 134 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">segment</span><span class="special">(</span><span class="identifier">Point</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">p1</span><span class="special">,</span> <span class="identifier">Point</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">p2</span><span class="special">)</span></pre>
 135 <p>
 136                   </p>
 137                 </td>
 138 <td>
 139                 </td>
 140 <td>
 141                   <p>
 142                     <span class="bold"><strong>Point const &amp;</strong></span>: <span class="emphasis"><em>p1</em></span>:
 143                   </p>
 144                   <p>
 145                     <span class="bold"><strong>Point const &amp;</strong></span>: <span class="emphasis"><em>p2</em></span>:
 146                   </p>
 147                 </td>
 148 </tr>
 149 </tbody>
 150 </table></div>
 151 <h6>
 152 <a name="geometry.reference.models.model_segment.h4"></a>
 153           <span class="phrase"><a name="geometry.reference.models.model_segment.header"></a></span><a class="link" href="model_segment.html#geometry.reference.models.model_segment.header">Header</a>
 154         </h6>
 155 <p>
 156           Either
 157         </p>
 158 <p>
 159           <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">&gt;</span></code>
 160         </p>
 161 <p>
 162           Or
 163         </p>
 164 <p>
 165           <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</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">&gt;</span></code>
 166         </p>
 167 </div>
 168 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 169 <td align="left"></td>
 170 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2014 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 171       Wulkiewicz, Oracle and/or its affiliates<p>
 172         Distributed under the Boost Software License, Version 1.0. (See accompanying
 173         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>)
 174       </p>
 175 </div></td>
 176 </tr></table>
 177 <hr>
 178 <div class="spirit-nav">
 179 <a accesskey="p" href="model_ring.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="model_referring_segment.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 180 </div>
 181 </body>
 182 </html>