right_polygonal_frustrum.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2015-03-15
 * Last modified: 2015-03-21
 *
 * License:
 *
 * Description:
 *
 *   Right polygonal frustrum
 *
 */

#ifndef GEOMTOOLS_RIGHT_POLYGONAL_FRUSTRUM_H
#define GEOMTOOLS_RIGHT_POLYGONAL_FRUSTRUM_H 1

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

namespace geomtools {

  // Class forward declarations:
  class composite_surface;

  class right_polygonal_frustrum : public i_shape_3d,
                                   public i_stackable
  {
  public:

    enum faces_mask_type {
      FACE_NONE       = face_identifier::FACE_BITS_NONE,
      FACE_OUTER_SIDE = datatools::bit_mask::bit00,
      FACE_BOTTOM     = datatools::bit_mask::bit01,
      FACE_TOP        = datatools::bit_mask::bit02,
      FACE_INNER_SIDE = datatools::bit_mask::bit03,
      FACE_ALL        = (FACE_OUTER_SIDE
                         | FACE_BOTTOM
                         | FACE_TOP
                         | FACE_INNER_SIDE)
    };

    enum volumes_mask_type {
      VOLUME_NONE   = 0,
      VOLUME_BULK   = datatools::bit_mask::bit00,
      VOLUME_CAVITY = datatools::bit_mask::bit01
    };

    static const unsigned int MIN_NUMBER_OF_SIDES = 3;

    static const std::string & rpf_label();

    virtual std::string get_shape_name() const;

    bool is_valid() const;

    double get_xmin() const;

    double get_xmax() const;

    double get_ymin() const;

    double get_ymax() const;

    double get_zmin() const;

    double get_zmax() const;

    uint32_t get_n_sides() const;

    void set_n_sides(uint32_t);

    uint32_t get_sector_start() const;

    uint32_t get_sector_stop() const;

    double get_sector_angle() const;

    double get_start_angle(unsigned int sector_) const;

    void set_z(double);

    double get_z() const;

    bool has_top_face() const;

    bool has_bottom_face() const;

    bool has_inner_face() const;

    bool has_inner_bottom_radius() const;

    void set_inner_bottom_radius(double);

    double get_inner_bottom_radius() const;

    void set_outer_bottom_radius(double);

    double get_outer_bottom_radius() const;

    bool has_inner_top_radius() const;

    void set_inner_top_radius(double);

    double get_inner_top_radius() const;

    void set_outer_top_radius(double);

    double get_outer_top_radius() const;

    right_polygonal_frustrum();

    right_polygonal_frustrum(unsigned int n_sides_,
                             double inner_bottom_radius_,
                             double outer_bottom_radius_,
                             double inner_top_radius_,
                             double outer_top_radius_,
                             double z_);

    virtual ~right_polygonal_frustrum();

    virtual void tree_dump (std::ostream & out_         = std::clog,
                            const std::string & title_  = "",
                            const std::string & indent_ = "",
                            bool inherit_          = false) const;

    void compute_inner_face(composite_surface & face_) const;

    void compute_outer_face(composite_surface & face_) const;

    void compute_top_face(composite_surface & top_face_, placement &) const;

    void compute_bottom_face(composite_surface & bottom_face_, placement &) const;

    virtual unsigned int compute_faces(face_info_collection_type &) const;

    double compute_outer_radius(double z_) const;

    double compute_inner_radius(double z_) const;

    virtual double get_surface(uint32_t mask_ = FACE_ALL) const;

    virtual double get_volume(uint32_t flags_ = VOLUME_BULK) 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 initialize(const datatools::properties &, const handle_dict_type * = 0);

    virtual void reset();

    enum rpf_wires_rendering_option_type {
      WR_RPF_NO_BOTTOM_FACE      = (WR_BASE_LAST << 1),           
      WR_RPF_NO_TOP_FACE         = (WR_BASE_LAST << 2),           
      WR_RPF_NO_INNER_FACE       = (WR_BASE_LAST << 3),           
      WR_RPF_NO_OUTER_FACE       = (WR_BASE_LAST << 4),           
      WR_RPF_LAST                = (WR_RPF_NO_OUTER_FACE),  
      WR_RPF_MASK                = (WR_RPF_NO_BOTTOM_FACE
                                     | WR_RPF_NO_TOP_FACE
                                     | WR_RPF_NO_INNER_FACE
                                     | WR_RPF_NO_OUTER_FACE) 
    };

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

  protected:

    void _set_defaults();

    virtual void _build_bounding_data();

  private:

    uint32_t _n_sides_;             
    uint32_t _sector_start_;        
    uint32_t _sector_stop_;         
    double   _inner_bottom_radius_; 
    double   _outer_bottom_radius_; 
    double   _inner_top_radius_;    
    double   _outer_top_radius_;    
    double   _z_;                   

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(right_polygonal_frustrum)

  };

  typedef right_polygonal_frustrum polygonal_frustrum;

} // end of namespace geomtools

#endif // GEOMTOOLS_RIGHT_POLYGONAL_FRUSTRUM_H

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