/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLQt/src/ICLQt/DrawWidget3D.h                         **
** Module : ICLQt                                                  **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/SmartPtr.h>
#include <ICLQt/DrawWidget.h>
#include <vector>

namespace icl{
  namespace qt{
  
    /// Extended ICLDrawWidget, able to draw 2D and 3D primitives using OpenGL
    /** Even though, it is possible to use the ICLDrawWidget3D for rendering
        3D stuff on top of an image directly, it is strongly recommended to use
        an instance of ICLGeom::Scene to manage camera, scene objects and lights.
        A scene instance provides a single ICLDrawWidget3D::GLCallback* that can easily
        be linked to the DrawWidget3D by using the ICLDrawWidget3D::link method.
        
        Most older methods got the deprecated status. They will be removed soon, since
        it turned out, that using ICLGeom's Scene class is much easier and less error-prone.
    */
    class ICLQt_API ICLDrawWidget3D : public ICLDrawWidget {
      public:
      
      /// internally used callback class type
      class GLCallback{
        public:
        /// empty destructor (doing nothing)
        virtual ~GLCallback(){}
  
        /// 2nd draw functions that can access the parent draw-widget
        virtual void draw(ICLDrawWidget3D *widget){}
  
        /// custom code to link the visualization to the widget
        virtual void link(ICLDrawWidget3D *widget){ (void)widget; }

        /// custom code to un-link the visualization from the widget
        virtual void unlink(ICLDrawWidget3D *widget){ (void)widget; }
      };
      
      /// creates a new ICLDrawWidget embedded into the parent component
      ICLDrawWidget3D(QWidget *parent);
  
      /// overwrites the parent's method
      virtual void customPaintEvent(PaintEngine *e);
  
      /// add a single 3D callback, that is rendered (here, no queue swapping is neccessary)
      /** the linked callback can be removed by calling link(0). The ownership of the linked 
          callback is never passed. */
      void link(GLCallback *cb);
      
      protected:
      /// special single callback linked to the 3D visualisation
      GLCallback *m_linkedCallback;
      
      /// internal mutex
      utils::Mutex m_linkMutex;
    };
  } // namespace qt
}