line_3d.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2008-12-18
 * Last modified: 2015-02-22
 *
 * License:
 *
 * Description:
 *   Line 3D model
 *
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_LINE_3D_H
#define GEOMTOOLS_LINE_3D_H 1

// Standard library:
#include <iostream>
#include <string>

// - Bayeux/datatools:
#include <datatools/i_tree_dump.h>
#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 {

  // Forward declaration:
  class placement;

  class line_3d : public i_shape_1d,
                  public i_wires_3d_rendering
  {
  public:

    static const std::string & line_3d_label();

    bool is_normal();

    virtual std::string get_shape_name() const;

    bool is_valid() const;

    void invalidate();

    const vector_3d & get_first() const;

    void set_first(double x_, double y_, double z_);

    void set_first(const vector_3d &);

    const vector_3d & get_last() const;

    void set_last(double x_, double y_, double z_);

    void set_last(const vector_3d &);

    vector_3d get_point(double t_) const;

    virtual double get_length(uint32_t flags_ = PATH_ALL_BITS) const;

    line_3d();

    line_3d(const vector_3d & first_,
            const vector_3d & last_);

    line_3d(double x0_, double y0_, double z0_,
            double x1_, double y1_, double z1_);

    line_3d(const segment_type & segment_);

    virtual ~line_3d();

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

    static void print_xyz(std::ostream & out_, const line_3d & line_);

    static void orthogonal_projection(const vector_3d & p_,
                                      const vector_3d & m_,
                                      const vector_3d & u_,
                                      vector_3d & h_);

    static double distance_to_line(const vector_3d & p_,
                                   const vector_3d & m_,
                                   const vector_3d & u_);

    double get_distance_to_line(const vector_3d & position_ ) const;

    bool compute_orthogonal_projection(const vector_3d & position_, vector_3d & proj_) const;

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

    bool is_on_segment(const vector_3d & position_,
                       double tolerance_ = GEOMTOOLS_PROPER_TOLERANCE) 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;

    void make_vertex_collection(polyline_type &) const;

    polyline_type make_vertex_collection() const;

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

  private:

    vector_3d _first_; 
    vector_3d _last_;  

    // Serialization interface
    DATATOOLS_SERIALIZATION_DECLARATION()

  };

  typedef line_3d segment_3d;

} // end of namespace geomtools

#include <boost/serialization/export.hpp>
BOOST_CLASS_EXPORT_KEY2(geomtools::line_3d, "geomtools::line_3d")

// Class version:
#include <boost/serialization/version.hpp>
BOOST_CLASS_VERSION(geomtools::line_3d, 2)

#endif // GEOMTOOLS_LINE_3D_H

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