elliptical_sector.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2010-02-14
 * Last modified: 2015-02-15
 *
 * License:
 *
 * Description:
 *
 *   A elliptical_sector in x-y plane
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_ELLIPTICAL_SECTOR_H
#define GEOMTOOLS_ELLIPTICAL_SECTOR_H 1

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

namespace geomtools {

  // Forward class declaration:
  class ellipse;

  class elliptical_sector : public i_shape_2d
  {

  public:

    static const std::string & elliptical_sector_label();

    bool is_valid() const;

    double get_x_radius() const;

    double get_y_radius() const;

    void set_radii(double x_radius_, double y_radius_);

    void set_x_radius(double x_radius_);

    void set_y_radius(double y_radius_);

    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;

    virtual double get_surface(uint32_t flags_ = ALL_PIECES) const;

    virtual double get_perimeter(uint32_t flags_ = ALL_PIECES) const;

    double get_circumference() const;

    void compute_edge(ellipse & edge_) const;

    // Set the parameters
    void set(double x_radius_, double y_radius_);

    // Set the parameters
    void set(double x_radius_, double y_radius_, double start_angle_, double delta_angle_);

    elliptical_sector();

    elliptical_sector(double x_radius_, double y_radius_);

    elliptical_sector(double x_radius_, double y_radius_,
                      double start_angle_, double delta_angle_);

    virtual ~elliptical_sector();

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

    void reset();

    virtual std::string get_shape_name() const;

    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 elliptical_sector_wires_rendering_option_type {
      WR_ELLIPTICAL_SECTOR_NO_EXT_EDGE         = (WR_BASE_LAST << 1),           
      WR_ELLIPTICAL_SECTOR_NO_START_ANGLE_EDGE = (WR_BASE_LAST << 2),           
      WR_ELLIPTICAL_SECTOR_NO_STOP_ANGLE_EDGE  = (WR_BASE_LAST << 3),           
      WR_ELLIPTICAL_SECTOR_LAST                = (WR_ELLIPTICAL_SECTOR_NO_STOP_ANGLE_EDGE),  
      WR_ELLIPTICAL_SECTOR_MASK                = (WR_ELLIPTICAL_SECTOR_NO_EXT_EDGE
                                                  | WR_ELLIPTICAL_SECTOR_NO_START_ANGLE_EDGE
                                                  | WR_ELLIPTICAL_SECTOR_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_;    
    angular_range _angle_domain_; 

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(elliptical_sector)

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_ELLIPTICAL_SECTOR_H

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