Base.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_Base_hh_
#define _GranOO_LibShape_Base_hh_
 
#include <iostream>
#include <string>
#include <math.h>
 
#include <vtkUnstructuredGrid.h>
 
#include "GranOO3/Core/Macro.hpp"
#include "GranOO3/Core/String.hpp"
#include "GranOO3/Core/Color.hpp"
#include "GranOO3/Core/XmlParser.hpp"
#include "GranOO3/Core/XmlObjectManager.hpp"
 
#include "GranOO3/Geom/Tensor.hpp"
#include "GranOO3/Geom/Point.hpp"
#include "GranOO3/Geom/Quaternion.hpp"
#include "GranOO3/Geom/Frame.hpp"
 
#ifndef SERVER
  #if defined OSX
    #include <OpenGL/gl.h>
  #else
    #include <GL/gl.h>
  #endif
#endif
 
 
#define GRANOO_SERIALIZE_SHAPE(CLASS)                               \
  namespace boost {namespace serialization {                        \
    template<class Archive>                                         \
    inline void save_construct_data(Archive & ar,                   \
                                    const GranOO3::Shape::CLASS * t, \
                                    const unsigned int) {           \
      InternAssert(0);                                              \
      const GranOO3::Geom::Point*      p = &t->get_center();         \
      const GranOO3::Geom::Quaternion* q = &t->get_quaternion();     \
      ar << p; ar << q;}                                            \
    template<class Archive>                                         \
    inline void load_construct_data(Archive & ar,                   \
                                    GranOO3::Shape::CLASS * t,       \
                                    const unsigned int) {                                    \
      InternAssert(0);                                                                       \
      GranOO3::Geom::Point*      p = nullptr;                                                 \
      GranOO3::Geom::Quaternion* q = nullptr;                                                 \
      ar >> p; ar >> q;                                                                      \
      GranOO3::Geom::Frame* f = new GranOO3::Geom::Frame(*p, *q, GranOO3::Geom::global::frame); \
      ::new(t)GranOO3::Shape::CLASS(*f);}}}
 
 
namespace GranOO3
{
  namespace Shape
  {
 
    class Sphere;
    class Box;
    class Prolate;
    class Base;
    std::ostream& operator<< (std::ostream& os, const Base&);
    std::istream& operator>> (std::istream& is,  Base&);
 
    //
    // Base class for all shapes !
    //
    class Base
    {
    public:
      static Base& glob(const std::string& id);
      static const Geom::Frame& frame_buffer();
      static std::string class_ID() {
        return std::string("ShapeBase");
      }
 
      static Base* new_object(const TiXmlElement* el);
 
    private:
      static const Geom::Frame* _frame_buffer;
 
    public:
      //CONSTRUCTORS & DESTRUCTORS
      explicit Base(const Geom::Frame &frame) : _frame(frame) {}
      virtual ~Base() {}
 
      //USEFULL
      virtual void draw_gl() const = 0;
      virtual void draw_gl_edge() const;
      virtual void scale(double) = 0;
      void unscale(double);
      virtual bool is_surface() const = 0;
      virtual bool is_volume()  const = 0;
      virtual void add_glob(const std::string&) = 0;
 
      //IO
      virtual void read_xml_element(const TiXmlElement* el);
      virtual std::ostream& write_ascii (std::ostream& out) const;
      virtual std::istream& read_ascii  (std::istream& in);
      virtual void to_vtk(vtkUnstructuredGrid* data);
      virtual std::string info() const;
      virtual std::ostream& to_povray (std::ostream& out, const Core::Color&) const;
 
      //ACCESSORS
      const Geom::Frame& local_frame() const {return _frame;}
      const Geom::Point& get_center() const {return _frame.get_center();}
      const Geom::Quaternion& get_quaternion() const { return _frame.get_quaternion();}
      const Geom::Vector& get_position() const {return _frame.get_position();}
 
      //MOVE
      void translate(Geom::Vector &);
      void rotate(const Geom::Vector & axis, const double angleRadian);
 
    protected:
      const Geom::Frame& _frame;
 
    private:
      Base(const Base &);                // Copy constructor forbiden
      Base & operator=(const Base &); // Assignement operator forbiden
 
      //SERIALIZATION
      friend class boost::serialization::access;
      template<class Archive> void serialize(Archive & ar, const unsigned int version) {
      }
 
    };
 
    inline std::ostream&
    operator<< (std::ostream& os, const Base& b) {
      return b.write_ascii(os);
    }
 
    inline std::istream&
    operator>> (std::istream& os,  Base& b) {
      return b.read_ascii(os);
    }
 
     inline void
    Base::draw_gl_edge() const {
       // do nothing
    }
 
    inline void
    Base::translate(Geom::Vector & t) {
      Geom::Point & pt = const_cast<Geom::Point &>(_frame.get_center());
      pt.translate(t);
    }
 
    inline void
    Base::rotate(const Geom::Vector & axis, const double angleRad) {
      Geom::Quaternion & q = const_cast<Geom::Quaternion & >(_frame.get_quaternion());
      q.set_axis_angle(axis, angleRad);
    }
 
    inline std::string
    Base::info() const {
      std::ostringstream str;
      str << "Frame center     : " <<  local_frame().get_center() << '\n';
      str << "Frame quaternion : " <<  local_frame().get_quaternion() << '\n';
      return str.str();
    }
 
  }
}
 
 
#include "GranOO3/Core/ObjectFactory.hpp"
 
namespace GranOO3
{
  namespace Core
  {
 
    template<class ChildClass>
    struct ObjectFactoryConstructorWrapper<Shape::Base, ChildClass>
    {
      static ChildClass* build() {
        return new ChildClass(Shape::Base::frame_buffer());
      }
 
    };
 
    extern template class ObjectFactoryRegistered<Shape::Base>;
    extern template class ObjectFactory<Shape::Base>;
 
  }
}
 
 
 
 
 
 
 
#endif