extruded_box.h

Go to the documentation of this file.

/* Author(s):     Arnaud Chapon <chapon@lpccaen.in2p3.fr>
 *                François Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2014-10-27
 * Last modified: 2015-03-23
 *
 * License:
 *
 * Description:
 *  Interface:
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_EXTRUDED_BOX_H
#define GEOMTOOLS_EXTRUDED_BOX_H 1

// Third party:
// - Boost:
#include <boost/cstdint.hpp>
#include <boost/scoped_ptr.hpp>
// - Bayeux/datatools:
#include <datatools/object_configuration_description.h>

// This project:
#include <geomtools/i_shape_3d.h>
#include <geomtools/i_stackable.h>
#include <geomtools/placement.h>

namespace datatools {
  // Forward class declaration:
  class properties;
}

namespace geomtools {

  // Forward class declaration:
  class box;
  class composite_surface;

  class extruded_box : public i_shape_3d,
                       public i_stackable
  {

  public:

    static const std::string & extruded_box_label();

    enum faces_mask_type {
      FACE_NONE          = face_identifier::FACE_BITS_NONE,
      FACE_BACK          = datatools::bit_mask::bit00,
      FACE_FRONT         = datatools::bit_mask::bit01,
      FACE_LEFT          = datatools::bit_mask::bit02,
      FACE_RIGHT         = datatools::bit_mask::bit03,
      FACE_BOTTOM        = datatools::bit_mask::bit04,
      FACE_TOP           = datatools::bit_mask::bit05,
      FACE_INSIDE_BACK   = datatools::bit_mask::bit06,
      FACE_INSIDE_FRONT  = datatools::bit_mask::bit07,
      FACE_INSIDE_LEFT   = datatools::bit_mask::bit08,
      FACE_INSIDE_RIGHT  = datatools::bit_mask::bit09,
      FACE_INSIDE_BOTTOM = datatools::bit_mask::bit10,
      FACE_INSIDE_TOP    = datatools::bit_mask::bit11,
      FACE_ALL           = (FACE_BACK
                            | FACE_FRONT
                            | FACE_LEFT
                            | FACE_RIGHT
                            | FACE_BOTTOM
                            | FACE_TOP
                            | FACE_INSIDE_BACK
                            | FACE_INSIDE_FRONT
                            | FACE_INSIDE_LEFT
                            | FACE_INSIDE_RIGHT
                            | FACE_INSIDE_BOTTOM
                            | FACE_INSIDE_TOP)
    };

    double get_xmin() const;

    double get_xmax() const;

    double get_ymin() const;

    double get_ymax() const;

    double get_zmin() const;

    double get_zmax() const;

    double get_x() const;

    void set_x(double);

    double get_half_x() const;

    void set_half_x(double);

    double get_y() const;

    void set_y(double);

    double get_half_y() const;

    void set_half_y(double);

    double get_z() const;

    void set_z(double);

    double get_half_z() const;

    void set_half_z(double);

    void set(double, double, double, double);

    void set_half(double, double, double, double);

    double get_thickness() const;

    void set_thickness(double);

    bool has_bottom() const;

    void set_bottom(bool);

    void add_bottom();

    void remove_bottom();

    bool has_top() const;

    void set_top(bool);

    void add_top();

    void remove_top();

    extruded_box();

    extruded_box(double x_, double y_, double z_, double t_,
                 bool has_top_ = true, bool has_bottom_ = true);

    virtual ~extruded_box();

    virtual std::string get_shape_name() const;

    // Check the validity of the object
    bool is_valid() const;

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

    virtual void reset();

    double get_parameter(const std::string &) const;

    virtual double get_surface(uint32_t mask_ = FACE_ALL) const;

    virtual double get_volume(uint32_t flags_ = 0) const;

    virtual bool is_inside(const vector_3d &,
                           double skin_ = GEOMTOOLS_PROPER_TOLERANCE) const;

    virtual bool is_outside(const vector_3d &,
                            double skin_ = GEOMTOOLS_PROPER_TOLERANCE) const;

    virtual face_identifier on_surface(const vector_3d &,
                                       const face_identifier & a_surface_mask = face_identifier::face_bits_any(),
                                       double a_skin = GEOMTOOLS_PROPER_TOLERANCE) const;

    virtual vector_3d get_normal_on_surface(const vector_3d & a_position,
                                            const face_identifier & a_surface_bit) const;

    friend std::ostream & operator<<( std::ostream &, const extruded_box & );

    friend std::istream & operator>>( std::istream &, extruded_box & );

    virtual bool find_intercept(const vector_3d & from_,
                                const vector_3d & direction_,
                                face_intercept_info & intercept_,
                                double skin_ = 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;

    virtual unsigned int compute_faces(face_info_collection_type & faces_) const;

    void compute_outer_box(box & outer_box_) const;

    void compute_inner_box(box & inner_box_, placement & face_placement_) const;

    void compute_extruded_top_bottom_face(faces_mask_type face_id_,
                                          composite_surface & face_,
                                          placement & face_placement_) const;

    enum extruded_box_wires_rendering_option_type {
      WR_EXTRBOX_NO_EXTERNAL_FACES = (WR_BASE_LAST << 1),             
      WR_EXTRBOX_NO_INTERNAL_FACES = (WR_BASE_LAST << 2),             
      WR_EXTRBOX_LAST              = (WR_EXTRBOX_NO_INTERNAL_FACES),  
      WR_EXTRBOX_MASK              = (WR_EXTRBOX_NO_EXTERNAL_FACES
                                      | WR_EXTRBOX_NO_INTERNAL_FACES) 
    };

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

    static void init_ocd(datatools::object_configuration_description &);

  protected:

    void _set_default();

    virtual void _build_bounding_data();

  private:

    double _x_;          
    double _y_;          
    double _z_;          
    double _thickness_;  
    bool   _has_top_;    
    bool   _has_bottom_; 

    // // Work
    // datatools::handle<box> _h_outer_box_;
    // datatools::handle<box> _h_inner_box_;
    // placement              _inner_box_placement_;

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(extruded_box)

  };

} // end of namespace geomtools

// @arg geomtools::extruded_box the name the class with registered OCD support
DOCD_CLASS_DECLARATION(geomtools::extruded_box)

#endif // GEOMTOOLS_EXTRUDED_BOX_H

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