right_circular_conical_nappe.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2015-03-15
 * Last modified: 2015-03-15
 *
 * License:
 *
 * Description:
 *
 *   Right circular conical n-appe
 *
 */

#ifndef GEOMTOOLS_RIGHT_CIRCULAR_CONICAL_NAPPE_H
#define GEOMTOOLS_RIGHT_CIRCULAR_CONICAL_NAPPE_H 1

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

namespace geomtools {

  // Class forward declarations:
  class disk;
  class quadrangle;

  class right_circular_conical_nappe : public i_shape_2d
  {
  public:

    static const std::string & right_circular_conical_nappe_label();

    virtual std::string get_shape_name() const;

    bool is_valid() const;

    void set_z(double);

    double get_z() const;

    void set_bottom_radius(double);

    double get_bottom_radius() const;

    void set_top_radius(double);

    double get_top_radius() const;

    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_radius_from_z(double z_) const;

    double get_cone_angle() const;

    virtual double get_surface(uint32_t flags_ = ALL_PIECES) const;

    right_circular_conical_nappe();

    right_circular_conical_nappe(double bottom_radius_,
                                 double top_radius_,
                                 double z_);

    right_circular_conical_nappe(double bottom_radius_,
                                 double top_radius_,
                                 double z_,
                                 double start_angle_,
                                 double delta_angle_);

    virtual ~right_circular_conical_nappe();

    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 rccn_wires_rendering_option_type {
      WR_RCCN_NO_BOTTOM_EDGE      = (WR_BASE_LAST << 1),           
      WR_RCCN_NO_TOP_EDGE         = (WR_BASE_LAST << 2),           
      WR_RCCN_NO_START_ANGLE_EDGE = (WR_BASE_LAST << 3),           
      WR_RCCN_NO_STOP_ANGLE_EDGE  = (WR_BASE_LAST << 4),           
      WR_RCCN_LAST                = (WR_RCCN_NO_STOP_ANGLE_EDGE),  
      WR_RCCN_MASK                = (WR_RCCN_NO_BOTTOM_EDGE
                                     | WR_RCCN_NO_TOP_EDGE
                                     | WR_RCCN_NO_START_ANGLE_EDGE
                                     | WR_RCCN_NO_STOP_ANGLE_EDGE) 
    };

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

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

    void reset();

  protected:

    void _set_defaults();

  private:

    double _bottom_radius_; 
    double _top_radius_;    
    double _z_;             
    angular_range _angle_domain_; 

    // Registration interface :
    GEOMTOOLS_OBJECT_3D_REGISTRATION_INTERFACE(right_circular_conical_nappe)

  };

  typedef right_circular_conical_nappe conical_nappe;

} // end of namespace geomtools

#endif // GEOMTOOLS_RIGHT_CIRCULAR_CONICAL_NAPPE_H

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