ellipse.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 elliptic arc in x-y plane
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_ELLIPSE_H
#define GEOMTOOLS_ELLIPSE_H 1

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

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

namespace geomtools {

  class ellipse : public i_shape_1d,
                  public i_wires_3d_rendering
  {

  public:

    static const std::string & ellipse_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;

    double get_circumference() const;

    virtual unsigned int get_number_of_path() const;

    virtual double get_length(uint32_t flags_ = PATH_ALL_BITS) const;

    bool is_x_oriented() const;

    bool is_y_oriented() const;

    bool is_circle() const;

    double get_excentricity() const;

    double get_focal_to_center() const;

    ellipse();

    ellipse(double x_radius_, double y_radius_);

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

    void compute_x_y_from_theta(double theta_, double & x_, double & y_) const;

    void compute_theta_from_x(double x_, double & theta_) const;

    static void squared_distance_to_point_with_derivative(double t_,
                                                          void * params_,
                                                          double * f_,
                                                          double * df_);

    static double squared_distance_to_point(double t_,
                                            void * params_);


    double compute_squared_distance_to_point(double t_, double xm_, double ym_) const;

    // /// Compute the orthogonal projection of a point on the elliptical arc
    // bool compute_orthogonal_projection(const vector_3d & a_position,
    //                                    vector_3d & a_projection,
    //                                    double a_tolerance) const;

    virtual ~ellipse();

    virtual std::string get_shape_name() const;

    virtual void tree_dump(std::ostream & a_out = std::clog,
                           const std::string & a_title = "",
                           const std::string & a_indent = "",
                           bool a_inherit= false) const;

    virtual bool is_on_curve(const vector_3d &,
                             double a_tolerance = GEOMTOOLS_PROPER_TOLERANCE) const;

    virtual vector_3d get_direction_on_curve(const vector_3d & a_tposition) const;

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

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

    virtual void reset();

  protected:

    void _set_defaults();

  private:

    double        _x_radius_;     
    double        _y_radius_;     
    angular_range _angle_domain_; 

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(ellipse)

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_ELLIPSE_H

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