tube.h

Go to the documentation of this file.

/* Author(s):     F.Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2006-11-28
 * Last modified: 2015-02-22
 *
 * License:
 *
 * Description:
 *   3D tube description
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_TUBE_H
#define GEOMTOOLS_TUBE_H 1

// Standard library:
#include <iostream>
#include <string>

// 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/angular_range.h>

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

namespace geomtools {

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

  class tube : 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_START_ANGLE = datatools::bit_mask::bit04,
      FACE_STOP_ANGLE = datatools::bit_mask::bit05,
      FACE_ALL        = (FACE_OUTER_SIDE
                         | FACE_BOTTOM
                         | FACE_TOP
                         | FACE_INNER_SIDE
                         | FACE_START_ANGLE
                         | FACE_STOP_ANGLE)
    };

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

    static const std::string & tube_label();

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

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

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

    bool has_inner_face() 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);

    double get_half_z() const;

    void set_half_z(double);

    bool has_inner_r() const;

    double get_inner_r() const;

    void set_inner_r(double);

    void set_radii(double inner_r_, double outer_r_);

    double get_outer_r() const;

    void set_outer_r(double);

    void set(double outer_r_, double z_);

    void set(double inner_r_, double outer_r_, double z_);

    void set_half(double inner_r_, double outer_r_, double half_z_);

    void set(double inner_r_, double outer_r_, double z_, double start_phi_, double delta_phi_);

    const angular_range & get_phi_domain() const;

    bool has_partial_phi() const;

    bool has_start_phi() const;

    void set_start_phi(double);

    double get_start_phi() const;

    bool has_delta_phi() const;

    void set_delta_phi(double);

    double get_delta_phi() const;

    void set_phi(double start_phi_, double delta_phi_);

    void compute_inner_cylinder(cylinder & ic_);

    void compute_outer_cylinder(cylinder & oc_);

    tube();

    tube(double outer_radius_, double z_);

    tube(double inner_radius_, double outer_radius_, double z_);

    tube(double inner_radius_, double outer_radius_, double z_, double start_phi_, double delta_phi_);

    virtual ~tube();

    virtual std::string get_shape_name() const;

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

    bool is_extruded() const;

    bool is_valid() const;

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

    virtual void reset();

    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 & a_position,
                                            const face_identifier & a_surface_bit) const;

    virtual bool find_intercept(const vector_3d & from_,
                                const vector_3d & direction_,
                                face_intercept_info & intercept_,
                                double skin_ = GEOMTOOLS_PROPER_TOLERANCE) const;

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

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

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

    enum tube_wires_rendering_option_type {
      WR_TUBE_NO_BOTTOM_FACE      = (WR_BASE_LAST << 1),           
      WR_TUBE_NO_TOP_FACE         = (WR_BASE_LAST << 2),           
      WR_TUBE_NO_INNER_FACE       = (WR_BASE_LAST << 3),           
      WR_TUBE_NO_OUTER_FACE       = (WR_BASE_LAST << 4),           
      WR_TUBE_NO_START_ANGLE_FACE = (WR_BASE_LAST << 5),           
      WR_TUBE_NO_STOP_ANGLE_FACE  = (WR_BASE_LAST << 6),           
      WR_TUBE_LAST                = (WR_TUBE_NO_STOP_ANGLE_FACE),  
      WR_TUBE_MASK                = (WR_TUBE_NO_BOTTOM_FACE
                                     | WR_TUBE_NO_TOP_FACE
                                     | WR_TUBE_NO_INNER_FACE
                                     | WR_TUBE_NO_OUTER_FACE
                                     | WR_TUBE_NO_START_ANGLE_FACE
                                     | WR_TUBE_NO_STOP_ANGLE_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_;       
    double _inner_r_; 
    double _outer_r_; 
    angular_range _phi_domain_; 

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(tube)

  };

} // end of namespace geomtools

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

#endif // GEOMTOOLS_TUBE_H

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