rectangle.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-15
 *
 * License:
 *
 * Description:
 *
 *   A rectangle in x-y plane
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_RECTANGLE_H
#define GEOMTOOLS_RECTANGLE_H 1

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

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

namespace geomtools {

  class rectangle : public i_shape_2d,
                    public i_polygon
  {

  public:

    static const std::string & rectangle_label();

    bool is_valid() const;

    double get_x() const;

    double get_y() const;

    void set_x(double);

    void set_y(double);

    void set(double x_, double y_);

    virtual double get_surface(uint32_t flags_ = ALL_PIECES) const;

    virtual double get_perimeter(uint32_t flags_ = ALL_PIECES) const;

    double get_circumference() const;

    // Return the diagonal
    double get_diagonal() const;

    rectangle();

    rectangle(double x_, double y_);

    virtual ~rectangle();

    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 rectangle_wires_rendering_option_type {
      WR_RECT_NO_XMINUS_SIDE = (WR_BASE_LAST << 1),      
      WR_RECT_NO_XPLUS_SIDE  = (WR_BASE_LAST << 2),      
      WR_RECT_NO_YMINUS_SIDE = (WR_BASE_LAST << 3),      
      WR_RECT_NO_YPLUS_SIDE  = (WR_BASE_LAST << 4),      
      WR_RECT_LAST           = (WR_RECT_NO_YPLUS_SIDE),  
      WR_RECT_MASK           = (WR_RECT_NO_XMINUS_SIDE
                                | WR_RECT_NO_XPLUS_SIDE
                                | WR_RECT_NO_YMINUS_SIDE
                                | WR_RECT_NO_YPLUS_SIDE) 
    };

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

    virtual unsigned int compute_vertexes(vertex_col_type & vertexes_) const;

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

    void reset();

  protected:

    void _set_defaults();

  private:

    double _x_; 
    double _y_; 

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(rectangle)

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_RECTANGLE_H

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