SO3::SBitmapWidget Class Reference

#include <SO3BitmapWidget.h>

Inheritance diagram for SO3::SBitmapWidget:

List of all members.

Public Member Functions
	SBitmapWidget (SScene *targetScene, std::string bitmapWidgetName, int xPos, int yPos, unsigned short widgetWidth, unsigned short widgetHeight, SViewPort *targetViewport, unsigned int widgetZOrder)
	SBitmapWidget (SScene *targetScene, std::string bitmapWidgetName, int xPos, int yPos, unsigned short widgetWidth, unsigned short widgetHeight, SViewPort *targetViewport)
	SBitmapWidget (SScene *targetScene, std::string bitmapWidgetName, unsigned short widgetWidth, unsigned short widgetHeight, SMaterial *targetMaterial, unsigned short targetTechnique, unsigned short targetPass, unsigned short targetTextureUnit)
void	CommonConstructorSequence ()
	~SBitmapWidget ()
virtual void	LoadURL (const std::string &url)
virtual void	LoadFile (const std::string &file)
void	UpdateRawData (PtrObjBitmap scolBitmap)
void	UpdateRawData (PtrObjBitmap scolBitmap, PtrObjBitmap scolAlphaBitmap)
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)
virtual void	RunScriptFunction (std::string functionName, std::vector< std::string > argumentList)
virtual void	loadResource (Ogre::Resource *resource)
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)

---

Detailed Description

Definition at line 47 of file SO3BitmapWidget.h.

---

Constructor & Destructor Documentation

SO3::SBitmapWidget::SBitmapWidget	(	SScene *	targetScene,
		std::string	bitmapWidgetName,
		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 48 of file SO3BitmapWidget.cpp.

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

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

Definition at line 53 of file SO3BitmapWidget.cpp.

SO3::SBitmapWidget::SBitmapWidget	(	SScene *	targetScene,
		std::string	bitmapWidgetName,
		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 58 of file SO3BitmapWidget.cpp.

SO3::SBitmapWidget::~SBitmapWidget

(

)

Destructor.

Definition at line 71 of file SO3BitmapWidget.cpp.

---

Member Function Documentation

void SO3::SBitmapWidget::CommonConstructorSequence

(

)

Common constructor sequence for every SBitmapWidget constructor signature.

Definition at line 63 of file SO3BitmapWidget.cpp.

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

return -1 if no pixel is under coordonates.

Implements SO3::SWidget.

Definition at line 206 of file SO3BitmapWidget.cpp.

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

Implements SO3::SWidget.

Definition at line 167 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::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 157 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::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 147 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::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 162 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::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 152 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::InjectTextEvent

(

std::string

utf8

)

[virtual]

Implements SO3::SWidget.

Definition at line 172 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::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 83 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::loadResource

(

Ogre::Resource *

resource

)

[virtual]

Reimplemented from SO3::SWidget.

Definition at line 235 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::LoadURL

(

const std::string &

url

)

[virtual]

Implements SO3::SWidget.

Definition at line 77 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::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 186 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::SetFocusImpl

(

bool

focusOnWidget

)

[protected, virtual]

Focus or unfocus widget implementation.

Implements SO3::SWidget.

Definition at line 177 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::SetKeyboardEnableImpl

(

bool

enableKeyboardOnWidget

)

[protected, virtual]

Implements SO3::SWidget.

Definition at line 191 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::SetMouseEnableImpl

(

bool

enableMouseOnWidget

)

[protected, virtual]

Enable mouse input on widget.

Implements SO3::SWidget.

Definition at line 196 of file SO3BitmapWidget.cpp.

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

Implements SO3::SWidget.

Definition at line 201 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::SetTransparencyImpl

(

bool

enableTransparency

)

[protected, virtual]

Implements SO3::SWidget.

Definition at line 182 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::UpdateRawData	(	PtrObjBitmap	scolBitmap,
		PtrObjBitmap	scolAlphaBitmap
	)

Blit a scol alpha bitmap in the widget area

Definition at line 115 of file SO3BitmapWidget.cpp.

void SO3::SBitmapWidget::UpdateRawData

(

PtrObjBitmap

scolBitmap

)

Blit a scol bitmap in the widget area

Definition at line 89 of file SO3BitmapWidget.cpp.

---

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

• SO3Engine/SO3Renderer/SO3BitmapWidget.h
• SO3Engine/SO3Renderer/SO3BitmapWidget.cpp