ellipsoid.h

Go to the documentation of this file.

/* Author(s):     A. Chapon <chapon@lpccaen.in2p3.fr>
 * Creation date: 2014-11-18
 * Last modified: 2014-11-18
 *
 * License:
 *
 * Description:
 *   3D ellipsoid description
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_ELLIPSOID_H
#define GEOMTOOLS_ELLIPSOID_H 1

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

// Third party
// - Bayeux/datatools:
#include <datatools/bit_mask.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 ellipsoid_sector;

  class ellipsoid : 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_TOP    = datatools::bit_mask::bit01,
      FACE_BOTTOM = datatools::bit_mask::bit02,
      FACE_ALL    = FACE_SIDE | FACE_TOP | FACE_BOTTOM
    };

    static const std::string & ellipsoid_label();

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

    void compute_side_face(ellipsoid_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_x_radius() const;

    void set_x_radius(double);

    double get_y_radius() const;

    void set_y_radius(double);

    double get_z_radius() const;

    void set_z_radius(double);

    double get_bottom_z_cut() const;

    void set_bottom_z_cut(double);

    double get_top_z_cut() const;

    void set_top_z_cut(double);

    void set(double rx_, double ry_, double rz_);

    void set(double rx_, double ry_, double rz_,
             double zm_, double zp_);

    ellipsoid();

    ellipsoid(double rx_, double ry_, double rz_);

    ellipsoid(double rx_, double ry_, double rz_,
              double zm_, double zp_);

    virtual ~ellipsoid();

    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 * = 0);

    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 ellipsoid &);

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

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

    static void init_ocd(datatools::object_configuration_description &);

    enum ellipsoid_wires_rendering_option_type {
      WR_ELLIPSOID_NO_SIDE_FACE    = (WR_BASE_LAST << 1),        
      WR_ELLIPSOID_NO_BOTTOM_FACE  = (WR_BASE_LAST << 2),        
      WR_ELLIPSOID_NO_TOP_FACE     = (WR_BASE_LAST << 3),        
      WR_ELLIPSOID_LAST            = (WR_ELLIPSOID_NO_TOP_FACE), 
      WR_ELLIPSOID_MASK            = (WR_ELLIPSOID_NO_SIDE_FACE
                                      | WR_ELLIPSOID_NO_BOTTOM_FACE
                                      | WR_ELLIPSOID_NO_TOP_FACE
                                      )  
    };

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

  protected:

    void _set_default();

    virtual void _build_bounding_data();

  private:

    double _x_radius_;     
    double _y_radius_;     
    double _z_radius_;     
    double _bottom_z_cut_; 
    double _top_z_cut_;    

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(ellipsoid)

  };

} // end of namespace geomtools

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

#endif // GEOMTOOLS_ELLIPSOID_H

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