SO3::SWebNavigatorWidget Class Reference

#include <SO3WebNavigatorWidget.h>

Inheritance diagram for SO3::SWebNavigatorWidget:

Public Member Functions
	SWebNavigatorWidget (SScene *targetScene, const std::string &webNavigatorName, const int &xPos, const int &yPos, const unsigned short &widgetWidth, const unsigned short &widgetHeight, SViewPort *targetViewport, const unsigned int &widgetZOrder)
	SWebNavigatorWidget (SScene *targetScene, const std::string &webNavigatorName, const int &xPos, const int &yPos, const unsigned short &widgetWidth, const unsigned short &widgetHeight, SViewPort *targetViewport)
	SWebNavigatorWidget (SScene *targetScene, const std::string &webNavigatorName, const unsigned short &widgetWidth, const unsigned short &widgetHeight, SMaterial *targetMaterial, const unsigned short &targetTechnique, const unsigned short &targetPass, const unsigned short &targetTextureUnit)
	~SWebNavigatorWidget ()
virtual void	LoadURL (const std::string &url)
virtual void	LoadFile (const std::string &file)
void	LoadHTML (const std::string &html)
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	InjectMouseUp (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	InjectKeyEvent (const UINT &msg, const ScolWindowHandle &hwnd, const WPARAM &wParam, const LPARAM &lParam)
virtual void	InjectTextEvent (const std::string &utf8)
void	Update (const bool &forceUpdate)
virtual void	RunScriptFunction (const std::string &functionName, const std::vector< std::string > &argumentList)
virtual HCURSOR	GetCurrentMouseCursor ()
void	_SetCurrentMouseCursor (const HCURSOR &newCursor)
bool	CanGoBack ()
void	GoBack ()
bool	CanGoForward ()
void	GoForward ()
void	Reload ()
void	ReloadIgnoreCache ()
void	StopLoad ()
void	Find (const int &identifier, const std::string &searchText, const bool &forward, const bool &matchCase, const bool &findNext)
void	StopFinding (const bool &clearSelection)
float	GetZoomLevel ()
void	SetZoomLevel (const float &zoomLevel)
void	ClearHistory ()
void	ShowDevTools ()
void	CloseDevTools ()
std::string	GetURL (const std::string &frameName="")
void	Undo (const std::string &frameName="")
void	Redo (const std::string &frameName="")
void	Cut (const std::string &frameName="")
void	Copy (const std::string &frameName="")
void	Paste (const std::string &frameName="")
void	Delete (const std::string &frameName="")
void	SelectAll (const std::string &frameName="")
void	Print (const std::string &frameName="")
void	ViewSource (const std::string &frameName="")
std::string	GetSource (const std::string &frameName="")
std::string	GetText (const std::string &frameName="")
Public Member Functions inherited from SO3::SWidget
	SWidget (SScene *targetScene, const std::string &widgetName, const int &xPos, const int &yPos, const unsigned short &widgetWidth, const unsigned short &widgetHeight, SViewPort *targetViewport, const unsigned int &widgetZOrder, const std::string &widgetType)
	SWidget (SScene *targetScene, const std::string &widgetName, const int &xPos, const int &yPos, const unsigned short &widgetWidth, const unsigned short &widgetHeight, SViewPort *targetViewport, const std::string &widgetType)
	SWidget (SScene *targetScene, const std::string &widgetName, const unsigned short &widgetWidth, const unsigned short &widgetHeight, SMaterial *targetMaterial, const unsigned short &targetTechnique, const unsigned short &targetPass, const unsigned short &targetTextureUnit, const std::string &widgetType)
virtual	~SWidget ()
SScene *	GetParentScene ()
std::string	GetType ()
unsigned short	GetWidth ()
unsigned short	GetHeight ()
SPoint< unsigned short >	GetSize ()
void	SetSize (const unsigned short &newWidth, const unsigned short &newHeight)
void	SetSize (const SPoint< unsigned short > &newSize)
float	GetTextureRatio ()
void	SetTextureRatio (const float &newRatio)
bool	GetIsStereo ()
void	SetStereo (StereoMode state)
void	SetStereoEye (bool isleft=true)
SPoint< int >	GetPosition ()
void	SetPosition (const int &xPos, const int &yPos)
void	SetPosition (const SPoint< int > &newPosition)
void	Move (const SPoint< int > &relativeMove)
void	SetCurrentViewport (Ogre::Viewport *vp)
void	SetScale (const float width, const float height)
SPoint< float >	GetScale ()
void	SetLeftOffset (const float left)
void	SetTopOffset (const float top)
SPoint< int >	GetRealPixelPosition ()
SPoint< unsigned short >	GetRealPixelSize ()
void	Show (const bool &fade=false, const unsigned short &fadeDurationMS=300)
void	Hide (const bool &fade=false, const unsigned short &fadeDurationMS=300)
bool	GetVisible ()
void	SetTransparency (const bool &enableTransparency)
bool	GetTransparency ()
void	SetOpacity (const float &widgetOpacity)
float	GetOpacity ()
void	SetIgnoreTransparentPixels (const bool &widgetIgnoreTransparentPixels, const float &tresholdColor=0.0f)
bool	GetIgnoreTransparentPixels ()
float	GetIgnoreTransparentPixelsTreshold ()
void	SetZOrder (const unsigned short &newWidgetOrder)
unsigned short	GetZOrder ()
void	TakeFocus ()
void	ReleaseFocus ()
bool	HasFocus ()
void	SetKeyboardEnable (const bool &enableKeyboardOnWidget)
bool	GetKeyboardEnable ()
void	SetMouseEnable (const bool &enableMouseOnWidget)
bool	GetMouseEnable ()
bool	GetMouseOver ()
bool	GetInputOver (int id)
void	SetInputOver (int id, bool state)
void	SetForeground (const bool &enableWidgetForeground)
bool	GetForeground ()
void	SetTopOnFocus (const bool &enableWidgetTopOnFocus)
bool	GetTopOnFocus ()
virtual void	loadResource (Ogre::Resource *resource)
bool	GetUpdateOnFocusOnly ()
void	SetUpdateOnFocusOnly (const bool &activate)
bool	GetIsOverlayed ()
bool	GetIs2DRect ()
Public Member Functions inherited from SO3::SData
	SData (const std::string &dataName)
virtual	~SData ()
std::string	GetName () const
SUserObjectBindings &	GetUserObjectBindings ()
const SUserObjectBindings &	GetUserObjectBindings () const

Additional Inherited Members
Public Types inherited from SO3::SWidget
enum	StereoMode { MONO = 0 , SBS = 1 , TB = 2 , BT = 3 }
Public Attributes inherited from SO3::SWidget
friend	SWidgetManager
Protected Member Functions inherited from SO3::SWidget
bool	IsCompensateNPOT () const
void	CreateTexture (bool alpha=true)
std::string	CheckUrl (const std::string &url)
Protected Attributes inherited from SO3::SWidget
std::string	baseResourceName
int	leftPos
int	topPos
float	leftOffset
float	topOffset
unsigned short	width
unsigned short	height
unsigned short	mTextureWidth
	The actual texture width allocated in ogre.
unsigned short	mTextureHeight
	The actual texture height allocated in ogre.
float	textureRatio
	Texture ratio compared to widget size, usually 1.0.
SScene *	scene
SViewPort *	viewport
Ogre::Viewport *	currentViewport
Ogre::TexturePtr	renderingTexture
bool	forceRenderingUpdate
float	transparentTresholdColor
bool	compensateNPOT
	Use to indicate if the texture size has be rounded to an exact pow2.
Ogre::Vector2	xCoef
Ogre::Vector2	yCoef
Protected Attributes inherited from SO3::SData
std::string	name

Detailed Description

Definition at line 90 of file SO3WebNavigatorWidget.h.

Constructor & Destructor Documentation

SWebNavigatorWidget() [1/3]

SO3::SWebNavigatorWidget::SWebNavigatorWidget	(	SScene *	targetScene,
		const std::string &	webNavigatorName,
		const int &	xPos,
		const int &	yPos,
		const unsigned short &	widgetWidth,
		const unsigned short &	widgetHeight,
		SViewPort *	targetViewport,
		const unsigned int &	widgetZOrder
	)

Definition at line 75 of file SO3WebNavigatorWidget.cpp.

SWebNavigatorWidget() [2/3]

SO3::SWebNavigatorWidget::SWebNavigatorWidget	(	SScene *	targetScene,
		const std::string &	webNavigatorName,
		const int &	xPos,
		const int &	yPos,
		const unsigned short &	widgetWidth,
		const unsigned short &	widgetHeight,
		SViewPort *	targetViewport
	)

Definition at line 80 of file SO3WebNavigatorWidget.cpp.

SWebNavigatorWidget() [3/3]

SO3::SWebNavigatorWidget::SWebNavigatorWidget	(	SScene *	targetScene,
		const std::string &	webNavigatorName,
		const unsigned short &	widgetWidth,
		const unsigned short &	widgetHeight,
		SMaterial *	targetMaterial,
		const unsigned short &	targetTechnique,
		const unsigned short &	targetPass,
		const unsigned short &	targetTextureUnit
	)

Definition at line 85 of file SO3WebNavigatorWidget.cpp.

~SWebNavigatorWidget()

SO3::SWebNavigatorWidget::~SWebNavigatorWidget

(

)

Definition at line 102 of file SO3WebNavigatorWidget.cpp.

Member Function Documentation

_SetCurrentMouseCursor()

void SO3::SWebNavigatorWidget::_SetCurrentMouseCursor

(

const HCURSOR &

newCursor

)

Internal use only! Do not call directly!

Definition at line 466 of file SO3WebNavigatorWidget.cpp.

CanGoBack()

bool SO3::SWebNavigatorWidget::CanGoBack

(

)

Definition at line 293 of file SO3WebNavigatorWidget.cpp.

CanGoForward()

bool SO3::SWebNavigatorWidget::CanGoForward

(

)

Definition at line 307 of file SO3WebNavigatorWidget.cpp.

ClearHistory()

void SO3::SWebNavigatorWidget::ClearHistory

(

)

Definition at line 365 of file SO3WebNavigatorWidget.cpp.

CloseDevTools()

void SO3::SWebNavigatorWidget::CloseDevTools

(

)

Definition at line 377 of file SO3WebNavigatorWidget.cpp.

Copy()

void SO3::SWebNavigatorWidget::Copy

(

const std::string &

frameName = ""

)

Definition at line 409 of file SO3WebNavigatorWidget.cpp.

Cut()

void SO3::SWebNavigatorWidget::Cut

(

const std::string &

frameName = ""

)

Definition at line 403 of file SO3WebNavigatorWidget.cpp.

Delete()

void SO3::SWebNavigatorWidget::Delete

(

const std::string &

frameName = ""

)

Definition at line 421 of file SO3WebNavigatorWidget.cpp.

Find()

void SO3::SWebNavigatorWidget::Find	(	const int &	identifier,
		const std::string &	searchText,
		const bool &	forward,
		const bool &	matchCase,
		const bool &	findNext
	)

Definition at line 339 of file SO3WebNavigatorWidget.cpp.

GetCurrentMouseCursor()

HCURSOR SO3::SWebNavigatorWidget::GetCurrentMouseCursor ( )

virtual

Optionnal function for widget that support it.

Reimplemented from SO3::SWidget.

Definition at line 461 of file SO3WebNavigatorWidget.cpp.

GetSource()

std::string SO3::SWebNavigatorWidget::GetSource

(

const std::string &

frameName = ""

)

Definition at line 445 of file SO3WebNavigatorWidget.cpp.

GetText()

std::string SO3::SWebNavigatorWidget::GetText

(

const std::string &

frameName = ""

)

Definition at line 453 of file SO3WebNavigatorWidget.cpp.

GetURL()

std::string SO3::SWebNavigatorWidget::GetURL

(

const std::string &

frameName = ""

)

Definition at line 383 of file SO3WebNavigatorWidget.cpp.

GetZoomLevel()

float SO3::SWebNavigatorWidget::GetZoomLevel

(

)

Definition at line 351 of file SO3WebNavigatorWidget.cpp.

GoBack()

void SO3::SWebNavigatorWidget::GoBack

(

)

Definition at line 301 of file SO3WebNavigatorWidget.cpp.

GoForward()

void SO3::SWebNavigatorWidget::GoForward

(

)

Definition at line 315 of file SO3WebNavigatorWidget.cpp.

InjectKeyEvent()

void SO3::SWebNavigatorWidget::InjectKeyEvent ( const UINT &  msg, const ScolWindowHandle &  hwnd, const WPARAM &  wParam, const LPARAM &  lParam  )

virtual

Implements SO3::SWidget.

Definition at line 199 of file SO3WebNavigatorWidget.cpp.

InjectMouseDown()

void SO3::SWebNavigatorWidget::InjectMouseDown ( const int &  xPos, const int &  yPos, const 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 172 of file SO3WebNavigatorWidget.cpp.

InjectMouseMove()

void SO3::SWebNavigatorWidget::InjectMouseMove ( const int &  xPos, const int &  yPos, const 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 160 of file SO3WebNavigatorWidget.cpp.

InjectMouseUp()

void SO3::SWebNavigatorWidget::InjectMouseUp ( const int &  xPos, const int &  yPos, const 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 178 of file SO3WebNavigatorWidget.cpp.

InjectMouseWheel()

void SO3::SWebNavigatorWidget::InjectMouseWheel ( const int &  scrollX, const int &  scrollY, const 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 166 of file SO3WebNavigatorWidget.cpp.

InjectTextEvent()

void SO3::SWebNavigatorWidget::InjectTextEvent ( const std::string &  utf8 )

virtual

Implements SO3::SWidget.

Definition at line 205 of file SO3WebNavigatorWidget.cpp.

InjectTouchAdd()

void SO3::SWebNavigatorWidget::InjectTouchAdd ( const int &  xPos, const int &  yPos, const int &  touchid  )

virtual

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

Parameters

xPos	The X-coordinate of the touch point, relative to this Widget's origin.
yPos	The Y-coordinate of the touch point, relative to this Widget's origin.
touchid	the touch id

Implements SO3::SWidget.

Definition at line 184 of file SO3WebNavigatorWidget.cpp.

InjectTouchRemove()

void SO3::SWebNavigatorWidget::InjectTouchRemove ( const int &  touchid )

virtual

Injects touch remove down events into this Widget.

Parameters

touchid

the touch id

Implements SO3::SWidget.

Definition at line 189 of file SO3WebNavigatorWidget.cpp.

InjectTouchUpdate()

void SO3::SWebNavigatorWidget::InjectTouchUpdate ( const int &  xPos, const int &  yPos, const int &  vx, const int &  vy, const int &  touchid  )

virtual

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

Parameters

xPos	The X-coordinate of the touch point, relative to this Widget's origin.
yPos	The Y-coordinate of the touch point, relative to this Widget's origin.
vx	The X last move distance of the touch point, relative to this Widget's origin.
vy	The Y last move distance of the touch point, relative to this Widget's origin.
touchid	the touch id

Implements SO3::SWidget.

Definition at line 194 of file SO3WebNavigatorWidget.cpp.

LoadFile()

void SO3::SWebNavigatorWidget::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 148 of file SO3WebNavigatorWidget.cpp.

LoadHTML()

void SO3::SWebNavigatorWidget::LoadHTML

(

const std::string &

html

)

Definition at line 154 of file SO3WebNavigatorWidget.cpp.

LoadURL()

void SO3::SWebNavigatorWidget::LoadURL ( const std::string &  url )

virtual

Implements SO3::SWidget.

Definition at line 142 of file SO3WebNavigatorWidget.cpp.

Paste()

void SO3::SWebNavigatorWidget::Paste

(

const std::string &

frameName = ""

)

Definition at line 415 of file SO3WebNavigatorWidget.cpp.

Print()

void SO3::SWebNavigatorWidget::Print

(

const std::string &

frameName = ""

)

Definition at line 433 of file SO3WebNavigatorWidget.cpp.

Redo()

void SO3::SWebNavigatorWidget::Redo

(

const std::string &

frameName = ""

)

Definition at line 397 of file SO3WebNavigatorWidget.cpp.

Reload()

void SO3::SWebNavigatorWidget::Reload

(

)

Definition at line 321 of file SO3WebNavigatorWidget.cpp.

ReloadIgnoreCache()

void SO3::SWebNavigatorWidget::ReloadIgnoreCache

(

)

Definition at line 327 of file SO3WebNavigatorWidget.cpp.

RunScriptFunction()

void SO3::SWebNavigatorWidget::RunScriptFunction ( const std::string &  functionName, const std::vector< std::string > &  argumentList  )

virtual

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

Implements SO3::SWidget.

Definition at line 264 of file SO3WebNavigatorWidget.cpp.

SelectAll()

void SO3::SWebNavigatorWidget::SelectAll

(

const std::string &

frameName = ""

)

Definition at line 427 of file SO3WebNavigatorWidget.cpp.

SetZoomLevel()

void SO3::SWebNavigatorWidget::SetZoomLevel

(

const float &

zoomLevel

)

Definition at line 359 of file SO3WebNavigatorWidget.cpp.

ShowDevTools()

void SO3::SWebNavigatorWidget::ShowDevTools

(

)

Definition at line 371 of file SO3WebNavigatorWidget.cpp.

StopFinding()

void SO3::SWebNavigatorWidget::StopFinding

(

const bool &

clearSelection

)

Definition at line 345 of file SO3WebNavigatorWidget.cpp.

StopLoad()

void SO3::SWebNavigatorWidget::StopLoad

(

)

Definition at line 333 of file SO3WebNavigatorWidget.cpp.

Undo()

void SO3::SWebNavigatorWidget::Undo

(

const std::string &

frameName = ""

)

Definition at line 391 of file SO3WebNavigatorWidget.cpp.

Update()

void SO3::SWebNavigatorWidget::Update

(

const bool &

forceUpdate

)

Definition at line 239 of file SO3WebNavigatorWidget.cpp.

ViewSource()

void SO3::SWebNavigatorWidget::ViewSource

(

const std::string &

frameName = ""

)

Definition at line 439 of file SO3WebNavigatorWidget.cpp.

---

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

• include/SO3Renderer/SO3WebNavigatorWidget.h
• src/SO3Renderer/SO3WebNavigatorWidget.cpp