quadrangle.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2015-02-21
 * Last modified: 2015-02-21
 *
 * License:
 *
 * Description:
 *
 *   A planar quadrangle in 3D space
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_QUADRANGLE_H
#define GEOMTOOLS_QUADRANGLE_H 1

// Standard library:
#include <string>

// Third party:
// - Boost:
#include <boost/scoped_ptr.hpp>

// This project:
#include <geomtools/i_shape_2d.h>
#include <geomtools/i_polygon.h>

namespace geomtools {

  // Forward declaration:
  class triangle;

  class quadrangle : public i_shape_2d,
                     public i_polygon
  {

  public:

    static const std::string & quadrangle_label();

    bool is_valid() const;

    virtual double get_perimeter(uint32_t flags_ = ALL_PIECES) const;

    virtual double get_surface(uint32_t flags_ = ALL_PIECES) const;

    static bool check_vertexes(const geomtools::vector_3d & v0_,
                               const geomtools::vector_3d & v1_,
                               const geomtools::vector_3d & v2_,
                               const geomtools::vector_3d & v3_,
                               double tolerance_ = 0.0);

    void set_vertexes(const vector_3d & p0_, const vector_3d & p1_, const vector_3d & p2_, const vector_3d & p3_);

    void set_vertexes_ext(const vector_3d & p0_, const vector_3d & p1_, const vector_3d & p2_, const vector_3d & p3_);

    bool has_vertex_0_ext() const;

    bool has_vertex_1_ext() const;

    bool has_vertex_2_ext() const;

    bool has_vertex_3_ext() const;

    const vector_3d & get_vertex_0() const;

    const vector_3d & get_vertex_1() const;

    const vector_3d & get_vertex_2() const;

    const vector_3d & get_vertex_3() const;

    const vector_3d & get_vertex(int) const;

    quadrangle();

    quadrangle(const vector_3d & p0_, const vector_3d & p1_, const vector_3d & p2_, const vector_3d & p3_);

    virtual ~quadrangle();

    void initialize(const datatools::properties &, const handle_dict_type * = 0);

    void reset();

    virtual std::string get_shape_name() const;

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

    virtual vector_3d get_normal_on_surface(const vector_3d & position_,
                                            bool check_ = false,
                                            double skin_ = GEOMTOOLS_PROPER_TOLERANCE) const;

    virtual bool find_intercept(const vector_3d & from_,
                                const vector_3d & direction_,
                                face_intercept_info & intercept_,
                                double tolerance_ = GEOMTOOLS_PROPER_TOLERANCE) const;

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

    enum inner_triangle_index_type {
      IT_NONE   = 0, 
      IT_FIRST  = 1, 
      IT_SECOND = 2  
    };

    void make_pair_of_triangles(triangle & ta_, triangle & tb_, int = 0) const;

    const triangle & get_triangle(inner_triangle_index_type i_) const;

    void compute_proper_frame(vector_3d & u0_, vector_3d & u1_, vector_3d & u2_) const;

    bool compute_proper_frame_coordinates(const vector_3d & position_, double & xp_, double & yp_, double & zp_) const;


    enum quadrangle_wires_rendering_option_type {
      WR_QUADRANGLE_NO_FIRST_EDGE     = (WR_BASE_LAST << 1),             
      WR_QUADRANGLE_NO_SECOND_EDGE    = (WR_BASE_LAST << 2),             
      WR_QUADRANGLE_NO_THIRD_EDGE     = (WR_BASE_LAST << 3),             
      WR_QUADRANGLE_NO_FOURTH_EDGE    = (WR_BASE_LAST << 4),             
      WR_QUADRANGLE_NO_EXTERNAL_EDGES = (WR_QUADRANGLE_NO_FIRST_EDGE
                                       | WR_QUADRANGLE_NO_SECOND_EDGE
                                       | WR_QUADRANGLE_NO_THIRD_EDGE
                                       | WR_QUADRANGLE_NO_FOURTH_EDGE
                                       ),                              
      WR_QUADRANGLE_LAST              = (WR_QUADRANGLE_NO_FOURTH_EDGE),     
      WR_QUADRANGLE_MASK              = (WR_QUADRANGLE_NO_FIRST_EDGE
                                       | WR_QUADRANGLE_NO_SECOND_EDGE
                                       | WR_QUADRANGLE_NO_THIRD_EDGE
                                       | WR_QUADRANGLE_NO_FOURTH_EDGE
                                       )                               
    };

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

    virtual unsigned int compute_vertexes(vertex_col_type & vertexes_) const;

  protected:

    void _set_defaults();

  private:

    const vector_3d * _vertex_0_ext_; 
    const vector_3d * _vertex_1_ext_; 
    const vector_3d * _vertex_2_ext_; 
    const vector_3d * _vertex_3_ext_; 
    vector_3d _vertex_0_; 
    vector_3d _vertex_1_; 
    vector_3d _vertex_2_; 
    vector_3d _vertex_3_; 

    // Working data:
    boost::scoped_ptr<triangle> _t012_;
    boost::scoped_ptr<triangle> _t023_;

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(quadrangle)

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_QUADRANGLE_H

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