SO3FlashWidget.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_FLASH_WIDGET_H__
#define __SO3_FLASH_WIDGET_H__
 
#include "SCOLBasic/SO3Prerequisites.h"
#include "SO3Widget.h"
 
namespace SO3
{
 
#define SO3_FLASH_WIDGET_TYPE "FlashWidget"
 
enum FlashRenderQuality
{
  SO3_FLASH_QUALITY_LOW,
  SO3_FLASH_QUALITY_MEDIUM,
  SO3_FLASH_QUALITY_HIGH,
  SO3_FLASH_QUALITY_BEST,
  SO3_FLASH_QUALITY_AUTOLOW,
  SO3_FLASH_QUALITY_AUTOHIGH
};
enum FlashScaleMode
{
  SO3_FLASH_SCALE_SHOWALL = 0,
  SO3_FLASH_SCALE_NOBORDER,
  SO3_FLASH_SCALE_EXACTFIT
};
 
#ifdef SO3_FLASH_ENABLE
class SFlashWidget : public SWidget,
                     protected Hikari::IFlashControl // Set to protected to avoid all the IFlashControl members variables to be public
{
public:
protected:
private:
  typedef HRESULT (__stdcall *GetClassObject)(REFCLSID rclsid, REFIID riid, LPVOID * ppv);
  Hikari::HikariManager* mCreator;
  FlashRenderQuality renderingQuality;
  FlashScaleMode scaleMode;
  int lastDirtyWidth;
        int lastDirtyHeight;
  ScolWindowHandle getTopWindow();
public:
  SFlashWidget(SScene* targetScene, const std::string& flashWidgetName, const int& xPos, const int& yPos, const unsigned short& widgetWidth, const unsigned short& widgetHeight, SViewPort* targetViewport, const unsigned int& widgetZOrder);
 
  SFlashWidget(SScene* targetScene, const std::string& flashWidgetName, const int& xPos, const int& yPos, const unsigned short& widgetWidth, const unsigned short& widgetHeight, SViewPort* targetViewport);
 
  SFlashWidget(SScene* targetScene, const std::string& flashWidgetName, const unsigned short& widgetWidth, const unsigned short& widgetHeight, SMaterial* targetMaterial, const unsigned short& targetTechnique, const unsigned short& targetPass, const unsigned short& targetTextureUnit);
 
  void CommonConstructorSequence(const bool& overlayedFlashControl);
 
  ~SFlashWidget();
 
  virtual void LoadURL(const std::string& url);
 
  virtual void LoadFile(const std::string& file);
 
        virtual void InjectMouseMove(const int& xPos, const int& yPos, const MouseButtonId& button);
 
        virtual void InjectMouseWheel(const int& scrollX, const int& scrollY, const int& relativeScroll);
 
        virtual void InjectMouseDown(const int& xPos, const int& yPos, const MouseButtonId& button);
 
  virtual void InjectTouchAdd(const int& xPos, const int& yPos, const int& touchid);
 
  virtual void InjectTouchRemove(const int& touchid);
 
  virtual void InjectTouchUpdate(const int& xPos, const int& yPos, const int& vx, const int& vy, const int& touchid);
 
        virtual void InjectMouseUp(const int& xPos, const int& yPos, const MouseButtonId& button);
 
  virtual void InjectKeyEvent(const UINT& msg, const ScolWindowHandle& hwnd, const WPARAM& wParam, const LPARAM& lParam);
 
  virtual void InjectTextEvent(const std::string& utf8);
 
  FlashRenderQuality GetRenderingQuality();
 
  void SetRenderingQuality(const FlashRenderQuality& newQuality);
 
  void Play();
 
  void Stop();
 
  void Rewind();
 
  void Seek(const long& seekFrame);
 
  void SetScaleMode(const FlashScaleMode& widgetScaleMode);
 
  FlashScaleMode GetScaleMode();
 
  virtual void RunScriptFunction(const std::string& functionName, const std::vector<std::string>& argumentList);
protected:
  virtual void SetFocusImpl(const bool& focusOnWidget);
 
  virtual void SetTransparencyImpl(const bool& enableTransparency);
 
  virtual void SetKeyboardEnableImpl(const bool& enableKeyboardOnWidget);
 
  virtual void SetMouseEnableImpl(const bool& enableMouseOnWidget);
 
  virtual void SetSizeImpl(const unsigned short& newWidth, const unsigned short& newHeight);
 
  virtual bool CheckPixelAlpha(const int& posX, const int& posY);
 
        virtual void setZOrder(unsigned short zorder);
        
        virtual unsigned short getZOrder();
 
        virtual int getRelativeX(int absX);
 
        virtual int getRelativeY(int absY);
 
        virtual bool isPointOverMe(int screenX, int screenY);
 
        virtual void invalidateTotally();
 
  virtual void handleFlashCall(const std::wstring& xmlString);
 
  virtual void update();
 
  virtual void load(const std::string& movieFilename, Hikari::HikariManager* hikariMgr, int type);
 
  virtual void play();
        
  virtual void stop();
        
  virtual void rewind();
        
  virtual void gotoFrame(long frameNum);
        
  virtual void setLoop(bool shouldLoop);
        
  virtual void setTransparent(bool isWidgetTransparent, bool useAlphaHack = false);
 
  virtual void setQuality(short renderQuality);
        
  virtual void setScaleMode(short widgetScaleMode);
        
  virtual void setDraggable(bool widgetDraggable);
        
  virtual void setIgnoreTransparentPixels(bool shouldIgnore, float threshold = 0.04);
 
  virtual const std::string& getName() const;
        
  virtual const std::string& getMaterialName() const;
        
  virtual void bind(const std::wstring& funcName, const Hikari::FlashDelegate& callback);
        
  virtual void unbind(const std::wstring& funcName);
        
  virtual Hikari::FlashValue callFunction(const std::wstring& funcName, const Hikari::Arguments& args = Hikari::Args());
        
  virtual void hide();
        
  virtual void show();
        
  virtual bool getVisibility() const;
        
  virtual void setOpacity(float opacity);
        
  virtual void focus();
        
  virtual void move(int deltaX, int deltaY);
 
  virtual void getExtents(unsigned short& width, unsigned short& height) const;
 
  virtual void getUVScale(float& uScale, float& vScale) const;
 
  virtual void injectMouseMove(int xPos, int yPos, int btn);
 
  virtual void injectMouseDown(int xPos, int yPos, int index);
 
  virtual void injectMouseUp(int xPos, int yPos, int index);
 
  virtual void injectMouseWheel(int relScroll, int xPos, int yPos);
 
  virtual void handleKeyEvent(UINT msg, WPARAM wParam, LPARAM lParam);
private:
  UINT MouseButtonMessageConverter(const int& button, const bool& pressed);
};
 
#endif
}
 
#endif