VRS::TEXT::ScreenOverlay Class Reference

A SceneThing for putting thing directly on the Screen like an overlay. More...

#include <vrs/text/screenoverlay.h>

Inheritance diagram for VRS::TEXT::ScreenOverlay:

List of all members.

Public Member Functions
	ScreenOverlay (SO< Canvas > canvas, SO< SceneThing > parent=NULL)
	Constructor.
virtual	~ScreenOverlay ()
	Destructor.
OverlayInfo	addShape (SO< Shape > shape, int zValue=0, const UniformValue &xPos=UniformValue::ZERO, const UniformValue &yPos=UniformValue::ZERO, const UniformValue &xSize=UniformValue::UNIT, const UniformValue &ySize=UniformValue::UNIT)
	Adds any Shape at the given Position with the given Scale.
OverlayInfo	addTextureText (SO< TextureText > tt, int zValue=0, const UniformValue &xPos=UniformValue::ZERO, const UniformValue &yPos=UniformValue::ZERO)
	Adds a TextureText at the given Position and scales matching the screen.
OverlayInfo	addSimplePanel (SO< SimplePanel > pan, int zValue=0, const UniformValue &xPos=UniformValue::ZERO, const UniformValue &yPos=UniformValue::ZERO)
	Adds a SimplePanel at the given Position and scales matching the screen.
OverlayInfo	getOverlayElementInfo (SO< Shape > so) const
	Returns the OverlayInfo for later changes - don't forget to update!
void	update ()
	Rebuilds everythings - must be called if scaling/size changed.
	VRS_TYPEINFO (ScreenOverlay, SceneThing)

---

Detailed Description

A SceneThing for putting thing directly on the Screen like an overlay.

---

Constructor & Destructor Documentation

VRS::TEXT::ScreenOverlay::ScreenOverlay	(	SO< Canvas >	canvas,
		SO< SceneThing >	parent = NULL
	)

Constructor.

virtual VRS::TEXT::ScreenOverlay::~ScreenOverlay

(

)

[virtual]

Destructor.

---

Member Function Documentation

OverlayInfo VRS::TEXT::ScreenOverlay::addShape	(	SO< Shape >	shape,
		int	zValue = 0,
		const UniformValue &	xPos = UniformValue::ZERO,
		const UniformValue &	yPos = UniformValue::ZERO,
		const UniformValue &	xSize = UniformValue::UNIT,
		const UniformValue &	ySize = UniformValue::UNIT
	)

Adds any Shape at the given Position with the given Scale.

OverlayInfo VRS::TEXT::ScreenOverlay::addTextureText	(	SO< TextureText >	tt,
		int	zValue = 0,
		const UniformValue &	xPos = UniformValue::ZERO,
		const UniformValue &	yPos = UniformValue::ZERO
	)

Adds a TextureText at the given Position and scales matching the screen.

OverlayInfo VRS::TEXT::ScreenOverlay::addSimplePanel	(	SO< SimplePanel >	pan,
		int	zValue = 0,
		const UniformValue &	xPos = UniformValue::ZERO,
		const UniformValue &	yPos = UniformValue::ZERO
	)

Adds a SimplePanel at the given Position and scales matching the screen.

OverlayInfo VRS::TEXT::ScreenOverlay::getOverlayElementInfo

(

SO< Shape >

so

)

const

Returns the OverlayInfo for later changes - don't forget to update!

void VRS::TEXT::ScreenOverlay::update

(

)

Rebuilds everythings - must be called if scaling/size changed.

VRS::TEXT::ScreenOverlay::VRS_TYPEINFO	(	ScreenOverlay	,
		SceneThing
	)

---

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

• screenoverlay.h