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) 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_H_
#define _SO3_WIDGET_H_
 
#include "SCOLBasic/SO3Prerequisites.h"
#include "SCOLBasic/SO3DataScol.h"
#include "SO3Utils/SO3Point.h"
#include <OgreRectangle2D.h>
#include <OgreOverlay.h>
#include <OgreOverlaySystem.h>
#include <OgreOverlayElement.h>
#include <OgreOverlayManager.h>
#include <OgrePanelOverlayElement.h>
namespace SO3
{
 
class _SO3_Export SWidget : public SData,
                            public Ogre::ManualResourceLoader
{
public:
  enum StereoMode
  {
    MONO = 0,
    SBS = 1,
    TB = 2,
    BT = 3
  };
 
  class SMatData
  {
  public:
    SMatData(){};
    ~SMatData(){};
 
    Ogre::SceneBlendFactor oSceneBlendingS;
    Ogre::SceneBlendFactor oSceneBlendingD;
    bool oDepthWrite;
  };
 
public:
  friend SWidgetManager;
protected:
  std::string baseResourceName;
  int leftPos;
  int topPos;
  float leftOffset;
  float topOffset;
  unsigned short width;
  unsigned short height;
  unsigned short mTextureWidth;                   
  unsigned short mTextureHeight;                  
  float textureRatio;                   
  SScene* scene;
  SViewPort* viewport;
  Ogre::Viewport* currentViewport;
  Ogre::TexturePtr renderingTexture;
  bool forceRenderingUpdate;
  float transparentTresholdColor;
  bool compensateNPOT;                           
  Ogre::Vector2 xCoef;
  Ogre::Vector2 yCoef;
 
private:
  const bool isOverlayed;
  const bool is2DRect;
  StereoMode mStereoMode;
  float widthScale;
  float heightScale;
  std::string type;
  Ogre::TextureUnitState* ogreTargetTextureUnit; 
  Ogre::Pass* ogreTargetMaterialPass;
  Ogre::Overlay* ogreOverlay;                    
  Ogre::PanelOverlayElement* ogreOverlayPanel;   
  Ogre::Rectangle2D* ogre2dRect;                 
  Ogre::SceneNode* ogre2dNode;                   
  Ogre::MaterialPtr ogreOverlayMaterial;         
  SMaterial* originalMaterial;                   
  SMatData matData;                              
  Ogre::MaterialPtr ogreTargetMaterial;          
  Ogre::TextureUnitState* ogreOriginalTextureUnit;
  unsigned int zOrder;                           
  bool topOnFocus;
  bool isPriorized;
  bool mouseIsOver;                              
  std::vector<int> inputIndexes;                 
  Ogre::TextureUnitState* renderingTextureUnit;
  float opacity;
  bool isTransparent;
  bool mouseEnable;
  bool keyboardEnable;
  bool transparentIgnorePixels;
  bool updateOnFocusOnly;
  bool mVisible;
 
public:
  SWidget(SScene* targetScene, const std::string& widgetName, const int& xPos, const int& yPos, const unsigned short& widgetWidth, const unsigned short& widgetHeight, SViewPort* targetViewport, const unsigned int& widgetZOrder, const std::string& widgetType);
 
  SWidget(SScene* targetScene, const std::string& widgetName, const int& xPos, const int& yPos, const unsigned short& widgetWidth, const unsigned short& widgetHeight, SViewPort* targetViewport, const std::string& widgetType);
 
  SWidget(SScene* targetScene, const std::string& widgetName, const unsigned short& widgetWidth, const unsigned short& widgetHeight, SMaterial* targetMaterial, const unsigned short& targetTechnique, const unsigned short& targetPass, const unsigned short& targetTextureUnit, const std::string& widgetType);
 
  virtual ~SWidget();
 
  SScene* GetParentScene();
 
  std::string GetType();
 
  unsigned short GetWidth();
 
  unsigned short GetHeight();
 
  SPoint<unsigned short> GetSize();
 
  void SetSize(const unsigned short& newWidth, const unsigned short& newHeight);
 
  void SetSize(const SPoint<unsigned short>& newSize);
 
  float GetTextureRatio();
 
  void SetTextureRatio(const float& newRatio);
 
  bool GetIsStereo();
 
  void SetStereo(StereoMode state);
 
  void SetStereoEye(bool isleft = true);
 
  SPoint<int> GetPosition();
 
  void SetPosition(const int& xPos, const int& yPos);
 
  void SetPosition(const SPoint<int>& newPosition);
 
  void Move(const SPoint<int>& relativeMove);
 
  void SetCurrentViewport(Ogre::Viewport* vp);
 
  void SetScale(const float width, const float height);
 
  SPoint<float> GetScale();
 
  void SetLeftOffset(const float left);
 
  void SetTopOffset(const float top);
 
  SPoint<int> GetRealPixelPosition();
 
  SPoint<unsigned short> GetRealPixelSize();
 
        virtual void InjectMouseMove(const int& xPos, const int& yPos, const MouseButtonId& button)=0;
 
        virtual void InjectMouseWheel(const int& scrollX, const int& scrollY, const int& relativeScroll)=0;
 
        virtual void InjectMouseDown(const int& xPos, const int& yPos, const MouseButtonId& button)=0;
 
        virtual void InjectMouseUp(const int& xPos, const int& yPos, const MouseButtonId& button)=0;
 
  virtual void InjectTouchAdd(const int& xPos, const int& yPos, const int& touchid) = 0;
 
  virtual void InjectTouchRemove(const int& touchid) = 0;
 
  virtual void InjectTouchUpdate(const int& xPos, const int& yPos, const int& vx, const int& vy, const int& touchid) = 0;
 
  virtual void InjectKeyEvent(const UINT& msg, const ScolWindowHandle& hwnd, const WPARAM& wParam, const LPARAM& lParam) = 0;
 
  virtual void InjectTextEvent(const std::string& utf8)=0;
 
  void Show(const bool& fade=false, const unsigned short& fadeDurationMS=300);
 
  void Hide(const bool& fade=false, const unsigned short& fadeDurationMS=300);
 
  bool GetVisible();
 
  void SetTransparency(const bool& enableTransparency);
 
  bool GetTransparency();
 
  void SetOpacity(const float& widgetOpacity);
 
  float GetOpacity();
 
  void SetIgnoreTransparentPixels(const bool& widgetIgnoreTransparentPixels, const 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(const unsigned short& newWidgetOrder);
 
  unsigned short GetZOrder();
 
  void TakeFocus();
 
  void ReleaseFocus();
 
  bool HasFocus();
 
  void SetKeyboardEnable(const bool& enableKeyboardOnWidget);
 
  bool GetKeyboardEnable();
 
  void SetMouseEnable(const bool& enableMouseOnWidget);
 
  bool GetMouseEnable();
 
  bool GetMouseOver();
 
  bool GetInputOver(int id);
 
  void SetInputOver(int id, bool state);
 
  void SetForeground(const bool& enableWidgetForeground);
 
  bool GetForeground();
 
  void SetTopOnFocus(const bool& enableWidgetTopOnFocus);
 
  bool GetTopOnFocus();
 
  virtual void RunScriptFunction(const std::string& functionName, const std::vector<std::string>& argumentList)=0;
 
  virtual void loadResource(Ogre::Resource* resource);
 
  virtual bool CheckPixelAlpha(const int& posX, const int& posY)=0;
 
  bool GetUpdateOnFocusOnly();
 
  void SetUpdateOnFocusOnly(const bool& activate);
 
  bool GetIsOverlayed();
 
  bool GetIs2DRect();
 
  virtual HCURSOR GetCurrentMouseCursor();
protected:
  bool IsCompensateNPOT() const;
 
  void CreateTexture(bool alpha = true);
 
  std::string CheckUrl(const std::string& url);
 
  virtual void SetFocusImpl(const bool& focusOnWidget)=0;
 
  virtual void SetTransparencyImpl(const bool& enableTransparency)=0;
 
  virtual void SetKeyboardEnableImpl(const bool& enableKeyboardOnWidget)=0;
 
  virtual void SetMouseEnableImpl(const bool& enableMouseOnWidget)=0;
 
  virtual void SetSizeImpl(const unsigned short& newWidth, const unsigned short& newHeight)=0;
private:
  SWidget();
 
  void StandardConstructor(SScene* targetScene, const int& xPos, const int& yPos, const unsigned short& widgetWidth, const unsigned short& widgetHeight, const unsigned int& widgetZOrder, SViewPort* targetViewport, const std::string& widgetType);
 
  void _SetOgreOverlayZOrder(const unsigned short& overlayZOrder);
 
  void DestroyTexture();
 
  void CreateMaterial();
 
  void DestroyMaterial();
  
  void ApplyMaterialParameters(Ogre::Pass* materialPassToModify, Ogre::TextureUnitState* materialTextureUnitToModify);
 
  void CreateOverlay();
 
  void DestroyOverlay();
 
  void Create2D();
 
  void Destroy2D();
};
 
}
 
#endif