ellipsoid_sector.h

Go to the documentation of this file.

/* Author(s):     F.Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2015-03-01
 * Last modified: 2015-03-01
 *
 * License:
 *
 * Description:
 *   3D ellipsoid description
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_ELLIPSOID_SECTOR_H
#define GEOMTOOLS_ELLIPSOID_SECTOR_H 1

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

// Third party
// - Bayeux/datatools:
#include <datatools/bit_mask.h>

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

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

namespace geomtools {

  class ellipsoid_sector : public i_shape_2d
  {
  public:

    static const std::string & ellipsoid_sector_label();

    virtual std::string get_shape_name() 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_);

    const angular_range & get_angle_domain() const;

    bool has_partial_angle() const;

    bool has_start_angle() const;

    void set_start_angle(double);

    double get_start_angle() const;

    bool has_delta_angle() const;

    void set_delta_angle(double);

    double get_delta_angle() const;

    ellipsoid_sector();

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

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

    ellipsoid_sector(double rx_, double ry_, double rz_,
                     double zm_, double zp_,
                     double start_angle_, double delta_angle_);

    virtual ~ellipsoid_sector();

    bool is_valid() const;

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

    void reset();

    virtual double get_surface(uint32_t mask_ = ALL_PIECES) const;

    virtual bool is_on_surface(const vector_3d & ,
                               double skin_ = 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 skin_ = 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 ellsec_wires_rendering_option_type {
      WR_ELLSEC_NO_BOTTOM_EDGE      = (WR_BASE_LAST << 1),        
      WR_ELLSEC_NO_TOP_EDGE         = (WR_BASE_LAST << 2),        
      WR_ELLSEC_NO_START_ANGLE_EDGE = (WR_BASE_LAST << 3),        
      WR_ELLSEC_NO_STOP_ANGLE_EDGE  = (WR_BASE_LAST << 4),        
      WR_ELLSEC_LAST                = (WR_ELLSEC_NO_STOP_ANGLE_EDGE), 
      WR_ELLIPSOID_MASK             = (WR_ELLSEC_NO_BOTTOM_EDGE
                                      | WR_ELLSEC_NO_START_ANGLE_EDGE
                                      | WR_ELLSEC_NO_STOP_ANGLE_EDGE
                                      )  
    };

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

  protected:

    void _set_defaults();

  private:

    double _x_radius_;     
    double _y_radius_;     
    double _z_radius_;     
    angular_range _angle_domain_; 
    double _bottom_z_cut_; 
    double _top_z_cut_;    

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(ellipsoid_sector)

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_ELLIPSOID_SECTOR_H

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