SO3Engine/SO3Renderer/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) 2010 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

You may alternatively use this source under the terms of a specific version of
the OpenSpace3D Unrestricted License provided you have obtained such a license from
I-maginer.
-----------------------------------------------------------------------------
*/

#ifndef _SO3_WIDGET_MANAGER_H_
#define _SO3_WIDGET_MANAGER_H_

#include "../SCOLBasic/SO3Prerequisites.h"
#include "SO3WidgetFactory.h"
#include "SO3WidgetListener.h"
#include <Ogre.h>

namespace SO3
{

class _SO3_Export SWidgetManager : public Ogre::Singleton<SWidgetManager>
{
public:
protected:
private:
  typedef std::map<std::string, SWidgetFactory*> WidgetFactoryList;
  typedef std::map<std::string, SWidget*> WidgetList;
  typedef std::multimap<unsigned short, SWidget*> WidgetListByZOrder;
  typedef std::set<SWidgetListener*> WidgetListenerList;
  WidgetFactoryList widgetFactoryList;
  WidgetList widgetList;                  
  WidgetList overlayedWidgetList;         
  WidgetListByZOrder widgetListByZOrder;  
  WidgetListenerList widgetListenerList;
  SWidget* focusedWidget;

public:
  SWidgetManager();

  ~SWidgetManager();

  void AddWidgetFactory(SWidgetFactory* newWidgetFactory);
  
  void RemoveWidgetFactory(SWidgetFactory* existingWidgetFactory);

  void RemoveWidgetFactory(std::string existingWidgetFactoryName);

  SWidget* CreateWidget(SScene* targetScene, std::string widgetName, int xPos, int yPos, unsigned short width, unsigned short height, SViewPort* targetViewport, unsigned int widgetZOrder, std::string widgetType);

  SWidget* CreateWidget(SScene* targetScene, std::string widgetName, int xPos, int yPos, unsigned short width, unsigned short height, SViewPort* targetViewport, std::string widgetType);

  SWidget* CreateWidget(SScene* targetScene, std::string widgetName, unsigned short width, unsigned short height, SMaterial* targetMaterial, unsigned short targetTechnique, unsigned short targetPass, unsigned short targetTextureUnit, 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, int xPos, int yPos, MouseButtonId button);

        void InjectMouseWheel(SWindow* originWindow, int scrollX, int scrollY, int relativeScroll);

        void InjectMouseDown(SWindow* originWindow, int xPos, int yPos, MouseButtonId button);

        void InjectMouseUp(SWindow* originWindow, int xPos, int yPos, MouseButtonId button);

  void InjectKeyEvent(UINT msg, WindowHandle hwnd, WPARAM wParam, LPARAM lParam);

  void InjectTextEvent(std::string text);

  void UpdateWidgetsZOrder();

  void UpdateFocusedWidget(SWidget* focusTargetedWidget);

  SWidget* GetFocusedWidget();

  void _FireScriptWidgetEvent(SWidget* targetedWidget, SWidget::WidgetScriptFunction functionCalled);
protected:
private:
  SWidget* GetWidgetUnder(SWindow* originWindow, int posX, int posY);

  void _FireEnterWidgetEvent(SWidget* targetedWidget);

  void _FireInsideWidgetEvent(SWidget* targetedWidget);
  
  void _FireExitWidgetEvent(SWidget* targetedWidget);

  void _FireMouseDownWidgetEvent(SWidget* targetedWidget, int mousePosX, int mousePosY, MouseButtonId mouseButton);

  void _FireMouseUpWidgetEvent(SWidget* targetedWidget, int mousePosX, int mousePosY, MouseButtonId mouseButton);

  void _FireMouseWheelWidgetEvent(SWidget* targetedWidget, int relativeScroll);
};

}

#endif

---