polyline_3d.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2009-03-31
 * Last modified: 2009-03-31
 */

#ifndef GEOMTOOLS_POLYLINE_3D_H
#define GEOMTOOLS_POLYLINE_3D_H 1

// Standard library:
#include <iostream>
#include <stdexcept>
#include <list>

// Third party:
// - Bayeux/datatools:
#include <datatools/i_serializable.h>

// This project:
#include <geomtools/i_shape_1d.h>
#include <geomtools/utils.h>
#include <geomtools/i_wires_3d_rendering.h>

namespace geomtools {

  class polyline_3d : public i_shape_1d,
                      public i_wires_3d_rendering
  {
  public:

    static const std::string & polyline_3d_label();

    static const bool CLOSED = true;
    static const bool closed = CLOSED;
    static const bool OPEN   = false;
    static const bool open   = OPEN;
    static const bool DEFAULT_CLOSED = OPEN;

    typedef polyline_type point_col;

    virtual std::string get_shape_name() const;

    bool is_valid() const;

    bool is_closed() const;

    void set_closed(bool);

    bool is_empty() const;

    polyline_3d();

    polyline_3d(bool closed_);

    virtual ~polyline_3d();

    void clear();

    void add(const vector_3d &);

    int get_number_of_points() const;

    const vector_3d & get_point(int i_) const;

    int get_number_of_vertex() const;

    int get_number_of_vertexes() const;

    const vector_3d & get_vertex(int i_) const;

    virtual double get_length(uint32_t flags_ = PATH_ALL_BITS) const;

    // inefficient algorithm:
    void make_vertex_collection(basic_polyline_3d &) const;

    // inefficient algorithm:
    polyline_type make_vertex_collection() const;

    virtual bool is_on_curve(const vector_3d & position_,
                             double tolerance_ = GEOMTOOLS_PROPER_TOLERANCE) const;

    virtual vector_3d get_direction_on_curve(const vector_3d & position_) const;

    const polyline_type & get_points() const;

    polyline_type & grab_points();

    virtual void tree_dump(std::ostream & out_         = std::clog,
                           const std::string & title_  = "",
                           const std::string & indent_ = "",
                           bool inherit_               = false) const;

    virtual void generate_wires_self(wires_type & wires_,
                                     uint32_t options_ = 0) const;

  private:

    bool          _closed_; 
    polyline_type _points_; 

    DATATOOLS_SERIALIZATION_DECLARATION()

  };

} // end of namespace geomtools

BOOST_CLASS_EXPORT_KEY2(geomtools::polyline_3d, "geomtools::polyline_3d")

// Explicit class version:
#include <boost/serialization/version.hpp>
BOOST_CLASS_VERSION(geomtools::polyline_3d, 2)

#endif // GEOMTOOLS_POLYLINE_3D_H

/*
** Local Variables: --
** mode: c++ --
** c-file-style: "gnu" --
** tab-width: 2 --
** End: --
*/