box.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2008-05-23
 * Last modified: 2015-02-15
 *
 * License:
 *
 * Description:
 *
 *  Box solid shape
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_BOX_H
#define GEOMTOOLS_BOX_H 1

// Standard library:
#include <vector>

// Third party:
// - Boost:
#include <boost/cstdint.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 {

  // Class forward declarations:
  class rectangle;

  class box : public i_shape_3d ,
              public i_stackable
  {

  public:

    static const std::string & box_label();

    enum faces_mask_type {
      FACE_NONE   = face_identifier::FACE_BITS_NONE,
      _FACE_BEGIN = 0x1,
      FACE_BACK   = 0x1,
      FACE_FRONT  = 0x2,
      FACE_LEFT   = 0x4,
      FACE_RIGHT  = 0x8,
      FACE_BOTTOM = 0x10,
      FACE_TOP    = 0x20,
      _FACE_END   = 0x40,
      FACE_ALL    = (FACE_BACK
                     | FACE_FRONT
                     | FACE_LEFT
                     | FACE_RIGHT
                     | FACE_BOTTOM
                     | FACE_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);

    void set_half(double, double, double);

    box();

    box(double a_x, double a_y, double a_z);

    virtual ~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 * = 0);

    virtual void reset();

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

    virtual double get_surface(uint32_t a_mask = FACE_ALL) const;

    virtual double get_volume(uint32_t flags_ = 0) const;

    virtual unsigned int compute_faces(face_info_collection_type & faces_) const;

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

    virtual bool is_outside(const vector_3d &,
                            double a_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 box & );

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

    virtual bool find_intercept(const vector_3d & a_from,
                                const vector_3d & a_direction,
                                face_intercept_info & a_intercept,
                                double a_skin = GEOMTOOLS_PROPER_TOLERANCE) const;

    virtual void tree_dump(std::ostream & a_out         = std::clog,
                           const std::string & a_title  = "",
                           const std::string & a_indent = "",
                           bool a_inherit          = false) const;

    enum box_wires_rendering_option_type {
      WR_BOX_NO_BACK_FACE   = (WR_BASE_LAST << 1), 
      WR_BOX_NO_FRONT_FACE  = (WR_BASE_LAST << 2), 
      WR_BOX_NO_LEFT_FACE   = (WR_BASE_LAST << 3), 
      WR_BOX_NO_RIGHT_FACE  = (WR_BASE_LAST << 4), 
      WR_BOX_NO_BOTTOM_FACE = (WR_BASE_LAST << 5), 
      WR_BOX_NO_TOP_FACE    = (WR_BASE_LAST << 6), 
      WR_BOX_LAST           = (WR_BOX_NO_TOP_FACE),    
      WR_BOX_MASK           = (WR_BOX_NO_BACK_FACE
                               | WR_BOX_NO_FRONT_FACE
                               | WR_BOX_NO_LEFT_FACE
                               | WR_BOX_NO_RIGHT_FACE
                               | WR_BOX_NO_BOTTOM_FACE
                               | WR_BOX_NO_TOP_FACE)   
    };

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

    void compute_vertexes(std::vector<vector_3d> & vv_) const;

    void compute_transformed_vertexes(const placement & p_, std::vector<vector_3d> & vv_) const;

    void compute_face(faces_mask_type face_id_,
                      rectangle & face_,
                      placement & face_placement_) const;

    static void init_ocd(datatools::object_configuration_description &);

  protected:

    void _set_defaults();

    virtual void _build_bounding_data();

  private:

    double _x_; 
    double _y_; 
    double _z_; 

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(box)

  };

} // end of namespace geomtools

// @param geomtools::box the name of the class with registered OCD support
DOCD_CLASS_DECLARATION(geomtools::box)

#endif // GEOMTOOLS_BOX_H

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