| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Box Concept</title> |
| <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> |
| <link rel="home" href="../../../index.html" title="Chapter 1. Geometry 1.0"> |
| <link rel="up" href="../concepts.html" title="Concepts"> |
| <link rel="prev" href="concept_multi_polygon.html" title="MultiPolygon Concept"> |
| <link rel="next" href="concept_ring.html" title="Ring Concept"> |
| </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="concept_multi_polygon.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.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="concept_ring.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.concepts.concept_box"></a><a class="link" href="concept_box.html" title="Box Concept">Box Concept</a> |
| </h4></div></div></div> |
| <a name="geometry.reference.concepts.concept_box.description"></a><h6> |
| <a name="geometry.reference.concepts.concept_box.description-heading"></a> |
| <a class="link" href="concept_box.html#geometry.reference.concepts.concept_box.description">Description</a> |
| </h6> |
| <p> |
| The Box Concept describes the requirements for a box type. All algorithms |
| in Boost.Geometry will check any geometry arguments against the concept |
| requirements. |
| </p> |
| <p> |
| A box is a geometry with (usually) two or three dimensions, having its |
| axis aligned to the coordinate system. |
| </p> |
| <p> |
| The box is not one of the basic types in Boost.Geometry (point, linestring, |
| polygon) but it is a <span class="emphasis"><em>helper type</em></span>. The main reasons |
| for the box existance are its usefulness for indexing (a spatial index, |
| or splitting a geometry into monotonic sections) and it is the output of |
| the <a class="link" href="../algorithms/envelope.html" title="envelope">envelope</a> |
| algorithm. |
| </p> |
| <p> |
| Therefore, a box is axis aligned (the envelope is also called aabb, axis |
| aligned bounding box). |
| </p> |
| <a name="geometry.reference.concepts.concept_box.concept_definition"></a><h6> |
| <a name="geometry.reference.concepts.concept_box.concept_definition-heading"></a> |
| <a class="link" href="concept_box.html#geometry.reference.concepts.concept_box.concept_definition">Concept |
| Definition</a> |
| </h6> |
| <p> |
| The Box Concept is defined as following: |
| </p> |
| <div class="itemizedlist"><ul class="itemizedlist" type="disc"> |
| <li class="listitem"> |
| there must be a specialization of <code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">tag</span></code>, |
| defining <code class="computeroutput"><span class="identifier">box_tag</span></code> as |
| type |
| </li> |
| <li class="listitem"> |
| there must be a specialization of <code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">point_type</span></code> |
| to define the underlying point type (even if it does not consist of |
| points, it should define this type, to indicate the points it can work |
| with) |
| </li> |
| <li class="listitem"> |
| there must be a specialization of <code class="computeroutput"><span class="identifier">traits</span><span class="special">::</span><span class="identifier">indexed_access</span></code>, |
| per index (<code class="computeroutput"><span class="identifier">min_corner</span></code>, |
| <code class="computeroutput"><span class="identifier">max_corner</span></code>) and per |
| dimension, with two functions: |
| <div class="itemizedlist"><ul class="itemizedlist" type="circle"> |
| <li class="listitem"> |
| <code class="computeroutput"><span class="identifier">get</span></code> to get a |
| coordinate value |
| </li> |
| <li class="listitem"> |
| <code class="computeroutput"><span class="identifier">set</span></code> to set a |
| coordinate value (this one is not checked for ConstBox) |
| </li> |
| </ul></div> |
| </li> |
| </ul></div> |
| <a name="geometry.reference.concepts.concept_box.available_models"></a><h6> |
| <a name="geometry.reference.concepts.concept_box.available_models-heading"></a> |
| <a class="link" href="concept_box.html#geometry.reference.concepts.concept_box.available_models">Available |
| Models</a> |
| </h6> |
| <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> |
| <a class="link" href="../models/model_box.html" title="model::box">model::box</a> |
| </li></ul></div> |
| </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 © 2011 Barend Gehrels, Bruno Lalande, Mateusz Loskot<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="concept_multi_polygon.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../concepts.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="concept_ring.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
