elliptical_cylinder.h

Go to the documentation of this file.

/* Author(s):     A. Chapon <chapon@lpccaen.in2p3.fr>
 *                F. Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2014-11-17
 * Last modified: 2015-03-11
 *
 * License:
 *
 * Description:
 *   3D elliptical cylinder description
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_ELLIPTICAL_CYLINDER_H
#define GEOMTOOLS_ELLIPTICAL_CYLINDER_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>

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

namespace geomtools {

  // Forward class declarations:
  class elliptical_sector;
  class elliptical_cylinder_sector;

  class elliptical_cylinder : public i_shape_3d,
                              public i_stackable
  {
  public:

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

    static const std::string & elliptical_cylinder_label();

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

    void compute_side_face(elliptical_cylinder_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);

    double get_half_z() const;

    void set_half_z (double);

    double get_x_radius () const;

    void set_x_radius (double);

    double get_y_radius () const;

    void set_y_radius (double);

    void set (double xr_, double yr_, double z_);

    elliptical_cylinder();

    elliptical_cylinder (double xr_, double yr_, double z_);

    virtual ~elliptical_cylinder ();

    virtual std::string get_shape_name () const;

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

    bool is_valid () const;

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

    virtual void reset();

    virtual double get_surface (uint32_t mask_ = FACE_ALL) const;

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

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

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

    enum elliptical_cylinder_wires_rendering_option_type {
      WR_ELLCYL_NO_BOTTOM_FACE = (WR_BASE_LAST << 1),    
      WR_ELLCYL_NO_TOP_FACE    = (WR_BASE_LAST << 2),    
      WR_ELLCYL_NO_SIDE_FACE   = (WR_BASE_LAST << 3),    
      WR_ELLCYL_LAST           = (WR_ELLCYL_NO_SIDE_FACE),  
      WR_ELLCYL_MASK           = (WR_ELLCYL_NO_BOTTOM_FACE
                                  | WR_ELLCYL_NO_TOP_FACE
                                  | WR_ELLCYL_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_default();

    virtual void _build_bounding_data();

  private:

    double _x_radius_; 
    double _y_radius_; 
    double _z_;        

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(elliptical_cylinder)

  };

  // Type alias:
  typedef elliptical_cylinder elliptical_tube;

} // end of namespace geomtools

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

#endif // GEOMTOOLS_ELLIPTICAL_CYLINDER_H

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