quadric.h

Go to the documentation of this file.

//
// Copyright (c) 2015 by François Mauger <mauger@lpccaen.in2p3.fr>
//
// This file is part of geomtools.
//
// geomtools is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// geomtools is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with geomtools. If not, see <http://www.gnu.org/licenses/>.

#ifndef GEOMTOOLS_QUADRIC_H
#define GEOMTOOLS_QUADRIC_H

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

namespace geomtools {

  class quadric : public i_shape_2d
  {
  public:

    static const std::string & quadric_label();

    virtual std::string get_shape_name() const;

    bool is_valid() const;

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

    void reset();

    quadric();

    enum coef_index {
      A = 9,
      B = 8,
      C = 7,
      D = 6,
      E = 5,
      F = 4,
      G = 3,
      H = 2,
      I = 1,
      J = 0,
      NCOEFFS = 10
    };

    static std::string coeff_label(coef_index i_);

    void set_coefficient(coef_index, double);

    double get_coefficient(coef_index) const;

    virtual double eval_f(double x_, double y_, double z_) const;

    virtual double eval_dfdx(double x_, double y_, double z_) const;

    virtual double eval_dfdy(double x_, double y_, double z_) const;

    virtual double eval_dfdz(double x_, double y_, double z_) const;

    void eval_gradient(double x_, double y_, double z_,
                       double & dfdx_, double & dfdy_, double & dfdz_) const;

    void eval_gradient(const geomtools::vector_3d & position_,
                       geomtools::vector_3d & gradient_) const;

    double eval_f(const geomtools::vector_3d & position_) const;

    double distance(const geomtools::vector_3d & position_) const;

    geomtools::vector_3d orthogonal_projection(const geomtools::vector_3d & position_,
                                               double skin_ = GEOMTOOLS_PROPER_TOLERANCE) const;

    geomtools::vector_3d projection(const geomtools::vector_3d & position_,
                                    const geomtools::vector_3d & direction_,
                                    double skin_ = GEOMTOOLS_PROPER_TOLERANCE) const;

    virtual bool is_on_surface(const geomtools::vector_3d & position_,
                               double skin_ = GEOMTOOLS_PROPER_TOLERANCE) const;

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

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

    static void make_plane(quadric & q_, double a_, double b_, double c_, double d_);

    static void make_plane_yz(quadric & q_, double a_);

    static void make_plane_xz(quadric & q_, double b_);

    static void make_plane_xy(quadric & q_, double c_);

    static void make_parallel_planes_yz(quadric & q_, double a_);

    static void make_parallel_planes_xz(quadric & q_, double b_);

    static void make_parallel_planes_xy(quadric & q_, double c_);

    static void make_ellipsoid(quadric & q_, double a_, double b_, double c_);

    static void make_spheroid_along_z(quadric & q_, double a_, double b_);

    static void make_sphere(quadric & q_, double a_);

    static void make_elliptic_paraboloid_along_z(quadric & q_, double a_, double b_);

    static void make_circular_paraboloid_along_z(quadric & q_, double a_);

    static void make_hyperbolic_paraboloid_along_z(quadric & q_, double a_, double b_);

    static void make_elliptic_hyperbolic_one_sheet_along_z(quadric & q_, double a_, double b_, double c_);

    static void make_elliptic_hyperbolic_two_sheets_along_z(quadric & q_, double a_, double b_, double c_);

    static void make_elliptic_cone_along_z(quadric & q_, double a_, double b_, double c_);

    static void make_circular_cone_along_z(quadric & q_, double a_, double b_);

    static void make_elliptic_cylinder_along_z(quadric & q_, double a_, double b_);

    static void make_circular_cylinder_along_z(quadric & q_, double a_);

    static void make_hyperbolic_cylinder_along_z(quadric & q_, double a_, double b_);

    static void make_parabolic_cylinder_along_z(quadric & q_, double a_);

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

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

  protected:

    void _set_defaults();

  private:

    double _coefficients_[NCOEFFS]; 

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(quadric)

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_QUADRIC_H

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