cylinder.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2008-05-24
 * Last modified: 2015-02-15
 *
 * License:
 *
 * Description:
 *
 *  A cylinder on z-axis
 *
 */

#ifndef GEOMTOOLS_CYLINDER_H
#define GEOMTOOLS_CYLINDER_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>

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

namespace geomtools {

  // Class forward declarations:
  class disk;
  class cylindrical_sector;

  class cylinder : public i_shape_3d ,
                   public i_stackable
  {

  public:

    static const std::string & cylinder_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)
    };

    void compute_top_bottom_face(faces_mask_type face_id_,
                                 disk & face_,
                                 placement & face_placement_) const;

    void compute_side_face(cylindrical_sector & face_,
                           placement & face_placement_) const;

    virtual unsigned int compute_faces(face_info_collection_type & faces_) 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;

    double get_z () const;

    void set_z (double);

    void set_diameter (double);

    double get_half_z () const;

    void set_half_z (double);

    double get_r () const;

    double get_radius () const;

    double get_diameter () const;

    void set_r (double);

    void set (double r_, double z_);

    void set_alternative (double, double);

    cylinder ();

    cylinder (double a_radius, double a_z);

    virtual ~cylinder ();

    virtual std::string get_shape_name () const;

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

    bool is_valid () const;

    void init ();

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

    virtual void reset ();

    virtual double get_surface (uint32_t a_mask = FACE_ALL) const;

    virtual double get_volume (uint32_t flags_ = 0) 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;

    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;

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

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

    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 cylinder_wires_rendering_option_type {
      WR_CYL_NO_BOTTOM_FACE = (WR_BASE_LAST << 1),    
      WR_CYL_NO_TOP_FACE    = (WR_BASE_LAST << 2),    
      WR_CYL_NO_SIDE_FACE   = (WR_BASE_LAST << 3),    
      WR_CYL_LAST           = (WR_CYL_NO_SIDE_FACE),  
      WR_CYL_MASK           = (WR_CYL_NO_BOTTOM_FACE
                               | WR_CYL_NO_TOP_FACE
                               | WR_CYL_NO_SIDE_FACE) 
    };

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

    static void init_ocd(datatools::object_configuration_description &);

  protected:

    void _set_defaults();

    virtual void _build_bounding_data();

  private:

    double _z_;      //<! Height
    double _radius_; //<! Radius

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(cylinder)

  };

} // end of namespace geomtools

// @arg geomtools::cylinder the name the class
DOCD_CLASS_DECLARATION(geomtools::cylinder)

#endif // GEOMTOOLS_CYLINDER_H

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