Project

General

Profile

SO3Engine
Hikari::IFlashControl Class Referenceabstract

#include <IFlashControl.h>

Inheritance diagram for Hikari::IFlashControl:
SO3::SFlashWidget

Public Member Functions

 IFlashControl ()
 
virtual ~IFlashControl ()
 
virtual void setZOrder (unsigned short zorder)=0
 
virtual unsigned short getZOrder ()=0
 
virtual int getRelativeX (int absX)=0
 
virtual int getRelativeY (int absY)=0
 
virtual bool isPointOverMe (int screenX, int screenY)=0
 
virtual void invalidateTotally ()=0
 
virtual void handleKeyEvent (UINT msg, WPARAM wParam, LPARAM lParam)=0
 
virtual void handleFlashCall (const std::wstring &xmlString)=0
 
virtual void update ()=0
 
virtual void load (const std::string &movieFilename, HikariManager *hikariMgr, int type)=0
 
virtual void play ()=0
 
virtual void stop ()=0
 
virtual void rewind ()=0
 
virtual void gotoFrame (long frameNum)=0
 
virtual void setLoop (bool shouldLoop)=0
 
virtual void setTransparent (bool isTransparent, bool useAlphaHack=false)=0
 
virtual void setQuality (short renderQuality)=0
 
virtual void setScaleMode (short scaleMode)=0
 
virtual void setDraggable (bool isDraggable)=0
 
virtual void setIgnoreTransparentPixels (bool shouldIgnore, float threshold=0.04)=0
 
virtual const std::string & getName () const =0
 
virtual const std::string & getMaterialName () const =0
 
virtual void bind (const std::wstring &funcName, const FlashDelegate &callback)=0
 
virtual void unbind (const std::wstring &funcName)=0
 
virtual FlashValue callFunction (const std::wstring &funcName, const Arguments &args=Args())=0
 
virtual void hide ()=0
 
virtual void show ()=0
 
virtual bool getVisibility () const =0
 
virtual void setOpacity (float opacity)=0
 
virtual void focus ()=0
 
virtual void move (int deltaX, int deltaY)=0
 
virtual void getExtents (unsigned short &width, unsigned short &height) const =0
 
virtual void getUVScale (float &uScale, float &vScale) const =0
 
virtual void injectMouseMove (int xPos, int yPos, int btn)=0
 
virtual void injectMouseDown (int xPos, int yPos, int index)=0
 
virtual void injectMouseUp (int xPos, int yPos, int index)=0
 
virtual void injectMouseWheel (int relScroll, int xPos, int yPos)=0
 

Public Attributes

Hikari::Impl::FlashSitesite
 
Hikari::Impl::FlashHandlerhandler
 
Hikari::Impl::RenderBufferrenderBuffer
 
ShockwaveFlashObjects::IShockwaveFlash * flashInterface
 
IOleObject * oleObject
 
IOleInPlaceObjectWindowless * windowlessObject
 
HDC mainContext
 
HDC altContext
 
HBITMAP mainBitmap
 
HBITMAP altBitmap
 
HGDIOBJ hOldMainBmp
 
HGDIOBJ hOldAltBmp
 
BYTE * mainBuffer
 
BYTE * altBuffer
 
std::string name
 
int zOrder
 
int initialZOrder
 
int currentZOrder
 
int comCount
 
int width
 
int height
 
int lastBufferSize
 
RECT dirtyBounds
 
bool isClean
 
bool isTotallyDirty
 
bool okayToDelete
 
bool compensateNPOT
 
bool isTransparent
 
bool isDraggable
 
bool isInputListener
 
bool isVisible
 
bool isBlocked
 
bool Foreground
 
bool topOnFocus
 
bool keyBoardEnable
 
bool mouseEnable
 
bool isOverlay
 
int scolFlags
 

Friends

class Impl::FlashSite
 
class Impl::FlashHandler
 
class Impl::RenderBuffer
 
class HikariManager
 
struct Position
 

Detailed Description

The IFlashControl class is an UNDOCKED interface of the FlashControl class that is rendered dynamically to a texture and wrapped in an optional movable overlay using the Ogre3D engine.

Definition at line 72 of file IFlashControl.h.

Constructor & Destructor Documentation

◆ IFlashControl()

Hikari::IFlashControl::IFlashControl ( )
inline

Definition at line 124 of file IFlashControl.h.

◆ ~IFlashControl()

virtual Hikari::IFlashControl::~IFlashControl ( )
inlinevirtual

Definition at line 125 of file IFlashControl.h.

Member Function Documentation

◆ bind()

virtual void Hikari::IFlashControl::bind ( const std::wstring &  funcName,
const FlashDelegate callback 
)
pure virtual

Implemented in SO3::SFlashWidget.

◆ callFunction()

virtual FlashValue Hikari::IFlashControl::callFunction ( const std::wstring &  funcName,
const Arguments args = Args() 
)
pure virtual

◆ focus()

virtual void Hikari::IFlashControl::focus ( )
pure virtual

Implemented in SO3::SFlashWidget.

◆ getExtents()

virtual void Hikari::IFlashControl::getExtents ( unsigned short &  width,
unsigned short &  height 
) const
pure virtual

Implemented in SO3::SFlashWidget.

◆ getMaterialName()

virtual const std::string & Hikari::IFlashControl::getMaterialName ( ) const
pure virtual

Implemented in SO3::SFlashWidget.

◆ getName()

virtual const std::string & Hikari::IFlashControl::getName ( ) const
pure virtual

Implemented in SO3::SFlashWidget.

◆ getRelativeX()

virtual int Hikari::IFlashControl::getRelativeX ( int  absX)
pure virtual

Implemented in SO3::SFlashWidget.

◆ getRelativeY()

virtual int Hikari::IFlashControl::getRelativeY ( int  absY)
pure virtual

Implemented in SO3::SFlashWidget.

◆ getUVScale()

virtual void Hikari::IFlashControl::getUVScale ( float &  uScale,
float &  vScale 
) const
pure virtual

Implemented in SO3::SFlashWidget.

◆ getVisibility()

virtual bool Hikari::IFlashControl::getVisibility ( ) const
pure virtual

Implemented in SO3::SFlashWidget.

◆ getZOrder()

virtual unsigned short Hikari::IFlashControl::getZOrder ( )
pure virtual

Implemented in SO3::SFlashWidget.

◆ gotoFrame()

virtual void Hikari::IFlashControl::gotoFrame ( long  frameNum)
pure virtual

Implemented in SO3::SFlashWidget.

◆ handleFlashCall()

virtual void Hikari::IFlashControl::handleFlashCall ( const std::wstring &  xmlString)
pure virtual

Implemented in SO3::SFlashWidget.

◆ handleKeyEvent()

virtual void Hikari::IFlashControl::handleKeyEvent ( UINT  msg,
WPARAM  wParam,
LPARAM  lParam 
)
pure virtual

Implemented in SO3::SFlashWidget.

◆ hide()

virtual void Hikari::IFlashControl::hide ( )
pure virtual

Implemented in SO3::SFlashWidget.

◆ injectMouseDown()

virtual void Hikari::IFlashControl::injectMouseDown ( int  xPos,
int  yPos,
int  index 
)
pure virtual

Implemented in SO3::SFlashWidget.

◆ injectMouseMove()

virtual void Hikari::IFlashControl::injectMouseMove ( int  xPos,
int  yPos,
int  btn 
)
pure virtual

Implemented in SO3::SFlashWidget.

◆ injectMouseUp()

virtual void Hikari::IFlashControl::injectMouseUp ( int  xPos,
int  yPos,
int  index 
)
pure virtual

Implemented in SO3::SFlashWidget.

◆ injectMouseWheel()

virtual void Hikari::IFlashControl::injectMouseWheel ( int  relScroll,
int  xPos,
int  yPos 
)
pure virtual

Implemented in SO3::SFlashWidget.

◆ invalidateTotally()

virtual void Hikari::IFlashControl::invalidateTotally ( )
pure virtual

Implemented in SO3::SFlashWidget.

◆ isPointOverMe()

virtual bool Hikari::IFlashControl::isPointOverMe ( int  screenX,
int  screenY 
)
pure virtual

Implemented in SO3::SFlashWidget.

◆ load()

virtual void Hikari::IFlashControl::load ( const std::string &  movieFilename,
HikariManager hikariMgr,
int  type 
)
pure virtual

Implemented in SO3::SFlashWidget.

◆ move()

virtual void Hikari::IFlashControl::move ( int  deltaX,
int  deltaY 
)
pure virtual

Implemented in SO3::SFlashWidget.

◆ play()

virtual void Hikari::IFlashControl::play ( )
pure virtual

Implemented in SO3::SFlashWidget.

◆ rewind()

virtual void Hikari::IFlashControl::rewind ( )
pure virtual

Implemented in SO3::SFlashWidget.

◆ setDraggable()

virtual void Hikari::IFlashControl::setDraggable ( bool  isDraggable)
pure virtual

Implemented in SO3::SFlashWidget.

◆ setIgnoreTransparentPixels()

virtual void Hikari::IFlashControl::setIgnoreTransparentPixels ( bool  shouldIgnore,
float  threshold = 0.04 
)
pure virtual

Implemented in SO3::SFlashWidget.

◆ setLoop()

virtual void Hikari::IFlashControl::setLoop ( bool  shouldLoop)
pure virtual

Implemented in SO3::SFlashWidget.

◆ setOpacity()

virtual void Hikari::IFlashControl::setOpacity ( float  opacity)
pure virtual

Implemented in SO3::SFlashWidget.

◆ setQuality()

virtual void Hikari::IFlashControl::setQuality ( short  renderQuality)
pure virtual

Implemented in SO3::SFlashWidget.

◆ setScaleMode()

virtual void Hikari::IFlashControl::setScaleMode ( short  scaleMode)
pure virtual

Implemented in SO3::SFlashWidget.

◆ setTransparent()

virtual void Hikari::IFlashControl::setTransparent ( bool  isTransparent,
bool  useAlphaHack = false 
)
pure virtual

Implemented in SO3::SFlashWidget.

◆ setZOrder()

virtual void Hikari::IFlashControl::setZOrder ( unsigned short  zorder)
pure virtual

Implemented in SO3::SFlashWidget.

◆ show()

virtual void Hikari::IFlashControl::show ( )
pure virtual

Implemented in SO3::SFlashWidget.

◆ stop()

virtual void Hikari::IFlashControl::stop ( )
pure virtual

Implemented in SO3::SFlashWidget.

◆ unbind()

virtual void Hikari::IFlashControl::unbind ( const std::wstring &  funcName)
pure virtual

Implemented in SO3::SFlashWidget.

◆ update()

virtual void Hikari::IFlashControl::update ( )
pure virtual

Implemented in SO3::SFlashWidget.

Friends And Related Symbol Documentation

◆ HikariManager

HikariManager
friend

Definition at line 78 of file IFlashControl.h.

◆ Impl::FlashHandler

friend class Impl::FlashHandler
friend

Definition at line 76 of file IFlashControl.h.

◆ Impl::FlashSite

friend class Impl::FlashSite
friend

Definition at line 75 of file IFlashControl.h.

◆ Impl::RenderBuffer

friend class Impl::RenderBuffer
friend

Definition at line 77 of file IFlashControl.h.

◆ Position

friend struct Position
friend

Definition at line 79 of file IFlashControl.h.

Member Data Documentation

◆ altBitmap

HBITMAP Hikari::IFlashControl::altBitmap

Definition at line 93 of file IFlashControl.h.

◆ altBuffer

BYTE * Hikari::IFlashControl::altBuffer

Definition at line 95 of file IFlashControl.h.

◆ altContext

HDC Hikari::IFlashControl::altContext

Definition at line 92 of file IFlashControl.h.

◆ comCount

int Hikari::IFlashControl::comCount

Definition at line 103 of file IFlashControl.h.

◆ compensateNPOT

bool Hikari::IFlashControl::compensateNPOT

Definition at line 110 of file IFlashControl.h.

◆ currentZOrder

int Hikari::IFlashControl::currentZOrder

Definition at line 102 of file IFlashControl.h.

◆ dirtyBounds

RECT Hikari::IFlashControl::dirtyBounds

Definition at line 107 of file IFlashControl.h.

◆ flashInterface

ShockwaveFlashObjects::IShockwaveFlash* Hikari::IFlashControl::flashInterface

Definition at line 88 of file IFlashControl.h.

◆ Foreground

bool Hikari::IFlashControl::Foreground

Definition at line 116 of file IFlashControl.h.

◆ handler

Hikari::Impl::FlashHandler* Hikari::IFlashControl::handler

Definition at line 85 of file IFlashControl.h.

◆ height

int Hikari::IFlashControl::height

Definition at line 105 of file IFlashControl.h.

◆ hOldAltBmp

HGDIOBJ Hikari::IFlashControl::hOldAltBmp

Definition at line 94 of file IFlashControl.h.

◆ hOldMainBmp

HGDIOBJ Hikari::IFlashControl::hOldMainBmp

Definition at line 94 of file IFlashControl.h.

◆ initialZOrder

int Hikari::IFlashControl::initialZOrder

Definition at line 101 of file IFlashControl.h.

◆ isBlocked

bool Hikari::IFlashControl::isBlocked

Definition at line 115 of file IFlashControl.h.

◆ isClean

bool Hikari::IFlashControl::isClean

Definition at line 108 of file IFlashControl.h.

◆ isDraggable

bool Hikari::IFlashControl::isDraggable

Definition at line 112 of file IFlashControl.h.

◆ isInputListener

bool Hikari::IFlashControl::isInputListener

Definition at line 113 of file IFlashControl.h.

◆ isOverlay

bool Hikari::IFlashControl::isOverlay

Definition at line 120 of file IFlashControl.h.

◆ isTotallyDirty

bool Hikari::IFlashControl::isTotallyDirty

Definition at line 108 of file IFlashControl.h.

◆ isTransparent

bool Hikari::IFlashControl::isTransparent

Definition at line 111 of file IFlashControl.h.

◆ isVisible

bool Hikari::IFlashControl::isVisible

Definition at line 114 of file IFlashControl.h.

◆ keyBoardEnable

bool Hikari::IFlashControl::keyBoardEnable

Definition at line 118 of file IFlashControl.h.

◆ lastBufferSize

int Hikari::IFlashControl::lastBufferSize

Definition at line 106 of file IFlashControl.h.

◆ mainBitmap

HBITMAP Hikari::IFlashControl::mainBitmap

Definition at line 93 of file IFlashControl.h.

◆ mainBuffer

BYTE* Hikari::IFlashControl::mainBuffer

Definition at line 95 of file IFlashControl.h.

◆ mainContext

HDC Hikari::IFlashControl::mainContext

Definition at line 92 of file IFlashControl.h.

◆ mouseEnable

bool Hikari::IFlashControl::mouseEnable

Definition at line 119 of file IFlashControl.h.

◆ name

std::string Hikari::IFlashControl::name

Definition at line 99 of file IFlashControl.h.

◆ okayToDelete

bool Hikari::IFlashControl::okayToDelete

Definition at line 109 of file IFlashControl.h.

◆ oleObject

IOleObject* Hikari::IFlashControl::oleObject

Definition at line 89 of file IFlashControl.h.

◆ renderBuffer

Hikari::Impl::RenderBuffer* Hikari::IFlashControl::renderBuffer

Definition at line 86 of file IFlashControl.h.

◆ scolFlags

int Hikari::IFlashControl::scolFlags

Definition at line 121 of file IFlashControl.h.

◆ site

Hikari::Impl::FlashSite* Hikari::IFlashControl::site

Definition at line 84 of file IFlashControl.h.

◆ topOnFocus

bool Hikari::IFlashControl::topOnFocus

Definition at line 117 of file IFlashControl.h.

◆ width

int Hikari::IFlashControl::width

Definition at line 104 of file IFlashControl.h.

◆ windowlessObject

IOleInPlaceObjectWindowless* Hikari::IFlashControl::windowlessObject

Definition at line 90 of file IFlashControl.h.

◆ zOrder

int Hikari::IFlashControl::zOrder

Definition at line 100 of file IFlashControl.h.


The documentation for this class was generated from the following file: