SO3::SFlashWidget Class Reference

#include <SO3FlashWidget.h>

Inheritance diagram for SO3::SFlashWidget:

Public Types
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 }
Public Member Functions
	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 Member Functions
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)

Detailed Description

Definition at line 48 of file SO3FlashWidget.h.

Member Enumeration Documentation

enum SO3::SFlashWidget::FlashRenderQuality

Enumerator:

SO3_FLASH_QUALITY_LOW
SO3_FLASH_QUALITY_MEDIUM
SO3_FLASH_QUALITY_HIGH
SO3_FLASH_QUALITY_BEST
SO3_FLASH_QUALITY_AUTOLOW
SO3_FLASH_QUALITY_AUTOHIGH

Definition at line 52 of file SO3FlashWidget.h.

enum SO3::SFlashWidget::FlashScaleMode

Enumerator:

SO3_FLASH_SCALE_SHOWALL
SO3_FLASH_SCALE_NOBORDER
SO3_FLASH_SCALE_EXACTFIT

Definition at line 61 of file SO3FlashWidget.h.

Constructor & Destructor Documentation

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

Construct a widget on a SViewport, using an overlay. )

Definition at line 50 of file SO3FlashWidget.cpp.

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

Construct a widget on a SViewport, using an overlay. )

Definition at line 57 of file SO3FlashWidget.cpp.

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

Construct a widget on a SViewport, using an overlay. )

Definition at line 64 of file SO3FlashWidget.cpp.

SO3::SFlashWidget::~SFlashWidget ( )

Destructor.

Definition at line 174 of file SO3FlashWidget.cpp.

Member Function Documentation

void SO3::SFlashWidget::bind	(	const std::wstring &	funcName,
		const Hikari::FlashDelegate &	callback
	)			`[protected, virtual]`

Definition at line 697 of file SO3FlashWidget.cpp.

Hikari::FlashValue SO3::SFlashWidget::callFunction	(	const std::wstring &	funcName,
		const Hikari::Arguments &	args = `Hikari::Args()`
	)			`[protected, virtual]`

Definition at line 707 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::CommonConstructorSequence ( bool overlayedFlashControl )

Common constructor sequence for every SFlashWidget constructor signature.

Definition at line 71 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::focus ( ) [protected, virtual]

Definition at line 742 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::getExtents	(	unsigned short &	width,
		unsigned short &	height
	)			const `[protected, virtual]`

Definition at line 753 of file SO3FlashWidget.cpp.

const std::string & SO3::SFlashWidget::getMaterialName ( ) const [protected, virtual]

Definition at line 691 of file SO3FlashWidget.cpp.

const std::string & SO3::SFlashWidget::getName ( ) const [protected, virtual]

Definition at line 686 of file SO3FlashWidget.cpp.

int SO3::SFlashWidget::GetPixelUnder	(	int	posX,
		int	posY
	)			`[protected, virtual]`

return -1 if no pixel is under coordonates.

Implements SO3::SWidget.

Definition at line 834 of file SO3FlashWidget.cpp.

int SO3::SFlashWidget::getRelativeX ( int absX ) [protected, virtual]

Definition at line 398 of file SO3FlashWidget.cpp.

int SO3::SFlashWidget::getRelativeY ( int absY ) [protected, virtual]

Definition at line 404 of file SO3FlashWidget.cpp.

SFlashWidget::FlashRenderQuality SO3::SFlashWidget::GetRenderingQuality ( )

Get the rendering quality of the flash widget

Definition at line 289 of file SO3FlashWidget.cpp.

SFlashWidget::FlashScaleMode SO3::SFlashWidget::GetScaleMode ( )

Return the scale mode used by this flash widget

Definition at line 324 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::getUVScale	(	float &	uScale,
		float &	vScale
	)			const `[protected, virtual]`

Definition at line 758 of file SO3FlashWidget.cpp.

bool SO3::SFlashWidget::getVisibility ( ) const [protected, virtual]

Definition at line 733 of file SO3FlashWidget.cpp.

unsigned short SO3::SFlashWidget::getZOrder ( ) [protected, virtual]

Definition at line 392 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::gotoFrame ( long frameNum ) [protected, virtual]

Definition at line 623 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::handleFlashCall ( const std::wstring & xmlString ) [protected, virtual]

Definition at line 437 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::handleKeyEvent	(	UINT	msg,
		WPARAM	wParam,
		LPARAM	lParam
	)			`[protected, virtual]`

Definition at line 792 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::hide ( ) [protected, virtual]

Definition at line 723 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::InjectKeyEvent	(	UINT	msg,
		WindowHandle	hwnd,
		WPARAM	wParam,
		LPARAM	lParam
	)			`[virtual]`

Implements SO3::SWidget.

Definition at line 269 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::injectMouseDown	(	int	xPos,
		int	yPos,
		int	index
	)			`[protected, virtual]`

Definition at line 774 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::InjectMouseDown	(	int	xPos,
		int	yPos,
		MouseButtonId	button
	)			`[virtual]`

Injects mouse down events into this Widget. You must supply the current coordinates of the mouse in this Widget's own local coordinate space.

Parameters:

	xPos	The absolute X-Value of the mouse, relative to this Widget's origin.
	yPos	The absolute Y-Value of the mouse, relative to this Widget's origin.

Implements SO3::SWidget.

Definition at line 259 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::injectMouseMove	(	int	xPos,
		int	yPos,
		int	btn
	)			`[protected, virtual]`

Definition at line 768 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::InjectMouseMove	(	int	xPos,
		int	yPos,
		MouseButtonId	button
	)			`[virtual]`

Injects the mouse's current coordinates (in this Widget's own local coordinate space) into this Widget.

Parameters:

	xPos	The X-coordinate of the mouse, relative to this Widget's origin.
	yPos	The Y-coordinate of the mouse, relative to this Widget's origin.

Implements SO3::SWidget.

Definition at line 249 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::injectMouseUp	(	int	xPos,
		int	yPos,
		int	index
	)			`[protected, virtual]`

Definition at line 780 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::InjectMouseUp	(	int	xPos,
		int	yPos,
		MouseButtonId	button
	)			`[virtual]`

Injects mouse up events into this Widget. You must supply the current coordinates of the mouse in this Widget's own local coordinate space.

Parameters:

	xPos	The absolute X-Value of the mouse, relative to this Widget's origin.
	yPos	The absolute Y-Value of the mouse, relative to this Widget's origin.

Implements SO3::SWidget.

Definition at line 264 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::injectMouseWheel	(	int	relScroll,
		int	xPos,
		int	yPos
	)			`[protected, virtual]`

Definition at line 786 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::InjectMouseWheel	(	int	scrollX,
		int	scrollY,
		int	relativeScroll
	)			`[virtual]`

Injects mouse wheel events into this Widget.

Parameters:

	scrollX	scroll distance on X axis
	scrollY	scroll distance on Y axis

Implements SO3::SWidget.

Definition at line 254 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::InjectTextEvent ( std::string utf8 ) [virtual]

Implements SO3::SWidget.

Definition at line 274 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::invalidateTotally ( ) [protected, virtual]

Definition at line 416 of file SO3FlashWidget.cpp.

bool SO3::SFlashWidget::isPointOverMe	(	int	screenX,
		int	screenY
	)			`[protected, virtual]`

Definition at line 410 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::load	(	const std::string &	movieFilename,
		Hikari::HikariManager *	hikariMgr,
		int	type
	)			`[protected, virtual]`

Definition at line 603 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::LoadFile ( const std::string & file ) [virtual]

Loads a local file.

Note:: The file should reside in a scol partition.

Implements SO3::SWidget.

Definition at line 235 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::LoadURL ( const std::string & url ) [virtual]

Implements SO3::SWidget.

Definition at line 229 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::move	(	int	deltaX,
		int	deltaY
	)			`[protected, virtual]`

Definition at line 748 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::play ( ) [protected, virtual]

Definition at line 608 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::Play ( )

Play the flash program.

Definition at line 299 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::rewind ( ) [protected, virtual]

Definition at line 618 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::Rewind ( )

Restart the flash program at the begining

Definition at line 309 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::RunScriptFunction	(	std::string	functionName,
		std::vector< std::string >	argumentList
	)			`[virtual]`

Execute an action script function using the parameters passed in the list.

Implements SO3::SWidget.

Definition at line 341 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::Seek ( long seekFrame )

Position the flash program to the given frame

Definition at line 314 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::setDraggable ( bool widgetDraggable ) [protected, virtual]

Definition at line 676 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::SetFocusImpl ( bool focusOnWidget ) [protected, virtual]

Focus or unfocus widget implementation.

Implements SO3::SWidget.

Definition at line 278 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::setIgnoreTransparentPixels	(	bool	shouldIgnore,
		float	threshold = `0.04`
	)			`[protected, virtual]`

Definition at line 681 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::SetKeyboardEnableImpl ( bool enableKeyboardOnWidget ) [protected, virtual]

Implements SO3::SWidget.

Definition at line 369 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::setLoop ( bool shouldLoop ) [protected, virtual]

Definition at line 628 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::SetMouseEnableImpl ( bool enableMouseOnWidget ) [protected, virtual]

Enable mouse input on widget.

Implements SO3::SWidget.

Definition at line 375 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::setOpacity ( float opacity ) [protected, virtual]

Definition at line 738 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::setQuality ( short renderQuality ) [protected, virtual]

Definition at line 642 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::SetRenderingQuality ( SFlashWidget::FlashRenderQuality newQuality )

Set the rendering quality of the flash widget

Definition at line 294 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::setScaleMode ( short widgetScaleMode ) [protected, virtual]

Definition at line 668 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::SetScaleMode ( SFlashWidget::FlashScaleMode widgetScaleMode )

Set the scale mode to be used by this flash widget

Definition at line 319 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::SetSizeImpl	(	unsigned short	newWidth,
		unsigned short	newHeight
	)			`[protected, virtual]`

Implements SO3::SWidget.

Definition at line 380 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::SetTransparencyImpl ( bool enableTransparency ) [protected, virtual]

Implements SO3::SWidget.

Definition at line 284 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::setTransparent	(	bool	isWidgetTransparent,
		bool	useAlphaHack = `false`
	)			`[protected, virtual]`

Definition at line 633 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::setZOrder ( unsigned short zorder ) [protected, virtual]

Definition at line 387 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::show ( ) [protected, virtual]

Definition at line 728 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::stop ( ) [protected, virtual]

Definition at line 613 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::Stop ( )

Stop to play the flash program.

Definition at line 304 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::unbind ( const std::wstring & funcName ) [protected, virtual]

Definition at line 702 of file SO3FlashWidget.cpp.

void SO3::SFlashWidget::update ( ) [protected, virtual]

Definition at line 492 of file SO3FlashWidget.cpp.

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

SO3Engine/SO3Renderer/SO3FlashWidget.h
SO3Engine/SO3Renderer/SO3FlashWidget.cpp

SO3::SFlashWidget Class Reference

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation