toroid_nappe.h

Go to the documentation of this file.

/* Author(s) : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2016-02-18
 * Last modified: 2016-02-18
 *
 * License:
 *
 * Description:
 *
 *   Toroid nappe
 *
 */

#ifndef GEOMTOOLS_TOROID_NAPPE_H
#define GEOMTOOLS_TOROID_NAPPE_H 1

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

namespace geomtools {

  class toroid_nappe : public i_shape_2d
  {
  public:

    static const std::string & toroid_nappe_label();

    virtual std::string get_shape_name() const;

    bool is_valid() const;

    void set_sweep_radius(double new_value_);

    double get_sweep_radius() const;

    void set_radius(double new_value_);

    double get_radius() 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;

    toroid_nappe();

    toroid_nappe(double sweep_radius_, double radius_);

    toroid_nappe(double sweep_radius_,
                 double radius_,
                 double start_phi_,
                 double delta_phi_);

    virtual ~toroid_nappe();

    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 toroid_nappe_wires_rendering_option_type {
      WR_TOROID_NAPPE_NO_START_PHI_EDGE = (WR_BASE_LAST << 1),                 
      WR_TOROID_NAPPE_NO_STOP_PHI_EDGE  = (WR_BASE_LAST << 2),                 
      WR_TOROID_NAPPE_LAST              = (WR_TOROID_NAPPE_NO_STOP_PHI_EDGE),  
      WR_TOROID_NAPPE_MASK              = (WR_TOROID_NAPPE_NO_START_PHI_EDGE
                                           | WR_TOROID_NAPPE_NO_STOP_PHI_EDGE) 
    };

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

  protected:

    void _set_defaults();

    void _at_init();

  private:

    double _sweep_radius_; 
    double _radius_;       
    angular_range _phi_domain_; 

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(toroid_nappe)

  };

} // end of namespace geomtools

#endif // GEOMTOOLS_TOROID_NAPPE_H

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