i_shape_2d.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2008-05-23
 * Last modified: 2015-02-24
 *
 * License:
 *
 * Description:
 *
 *  Interface for 2D shaped surfaces
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_I_SHAPE_2D_H
#define GEOMTOOLS_I_SHAPE_2D_H 1

// Standard library:
#include <string>

// Third party:
// - Bayeux/datatools:
#include <datatools/bit_mask.h>
#include <datatools/handle.h>
#include <datatools/ocd_macros.h>

// This project:
#include <geomtools/utils.h>
#include <geomtools/i_object_3d.h>
#include <geomtools/i_find_intercept.h>
#include <geomtools/i_wires_3d_rendering.h>

namespace geomtools {

  class i_shape_2d : public i_object_3d,
                     public i_find_intercept,
                     public i_wires_3d_rendering
  {
  public:

    enum faces_mask_type {
      FACE_NONE   = face_identifier::FACE_BITS_NONE, 
      FACE_UNIQUE = datatools::bit_mask::bit00, 
      FACE_UP     = FACE_UNIQUE,                
      FACE_DOWN   = datatools::bit_mask::bit01, 
      FACE_ALL    = FACE_UNIQUE
    };

    static const uint32_t ALL_PIECES = 0xFFFFFFFF;

    virtual bool has_number_of_sides() const;

    virtual unsigned int get_number_of_sides() const;

    virtual bool has_perimeter(uint32_t flags_ = ALL_PIECES) const;

    virtual double get_perimeter(uint32_t flags_ = ALL_PIECES) const;

    virtual bool has_surface(uint32_t flags_ = ALL_PIECES) const;

    virtual double get_surface(uint32_t flags_ = ALL_PIECES) const;

    int get_dimensional() const;

    i_shape_2d();

    i_shape_2d(double tolerance_);

    i_shape_2d(double tolerance_, double angular_tolerance_);

    virtual ~i_shape_2d();

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

    virtual vector_3d get_normal_on_surface(const vector_3d & position_,
                                            bool check_ = false,
                                            double skin_ = GEOMTOOLS_PROPER_TOLERANCE) const = 0;

    static void init_ocd(datatools::object_configuration_description & ocd_);

    // Serialization interface
    DATATOOLS_SERIALIZATION_DECLARATION()

  };

  typedef datatools::handle<i_shape_2d> shape_2d_handle_type;
  typedef shape_2d_handle_type          face_handle_type;

} // end of namespace geomtools

/*
// Class version:
#include <boost/serialization/version.hpp>
BOOST_CLASS_VERSION(geomtools::i_shape_2d, 0)
*/

#endif // GEOMTOOLS_I_SHAPE_2D_H

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