wall_solid.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2015-07-16
 * Last modified: 2015-07-16
 *
 * License: GPL3
 *
 * Description:
 *
 *  A 3D solid representing a vertical wall with arbitrary height
 *  and composed of several segments of arbitrary thickness
 *
 */

#ifndef GEOMTOOLS_WALL_SOLID_H
#define GEOMTOOLS_WALL_SOLID_H 1

// Standard library:
#include <sstream>
#include <stdexcept>

// Third party:
// - Bayeux/datatools:
#include <datatools/object_configuration_description.h>

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

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

namespace geomtools {

  class tessellated_solid;

  class wall_solid : public i_shape_3d,
                     public i_stackable
  {

  public:

    static const std::string & wall_solid_label();

    enum faces_mask_type {
      FACE_NONE   = face_identifier::FACE_BITS_NONE,
      FACE_SIDE   = 0x1,
      FACE_BOTTOM = 0x2,
      FACE_TOP    = 0x4,
      FACE_ALL    = (FACE_SIDE
                     | FACE_BOTTOM
                     | FACE_TOP)
    };

    virtual double get_xmin() const;

    virtual double get_xmax() const;

    virtual double get_ymin() const;

    virtual double get_ymax() const;

    virtual double get_zmin() const;

    virtual double get_zmax() const;

    double get_z() const;

    void set_z(double);

    const simple_polygon & get_base() const;

    simple_polygon & grab_base();

    wall_solid();

    virtual ~wall_solid();

    virtual std::string get_shape_name() const;

    bool is_valid() const;

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

    virtual void reset();

    void compute_bottom_face(composite_surface & face_,
                             placement & face_placement_) const;

    void compute_top_face(composite_surface & face_,
                          placement & face_placement_) const;

    void compute_side_face(composite_surface & face_) const;

    virtual unsigned int compute_faces(face_info_collection_type &) const;

    virtual double get_volume(uint32_t flags_ = 0) const;

    virtual double get_surface(uint32_t mask_ = FACE_ALL) 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 & position_,
                                             const face_identifier & ) const;

    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;

    enum wall_wires_rendering_option_type {
      WR_WALL_NO_BOTTOM_FACE      = (WR_BASE_LAST << 1),           
      WR_WALL_NO_TOP_FACE         = (WR_BASE_LAST << 2),           
      WR_WALL_NO_SIDE_FACE        = (WR_BASE_LAST << 3),           
      WR_WALL_LAST                = (WR_WALL_NO_SIDE_FACE),  
      WR_WALL_MASK                = (WR_WALL_NO_BOTTOM_FACE
                                     | WR_WALL_NO_TOP_FACE
                                     | WR_WALL_NO_SIDE_FACE
                                     ) 
    };

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

    void convert_to_tessellated(tessellated_solid &) const;

  protected:

    virtual void _build_bounding_data();

    void _set_defaults();

  private:

    double         _z_;    
    simple_polygon _base_; 

    // Working data (not used yet):
    // bool    _computed_; //!< Flag indicating that internal working data have been computed
    // boost::logic::tribool _has_top_face_;
    // boost::logic::tribool _has_bottom_face_;
    // boost::logic::tribool _has_inner_face_;
    // double  _top_surface_;
    // double  _bottom_surface_;
    // double  _side_surface_;
    // double  _volume_;

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(wall_solid)

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_WALL_SOLID_H

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