sphere.h

Go to the documentation of this file.

/* Author(s):     F.Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2006-11-28
 * Last modified: 2014-04-08
 *
 * License:
 *
 * Description:
 *   3D sphere description
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_SPHERE_H
#define GEOMTOOLS_SPHERE_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>
#include <geomtools/angular_range.h>

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

namespace geomtools {

  // Class forward declarations:
  class disk;
  class spherical_sector;
  class right_circular_conical_nappe;

  class sphere : 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_OUTER_SIDE       = FACE_SIDE,
      FACE_INNER_SIDE       = datatools::bit_mask::bit01,
      FACE_START_THETA_SIDE = datatools::bit_mask::bit02,
      FACE_STOP_THETA_SIDE  = datatools::bit_mask::bit03,
      FACE_START_PHI_SIDE   = datatools::bit_mask::bit04,
      FACE_STOP_PHI_SIDE    = datatools::bit_mask::bit05,
      FACE_ALL              = FACE_OUTER_SIDE
      | FACE_INNER_SIDE
      | FACE_START_THETA_SIDE
      | FACE_STOP_THETA_SIDE
      | FACE_START_PHI_SIDE
      | FACE_STOP_PHI_SIDE
    };

    static const std::string & sphere_label();

    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_r() const;

    double get_r_max() const;

    double get_radius() const;

    bool has_r_min() const;

    double get_r_min() const;

    void set_r(double);

    void set_r_max(double);

    void set_radius(double);

    void set_r_min(double);

    void reset_r_max();

    void reset_r_min();

    void set(double rmax_);

    void set(double rmin_, double rmax_);


    const angular_range & get_theta_domain() const;

    bool has_partial_theta() const;

    bool has_start_theta() const;

    void set_start_theta(double);

    double get_start_theta() const;

    bool has_delta_theta() const;

    void set_delta_theta(double);

    double get_delta_theta() const;

    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 set_theta(double start_theta_, double delta_theta_);

    bool is_orb() const;

    sphere();

    sphere(double radius_);

    sphere(double radius_min_, double radius_max_);

    virtual ~sphere();

    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;

    void compute_side_face(faces_mask_type, spherical_sector &) const;

    void compute_inner_side_face(spherical_sector &) const;

    void compute_outer_side_face(spherical_sector &) const;

    void compute_start_stop_theta_face(faces_mask_type, right_circular_conical_nappe &, disk &, placement &) const;

    void compute_start_theta_face(right_circular_conical_nappe &, disk &, placement &) const;

    void compute_stop_theta_face(right_circular_conical_nappe &, disk &, placement &) const;

    void compute_start_stop_phi_face(faces_mask_type, disk &, placement &) const;

    void compute_start_phi_face(disk &, placement &) const;

    void compute_stop_phi_face(disk &, placement &) const;

    virtual unsigned int compute_faces(face_info_collection_type & faces_) const;


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

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

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

    enum sphere_wires_rendering_option_type {
      WR_SPHERE_NO_INNER_FACE       = (WR_BASE_LAST << 1),          
      WR_SPHERE_NO_OUTER_FACE       = (WR_BASE_LAST << 2),          
      WR_SPHERE_NO_START_THETA_FACE = (WR_BASE_LAST << 3),          
      WR_SPHERE_NO_STOP_THETA_FACE  = (WR_BASE_LAST << 4),          
      WR_SPHERE_NO_START_PHI_FACE   = (WR_BASE_LAST << 5),          
      WR_SPHERE_NO_STOP_PHI_FACE    = (WR_BASE_LAST << 6),          
      WR_SPHERE_LAST                = (WR_SPHERE_NO_STOP_PHI_FACE), 
      WR_SPHERE_MASK                = (WR_SPHERE_NO_INNER_FACE
                                       | WR_SPHERE_NO_OUTER_FACE
                                       | WR_SPHERE_NO_START_THETA_FACE
                                       | WR_SPHERE_NO_STOP_THETA_FACE
                                       | WR_SPHERE_NO_START_PHI_FACE
                                       | WR_SPHERE_NO_STOP_PHI_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 _r_;           
    double _r_min_;       
    angular_range _theta_domain_; 
    angular_range _phi_domain_;   

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(sphere)

  };

} // end of namespace geomtools

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

#endif // GEOMTOOLS_SPHERE_H

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