SO3Engine/SO3Renderer/SO3Widget.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_H_
#define _SO3_WIDGET_H_

#include "../SCOLBasic/SO3Prerequisites.h"
#include "../SCOLBasic/SO3DataScol.h"
#include "../SO3Material/SO3Material.h"
#include "../SO3Renderer/SO3ViewPort.h"
#include "../SO3Utils/SO3Point.h"
#include "OgrePanelOverlayElement.h"

namespace SO3
{

class _SO3_Export SWidget : public SData,
                            public Ogre::ManualResourceLoader
{
public:
  friend SWidgetManager;
  struct WidgetScriptFunction
  {
    std::string function;
    std::vector<std::string> arguments;
  };
protected:
  std::string baseResourceName;
  int leftPos;
  int topPos;
  unsigned short width;
  unsigned short height;
  unsigned short textureWidth;                  
  unsigned short textureHeight;                 
  SScene* scene;
  SViewPort* viewport;
  Ogre::TexturePtr renderingTexture;
  bool forceRenderingUpdate;
  float transparentTresholdColor;
private:
  const bool isOverlayed;
  const bool is2DRect;
  std::string type;
  bool compensateNPOT;                          
  std::string originalTextureName;              
  Ogre::TextureUnitState* originalTextureUnit;  
  Ogre::Pass* originalMaterialPass;
  Ogre::SceneBlendFactor originalSceneBlendFactorSource;
  Ogre::SceneBlendFactor originalSceneBlendFactorDest;
  Ogre::LayerBlendModeEx originalTextureUnitBlendMode;
  Ogre::FilterOptions originalTextureUnitMinFiltering;
  Ogre::FilterOptions originalTextureUnitMagFiltering;
  Ogre::FilterOptions originalTextureUnitMipFiltering;
  bool originalMaterialDepthWrite;
  bool originalMaterialDepthCheck;
  Ogre::Overlay* ogreOverlay;                   
  Ogre::PanelOverlayElement* ogreOverlayPanel;  
  Ogre::Rectangle2D* ogre2dRect;                
  Ogre::SceneNode* ogre2dNode;                  
  Ogre::MaterialPtr ogreOverlayMaterial;        
  SMaterial* originalMaterial;                  
  unsigned int zOrder;                          
  bool topOnFocus;
  bool isPriorized;
  bool mouseIsOver;                             
  Ogre::TextureUnitState* renderingTextureUnit;
  float opacity;
  bool isTransparent;
  bool mouseEnable;
  bool keyboardEnable;
  bool transparentIgnorePixels;

public:
  SWidget(SScene* targetScene, std::string widgetName, int xPos, int yPos, unsigned short widgetWidth, unsigned short widgetHeight, SViewPort* targetViewport, unsigned int widgetZOrder, std::string widgetType);

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

  SWidget(SScene* targetScene, std::string widgetName, unsigned short widgetWidth, unsigned short widgetHeight, SMaterial* targetMaterial, unsigned short targetTechnique, unsigned short targetPass, unsigned short targetTextureUnit, std::string widgetType);

  ~SWidget();

  SScene* GetParentScene();

  std::string GetType();

  unsigned short GetWidth();

  unsigned short GetHeight();

  SPoint<unsigned short> GetSize();

  void SetSize(unsigned short newWidth, unsigned short newHeight);

  void SetSize(SPoint<unsigned short> newSize);

  SPoint<int> GetPosition();

  void SetPosition(int xPos, int yPos);

  void SetPosition(const SPoint<int>& newPosition);

  void Move(const SPoint<int>& relativeMove);

        virtual void InjectMouseMove(int xPos, int yPos, MouseButtonId button)=0;

        virtual void InjectMouseWheel(int scrollX, int scrollY, int relativeScroll)=0;

        virtual void InjectMouseDown(int xPos, int yPos, MouseButtonId button)=0;

        virtual void InjectMouseUp(int xPos, int yPos, MouseButtonId button)=0;

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

  virtual void InjectTextEvent(std::string utf8)=0;

  void Show(bool fade=false, unsigned short fadeDurationMS=300);

  void Hide(bool fade=false, unsigned short fadeDurationMS=300);

  bool GetVisible();

  void SetTransparency(bool enableTransparency);

  bool GetTransparency();

  void SetOpacity(float widgetOpacity);

  float GetOpacity();

  void SetIgnoreTransparentPixels(bool widgetIgnoreTransparentPixels, float tresholdColor=0.0f);

  bool GetIgnoreTransparentPixels();

  float GetIgnoreTransparentPixelsTreshold();

  virtual void LoadURL(const std::string& url)=0;

  virtual void LoadFile(const std::string& file)=0;

  void SetZOrder(unsigned short newWidgetOrder);

  unsigned short GetZOrder();

  void TakeFocus();

  bool HasFocus();

  void SetKeyboardEnable(bool enableKeyboardOnWidget);

  bool GetKeyboardEnable();

  void SetMouseEnable(bool enableMouseOnWidget);

  bool GetMouseEnable();

  bool GetMouseOver();

  void SetForeground(bool enableWidgetForeground);

  bool GetForeground();

  void SetTopOnFocus(bool enableWidgetTopOnFocus);

  bool GetTopOnFocus();

  virtual void RunScriptFunction(std::string functionName, std::vector<std::string> argumentList)=0;

  virtual void loadResource(Ogre::Resource* resource);

  virtual int GetPixelUnder(int posX, int posY)=0;
protected:
  bool IsCompensateNPOT() const;

  std::string CheckUrl(const std::string& url);

  virtual void SetFocusImpl(bool focusOnWidget)=0;

  virtual void SetTransparencyImpl(bool enableTransparency)=0;

  virtual void SetKeyboardEnableImpl(bool enableKeyboardOnWidget)=0;

  virtual void SetMouseEnableImpl(bool enableMouseOnWidget)=0;

  virtual void SetSizeImpl(unsigned short newWidth, unsigned short newHeight)=0;
private:
  SWidget();

  void StandardConstructor(SScene* targetScene, int xPos, int yPos, unsigned short widgetWidth, unsigned short widgetHeight, unsigned int widgetZOrder, SViewPort* targetViewport, std::string widgetType);
 
  void _SetOgreOverlayZOrder(unsigned short overlayZOrder);

  void CreateTexture();

  void DestroyTexture();

  void CreateMaterial();

  void DestroyMaterial();
  
  void ApplyMaterialParameters(Ogre::Pass* materialPassToModify, Ogre::TextureUnitState* materialTextureUnitToModify);

  void CreateOverlay();

  void DestroyOverlay();

  void Create2D();

  void Destroy2D();
};

}

#endif

---