regular_polygon.h

Go to the documentation of this file.

/* Author(s) :     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2010-02-14
 * Last modified: 2015-02-16
 *
 * License:
 *
 * Description:
 *
 *   A regular_polygon in x-y plane
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_REGULAR_POLYGON_H
#define GEOMTOOLS_REGULAR_POLYGON_H 1

// Standard library:
#include <string>

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

namespace geomtools {


  class regular_polygon : public i_shape_2d,
                          public i_polygon
  {

  public:

    static const std::string & regular_polygon_label();

    enum mode_type {
      BUILD_BY_RADIUS  = 1,
      BUILD_BY_APOTHEM = 2
    };

    static const unsigned int MIN_NUMBER_OF_SIDES = 3;

    bool is_valid() const;

    uint32_t get_n_sides() const;

    void set_n_sides(uint32_t);

    double get_apothem() const;

    virtual double get_perimeter(uint32_t flags_ = ALL_PIECES) const;

    double get_side_length() const;

    double get_reference_angle() const;

    double get_r() const;

    double get_radius() const;

    void set_r(double);

    void set_diameter(double);

    virtual double get_diameter() const;

    virtual double get_surface(uint32_t flags_ = ALL_PIECES) const;

    void get_vertex(int n_, double & x_, double & y_) const;

    void get_vertex(int n_, vector_3d & vertex_) const;

    regular_polygon();

    regular_polygon(uint32_t n_sides_, double r_, int mode_ = BUILD_BY_RADIUS);

    virtual ~regular_polygon();

    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_ = true,
                                            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 rp_wires_rendering_option_type {
      WR_RP_NO_EXTERNAL_EDGES = (WR_BASE_LAST << 1),       
      WR_RP_LAST              = (WR_RP_NO_EXTERNAL_EDGES), 
      WR_RP_MASK              = (WR_RP_NO_EXTERNAL_EDGES)  
    };

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

    virtual unsigned int compute_vertexes(vertex_col_type & vertexes_) const;

  private:

    uint32_t _n_sides_; 
    double   _r_;       

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(regular_polygon)

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_REGULAR_POLYGON_H

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