spherical_sector.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2015-02-23
 * Last modified: 2015-02-23
 *
 * License:
 *
 * Description:
 *
 *   Spherical sector
 *
 */

#ifndef GEOMTOOLS_SPHERICAL_SECTOR_H
#define GEOMTOOLS_SPHERICAL_SECTOR_H 1

// This project:
#include <geomtools/i_shape_2d.h>
#include <geomtools/angular_range.h>

namespace geomtools {

  class spherical_sector : public i_shape_2d
  {
  public:

    static const std::string & spherical_sector_label();

    virtual std::string get_shape_name() const;

    bool is_valid() const;

    void set_radius(double new_value_);

    double get_radius() const;

    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;

    virtual double get_surface(uint32_t flags_ = ALL_PIECES) const;

    spherical_sector();

    spherical_sector(double radius_);

    spherical_sector(double radius_,
                     double start_theta_,
                     double delta_theta_,
                     double start_phi_,
                     double delta_phi_);

    virtual ~spherical_sector();

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

    void reset();

    virtual bool is_on_surface(const vector_3d &,
                               double tolerance_ = GEOMTOOLS_PROPER_TOLERANCE) const;

    virtual vector_3d get_normal_on_surface(const vector_3d & position_,
                                            bool check_ = true,
                                            double skin_ = GEOMTOOLS_PROPER_TOLERANCE) const;

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

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

    enum sphesec_wires_rendering_option_type {
      WR_SPHSEC_NO_START_THETA_EDGE = (WR_BASE_LAST << 1),            
      WR_SPHSEC_NO_STOP_THETA_EDGE  = (WR_BASE_LAST << 2),            
      WR_SPHSEC_NO_START_PHI_EDGE   = (WR_BASE_LAST << 3),            
      WR_SPHSEC_NO_STOP_PHI_EDGE    = (WR_BASE_LAST << 4),            
      WR_SPHSEC_Z_SAMPLING          = (WR_BASE_LAST << 5),            
      WR_SPHSEC_LAST                = (WR_SPHSEC_Z_SAMPLING),         
      WR_SPHSEC_MASK                = (WR_SPHSEC_NO_START_THETA_EDGE
                                       | WR_SPHSEC_NO_STOP_THETA_EDGE
                                       | WR_SPHSEC_NO_START_PHI_EDGE
                                       | WR_SPHSEC_NO_STOP_PHI_EDGE
                                       | WR_SPHSEC_Z_SAMPLING)        
    };

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

  protected:

    void _set_defaults();

  private:

    double        _radius_;       
    angular_range _theta_domain_; 
    angular_range _phi_domain_;   

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(spherical_sector)

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_SPHERICAL_SECTOR_H

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