i_wires_3d_rendering.h

Go to the documentation of this file.

/* Author(s) :    Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2012-10-22
 * Last modified: 2015-02-15
 *
 * License:
 *
 * Description:
 *
 *   A abstract interface for wires 3D rendering
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_I_WIRES_3D_RENDERING_H
#define GEOMTOOLS_I_WIRES_3D_RENDERING_H 1

// Standard library:
#include <list>

// Third party:
// - Boost:
#include <boost/cstdint.hpp>
// - Bayeux/datatools:
#include <datatools/logger.h>
#include <datatools/bit_mask.h>

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

namespace geomtools {

  // Forward declaration:
  class i_shape_3d;

  class i_wires_3d_rendering
  {
  public:

    enum wires_rendering_option_type {
      WR_NONE                          = 0,
      WR_BASE_GRID                     = datatools::bit_mask::bit00, 
      WR_BASE_GRID_LOW_DENSITY         = (WR_BASE_GRID << 1),  
      WR_BASE_GRID_HIGH_DENSITY        = (WR_BASE_GRID << 2),  
      WR_BASE_GRID_VERY_HIGH_DENSITY   = (WR_BASE_GRID << 3),  
      WR_BASE_GRID_HUGE_DENSITY        = (WR_BASE_GRID << 4),  
      WR_BASE_LOW_ANGLE_SAMPLING       = (WR_BASE_GRID << 5),  
      WR_BASE_HIGH_ANGLE_SAMPLING      = (WR_BASE_GRID << 6),  
      WR_BASE_VERY_HIGH_ANGLE_SAMPLING = (WR_BASE_GRID << 7),  
      WR_BASE_HUGE_ANGLE_SAMPLING      = (WR_BASE_GRID << 8),  
      WR_BASE_UNUSED_09                = (WR_BASE_GRID << 9),  
      WR_BASE_UNUSED_10                = (WR_BASE_GRID << 10), 
      WR_BASE_UNUSED_11                = (WR_BASE_GRID << 11), 
      WR_BASE_UNUSED_12                = (WR_BASE_GRID << 12), 
      WR_BASE_UNUSED_13                = (WR_BASE_GRID << 13), 
      WR_BASE_BOUNDINGS                = (WR_BASE_GRID << 14), 
      WR_BASE_EXPLODE                  = (WR_BASE_GRID << 15), 
      WR_BASE_LAST                     = (WR_BASE_EXPLODE),    
      WR_BASE_MASK                     = datatools::bit_mask::nbits16 
    };

    enum sampling_level_type {
      SL_NONE      = 0, 
      SL_LOW       = 1, 
      SL_NORMAL    = 2, 
      SL_HIGH      = 3, 
      SL_VERY_HIGH = 4, 
      SL_HUGE      = 5  
    };

    static uint32_t linear_sampling(sampling_level_type);

    static uint32_t linear_sampling_from_options(uint32_t);

    static uint32_t angular_sampling(sampling_level_type);

    static uint32_t angular_sampling_from_options(uint32_t);

    static void boost_linear_sampling(uint32_t &);

    virtual ~i_wires_3d_rendering();

    void generate_wires(wires_type & wires_,
                        const placement & positioning_,
                        uint32_t options_ = 0) const;

    void generate_wires(wires_type & wires_,
                        const geomtools::vector_3d & position_,
                        const geomtools::rotation_3d & rotation_,
                        uint32_t options_ = 0) const;

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

  };

  void transform_wire_to(const placement & p_,
                         const polyline_type & wire_,
                         polyline_type & tr_wire_);

  void transform_wires_to(const placement & p_,
                          const wires_type & wires_,
                          wires_type & tr_wires_);

  bool parse_wires(std::istream & in_, wires_type & wires_);

  void save_wires(std::ostream & out_, const wires_type & wires_, uint32_t flags_ = 0);

  struct classified_segment
  {
    classified_segment();

    void reset();

    void to_line(segment_type & segment_) const;

    void to_wire(polyline_type & wire_) const;

    bool is_inside() const;

    bool is_outside() const;

    bool is_on_surface() const;

    vector_3d first; 
    vector_3d last;  
    shape_domain_flags_type domain; 

  };

  void classify_in_out_segment(const segment_type & segment_,
                               const i_shape_3d & shape_,
                               const placement & shape_placement_,
                               double step_,
                               double tolerance_,
                               std::list<classified_segment> & classified_);

  class split_segment_wrt_shape
  {
  public:

    split_segment_wrt_shape();

    void reset();

    void clear();

    void configure(const i_shape_3d & shape_,
                   double step_,
                   double tolerance_);

    void configure(const i_shape_3d & shape_,
                   const placement & shape_placement_,
                   double step_,
                   double tolerance_);

    bool is_configured() const;

    void add(const segment_type & segment_);

    void add(const polyline_type & path_);

    void add(const wires_type & paths_);

    unsigned int fetch_inside_segments(std::list<segment_type> & segments_);

    unsigned int fetch_inside_wires(wires_type & wires_);

    unsigned int fetch_outside_segments(std::list<segment_type> & segments_);

    unsigned int fetch_outside_wires(wires_type & wires_);

    unsigned int fetch_surface_segments(std::list<segment_type> & segments_);

    unsigned int fetch_surface_wires(wires_type & wires_);

    unsigned int fetch_all_segments(std::list<segment_type> & segments_);

    unsigned int fetch_all_wires(wires_type & wires_);

  private:

    // Setup:
    const i_shape_3d * _shape_;           
    placement          _shape_placement_; 
    double             _step_;            
    double             _tolerance_;       

    // Work:
    std::list<classified_segment> _clsegs_; 

  };

} // end of namespace geomtools

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