SO3Engine/SO3Renderer/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) 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_FLASH_WIDGET_H__
#define __SO3_FLASH_WIDGET_H__

#include "..\SCOLBasic\SO3Std.h"
#include "SO3Widget.h"
#include "Hikari.h"
#include "IFlashControl.h"

namespace SO3
{

#define SO3_FLASH_WIDGET_TYPE "FlashWidget"

class SFlashWidget : public SWidget,
                     protected Hikari::IFlashControl // Set to protected to avoid all the IFlashControl members variables to be public
{
public:
  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
  };
protected:
private:
  typedef HRESULT (__stdcall *GetClassObject)(REFCLSID rclsid, REFIID riid, LPVOID * ppv);
  Hikari::HikariManager* mCreator;
  FlashRenderQuality renderingQuality;
  FlashScaleMode scaleMode;
  int lastDirtyWidth;
        int lastDirtyHeight;
  WindowHandle getTopWindow();
public:
  SFlashWidget(SScene* targetScene, std::string flashWidgetName, int xPos, int yPos, unsigned short widgetWidth, unsigned short widgetHeight, SViewPort* targetViewport, unsigned int widgetZOrder);

  SFlashWidget(SScene* targetScene, std::string flashWidgetName, int xPos, int yPos, unsigned short widgetWidth, unsigned short widgetHeight, SViewPort* targetViewport);

  SFlashWidget(SScene* targetScene, std::string flashWidgetName, unsigned short widgetWidth, unsigned short widgetHeight, SMaterial* targetMaterial, unsigned short targetTechnique, unsigned short targetPass, unsigned short targetTextureUnit);

  void CommonConstructorSequence(bool overlayedFlashControl);

  ~SFlashWidget();

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

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

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

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

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

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

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

  virtual void InjectTextEvent(std::string utf8);

  FlashRenderQuality GetRenderingQuality();

  void SetRenderingQuality(FlashRenderQuality newQuality);

  void Play();

  void Stop();

  void Rewind();

  void Seek(long seekFrame);

  void SetScaleMode(FlashScaleMode widgetScaleMode);

  FlashScaleMode GetScaleMode();

  virtual void RunScriptFunction(std::string functionName, std::vector<std::string> argumentList);
protected:
  virtual void SetFocusImpl(bool focusOnWidget);

  virtual void SetTransparencyImpl(bool enableTransparency);

  virtual void SetKeyboardEnableImpl(bool enableKeyboardOnWidget);

  virtual void SetMouseEnableImpl(bool enableMouseOnWidget);

  virtual void SetSizeImpl(unsigned short newWidth, unsigned short newHeight);

  virtual int GetPixelUnder(int posX, 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, bool pressed);
};

}

#endif

---