i_shape_1d.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2008-05-23
 * Last modified: 2012-04-10
 *
 * License:
 *
 * Description:
 *  Interface for 1D shaped volumes (lines)
 *
 * History:
 *
 */

#ifndef GEOMTOOLS_I_SHAPE_1D_H
#define GEOMTOOLS_I_SHAPE_1D_H 1

// Standard library:
#include <string>

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

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

namespace geomtools {

  class i_shape_1d : public i_object_3d
  {
  public:

    int get_dimensional() const;

    virtual bool has_number_of_paths() const;

    virtual unsigned int get_number_of_paths() const;

    virtual bool has_length(uint32_t flags_ = PATH_ALL_BITS) const;

    virtual double get_length(uint32_t flags_ = PATH_ALL_BITS) const;

    i_shape_1d();

    i_shape_1d(double tolerance_);

    i_shape_1d(double tolerance_, double angular_tolerance_);

    virtual ~i_shape_1d();

    virtual bool is_on_curve(const vector_3d &,
                             double tolerance_ = GEOMTOOLS_PROPER_TOLERANCE) const = 0;

    virtual vector_3d get_direction_on_curve(const vector_3d & position_) const = 0;

    static void init_ocd(datatools::object_configuration_description &);

    // Serialization interface
    DATATOOLS_SERIALIZATION_DECLARATION()

  };

} // end of namespace geomtools

/*
// Explicit class version:
#include <boost/serialization/version.hpp>
BOOST_CLASS_VERSION(geomtools::i_shape_1d, 0)
*/

#endif // GEOMTOOLS_I_SHAPE_1D_H

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