SO3WidgetManager.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OpenSpace3D
For the latest info, see http://www.openspace3d.com
 
Copyright (c) 2012 I-maginer
 
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 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 Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt
 
-----------------------------------------------------------------------------
*/
 
#ifndef _SO3_WIDGET_MANAGER_H_
#define _SO3_WIDGET_MANAGER_H_
 
#include <Ogre.h>
#include "SCOLBasic/SO3Prerequisites.h"
#include "SO3WidgetFactory.h"
#include "SO3WidgetListener.h"
 
namespace SO3
{
  class INPUTInfo
  {
  public:
    int index;
    int x;
    int y;
    SWidget* widget;
  protected:
  private:
  public:
    INPUTInfo()
    {
      x = 0;
      y = 0;
      index = 0;
      widget = nullptr;
    }
 
    INPUTInfo(int cindex, int cx, int cy, SWidget* wg)
    {
      index = cindex;
      x = cx;
      y = cy;
      widget = wg;
    }
 
    INPUTInfo(const INPUTInfo& input)
    {
      index = input.index;
      x = input.x;
      y = input.y;
      widget = input.widget;
    }
 
    ~INPUTInfo()
    {
    }
  protected:
  private:
  };
 
class _SO3_Export SWidgetManager : public Ogre::Singleton<SWidgetManager>
{
public:
  typedef std::map<std::string, SWidget*> WidgetList;
protected:
private:
  typedef std::map<std::string, SWidgetFactory*> WidgetFactoryList;
  typedef std::map<int, INPUTInfo> WidgetInputList;
  typedef std::multimap<unsigned short, SWidget*> WidgetListByZOrder;
  typedef std::set<SWidgetListener*> WidgetListenerList;
  WidgetFactoryList widgetFactoryList;
  WidgetList widgetList;                  
  WidgetList overlayedWidgetList;         
  WidgetListByZOrder widgetListByZOrder;  
  WidgetListenerList widgetListenerList;
  SWidget* focusedWidget;
  WidgetInputList inputList;
 
public:
  SWidgetManager();
 
  ~SWidgetManager();
 
  WidgetList GetWidgetList();
 
  void AddWidgetFactory(SWidgetFactory* newWidgetFactory);
  
  void RemoveWidgetFactory(SWidgetFactory* existingWidgetFactory);
 
  void RemoveWidgetFactory(const std::string& existingWidgetFactoryName);
 
  SWidget* CreateWidget(SScene* targetScene, const std::string& widgetName, const int& xPos, const int& yPos, const unsigned short& width, const unsigned short& height, SViewPort* targetViewport, const unsigned int& widgetZOrder, const std::string& widgetType);
 
  SWidget* CreateWidget(SScene* targetScene, const std::string& widgetName, const int& xPos, const int& yPos, const unsigned short& width, const unsigned short& height, SViewPort* targetViewport, const std::string& widgetType);
 
  SWidget* CreateWidget(SScene* targetScene, const std::string& widgetName, const unsigned short& width, const unsigned short& height, SMaterial* targetMaterial, const unsigned short& targetTechnique, const unsigned short& targetPass, const unsigned short& targetTextureUnit, const std::string& widgetType);
 
  void DeleteWidget(SWidget* existingWidget);
 
  void AddWidgetListener(SWidgetListener* newWidgetListener);
 
  void RemoveWidgetListener(SWidgetListener* existingWidgetListener);
 
        static SWidgetManager& getSingleton();
 
        /*
        @copydoc Ogre::Singleton::getSingletonPtr
        */
        static SWidgetManager* getSingletonPtr();
 
        void InjectMouseMove(SWindow* originWindow, const int& xPos, const int& yPos, const MouseButtonId& button);
 
        void InjectMouseWheel(SWindow* originWindow, const int& scrollX, const int& scrollY, const int& relativeScroll);
 
        void InjectMouseDown(SWindow* originWindow, const int& xPos, const int& yPos, const MouseButtonId& button);
 
  void InjectTouchAdd(SWindow* originWindow, const int& xPos, const int& yPos, const int& touchid);
 
  void InjectTouchRemove(SWindow* originWindow, const int& touchid);
 
  void InjectTouchUpdate(SWindow* originWindow, const int& xPos, const int& yPos, const int& vx, const int& vy, const int& touchid);
 
        void InjectMouseUp(SWindow* originWindow, const int& xPos, const int& yPos, const MouseButtonId& button);
 
  void InjectMouseMove(SWidget* widget, const SRaycastResult& raycast, const MouseButtonId& button, const int& id = 0);
 
  void InjectMouseDown(SWidget* widget, const SRaycastResult& raycast, const MouseButtonId& button, const int& id = 0);
  
  void InjectMouseUp(const SRaycastResult& raycast, const MouseButtonId& button, const int& id = 0);
 
  void InjectMouseWheel(SWidget* widget, const SRaycastResult& raycast, const int& relativeScroll, const int& id = 0);
 
  void InjectTouchAdd(SWidget* widget, const SRaycastResult& raycast, const int& touchid);
 
  void InjectTouchRemove(SWidget* widget, const SRaycastResult& raycast, const int& touchid);
 
  void InjectTouchUpdate(SWidget* widget, const SRaycastResult& raycast, const int& touchid);
 
  void InjectKeyEvent(const UINT& msg, const ScolWindowHandle& hwnd, const WPARAM& wParam, const LPARAM& lParam);
 
  void InjectTextEvent(const std::string& text);
 
  void UpdateWidgetsZOrder();
 
  void UpdateFocusedWidget(SWidget* focusTargetedWidget);
 
  SWidget* GetFocusedWidget();
 
  void _FireScriptWidgetEvent(SWidget* targetedWidget, const SScriptFunction& functionCalled);
 
  void _FireOnLoadStart(SWidget* targetedWidget);
 
  void _FireOnLoadEnd(SWidget* targetedWidget);
 
  void _FireOnLoadError(SWidget* targetedWidget, const int& errorCode, const std::string& failedUrl);
protected:
private:
  SWidget* GetWidgetUnder(SWindow* originWindow, const int& posX, const int& posY, const int& id = 0);
 
  void _FireEnterWidgetEvent(SWidget* targetedWidget, const int& id = 0);
 
  void _FireInsideWidgetEvent(SWidget* targetedWidget, const int& id = 0);
  
  void _FireExitWidgetEvent(SWidget* targetedWidget, const int& id = 0);
 
  void _FireMouseMoveWidgetEvent(SWidget* targetedWidget, const int& mousePosX, const int& mousePosY, const MouseButtonId& mouseButton, const int& id = 0);
 
  void _FireMouseDownWidgetEvent(SWidget* targetedWidget, const int& mousePosX, const int& mousePosY, const MouseButtonId& mouseButton, const int& id = 0);
 
  void _FireMouseUpWidgetEvent(SWidget* targetedWidget, const int& mousePosX, const int& mousePosY, const MouseButtonId& mouseButton, const int& id = 0);
 
  void _FireMouseWheelWidgetEvent(SWidget* targetedWidget, const int& mousePosX, const int& mousePosY, const int& relativeScroll, const int& id = 0);
 
  void _FireTouchAddWidgetEvent(SWidget* targetedWidget, const int& mousePosX, const int& mousePosY, const int& touchid);
 
  void _FireTouchRemoveWidgetEvent(SWidget* targetedWidget, const int& mousePosX, const int& mousePosY, const int& touchid);
 
  void _FireTouchUpdateWidgetEvent(SWidget* targetedWidget, const int& mousePosX, const int& mousePosY, const int& vx, const int& vy, const int& touchid);
 
  void _FireKeyWidgetEvent(SWidget* targetedWidget, const UINT& msg, const ScolWindowHandle& hwnd, const UINT& wParam, const LONG& lParam);
 
  void _FireFocusWidgetEvent(SWidget* targetedWidget, const bool& focused);
 
  SPointInt ConvertTextureUvToWidgetCoordinates(SWidget* targetedWidget, const float& uCoordinates, const float& vCoordinates);
};
 
}
 
#endif