Plane.hpp

Go to the documentation of this file.

// This file is part of GranOO, a workbench for DEM simulation.
//
// Author(s)    : - Damien Andre       IRCER/UNILIM, Limoges France
//                  <damien.andre@unilim.fr>
//                - Jean-luc Charles   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jean-luc.charles@ensam.eu>
//                - Jeremie Girardot   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jeremie.girardot@ensam.eu>
//                - Cedric Hubert      LAMIH/UPHF, Valenciennes France
//                  <cedric.hubert@uphf.fr>
//                - Ivan Iordanoff     Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <ivan.iordanoff@ensam.eu>
//
// Copyright (C) 2008-2019 D. Andre, JL. Charles, J. Girardot, C. Hubert, I. Iordanoff
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
#ifndef _GranOO_LibShape_Plane_hh_
#define _GranOO_LibShape_Plane_hh_
 
#include <iostream>
#include <string>
 
#include <vtkUnstructuredGrid.h>
 
#include "GranOO3/Shape/Surface.hpp"
 
#include "GranOO3/Geom/Point.hpp"
#include "GranOO3/Geom/Quaternion.hpp"
 
#include "GranOO3/Core/String.hpp"
#include "GranOO3/Core/ObjectFactory.hpp"
 
namespace GranOO3
{
  namespace Shape
  {
 
    class Plane : public Surface,
          public Core::ObjectFactoryInterface< Base, Plane>
    {
 
      GRANOO_OBJECT_FACTORY(Plane);
 
    public:
      static std::string class_ID() {return std::string("Plane");}
      static std::string desc();
 
    public:
      Plane();
      Plane(const Geom::Frame& frame);
      Plane(const Plane &);
      ~Plane();
 
      //USEFULL
      void read_xml_element(const TiXmlElement* el);
      std::string description() const;
      std::string get_str_type_key() const {return Plane::class_ID();}
      double area() const {return std::numeric_limits<double>::max();}
 
      void draw_gl() const;
      void scale(double); // It has no effect on a plane
 
      //CONTACT DETECTION v2
      bool collide(const Volume&, Collision::Data&) const;
      bool collide(const Geom::Point&, Collision::Data&) const;
 
      virtual void to_vtk(vtkUnstructuredGrid* data);
      std::ostream& to_povray (std::ostream& out, const Core::Color& ) const;
 
    private:
      friend class boost::serialization::access;
      template<class Archive> void serialize(Archive & ar, const unsigned int );
    };
 
 
    inline
    Plane::Plane(const Geom::Frame& frame)
      : Surface(frame) {
    }
 
    inline
    Plane::Plane()
      : Surface(Geom::Frame::global) {
    }
 
    inline
    Plane::Plane(const Plane& p)
      : Surface(p.local_frame()) {
    }
 
    inline
    Plane::~Plane() {
    }
 
    template<class Archive>
    inline void
    Plane::serialize(Archive & ar, const unsigned int ) {
      ar & boost::serialization::base_object<Surface>(*this);
    }
 
  }
}
 
//Don't forget to export for dynamic serialization of child class
#include <boost/serialization/export.hpp>
BOOST_CLASS_EXPORT_KEY(GranOO3::Shape::Plane)
 
 
#include <boost/serialization/version.hpp>
BOOST_CLASS_VERSION(GranOO3::Shape::Plane,0)
GRANOO_SERIALIZE_SHAPE(Plane)
 
 
namespace GranOO3
{
  extern template class Core::ObjectFactoryInterface<Shape::Base, Shape::Plane>;
}
 
 
#endif