render::Overlay Class Reference

Represents a layer which is rendered on top of the 'normal' scene contents. More...

#include <Overlay.h>

Inheritance diagram for render::Overlay:

List of all members.

Public Member Functions
f32	getHeight ()
	Gets one of the relative dimensions of the overlay, a value between 0.0 and 1.0.
virtual Material *	getMaterial () const
	Gets the material which this mesh uses.
MetricsMode	getMetricsMode () const
	Gets the MetricsMode of this overlay.
void	getRenderOperation (RenderOperation &ro)
f32	getWidth ()
	Gets one of the relative dimensions of the overlay, a value between 0.0 and 1.0.
	Overlay (const std::string &name)
	Overlay ()
void	setDimension (f32 width, f32 height)
	Sets the dimension.
virtual void	setMetricsMode (MetricsMode mm)
	Sets the MetricsMode for this overlay.
void	setPosition (f32 x, f32 y)
	Sets the position.
virtual	~Overlay ()
Protected Member Functions
void	initProperties ()
void	updateImpl (f32 elapsedTime)
virtual void	updatePositionBinding ()=0
	Internal method for updating the positions of the element.
virtual void	updateTextureBinding ()=0
	Internal method for updating the UVs of the element.
void	updateWorldTransform ()
Protected Attributes
bool	mGeometryInitialized
bool	mGeomPositionsOutOfDate
	Flag indicating if the vertex positions need recalculating.
bool	mGeomUVsOutOfDate
	Flag indicating if the vertex uvs need recalculating.
f32	mHeight
IndexData *	mIndexData
	Face index data.
Material *	mMaterial
MetricsMode	mMetricsMode
bool	mModifiedWorldTransform
f32	mU1
f32	mU2
f32	mV1
f32	mV2
VertexData *	mVertexData
	Dedicated vertex data.
f32	mWidth
Static Protected Attributes
static u32	msNextGeneratedOverlayIndex = 0

---

Detailed Description

Represents a layer which is rendered on top of the 'normal' scene contents.

---

Constructor & Destructor Documentation

render::Overlay::Overlay

(

)

References initProperties(), render::Renderable::mRenderableType, and render::RT_OVERLAY.

render::Overlay::Overlay

(

const std::string &

name

)

References initProperties(), render::Renderable::mRenderableType, and render::RT_OVERLAY.

render::Overlay::~Overlay

(

)

[virtual]

References mIndexData, and mVertexData.

---

Member Function Documentation

f32 render::Overlay::getHeight

(

)

Gets one of the relative dimensions of the overlay, a value between 0.0 and 1.0.

References mHeight.

Material * render::Overlay::getMaterial

(

)

const [virtual]

Gets the material which this mesh uses.

Reimplemented from render::Renderable.

Reimplemented in render::TextOverlay.

References mMaterial.

Referenced by render::RenderManager::renderSingleOverlay().

MetricsMode render::Overlay::getMetricsMode

(

)

const

Gets the MetricsMode of this overlay.

References mMetricsMode.

Referenced by render::RenderManager::renderSingleOverlay().

void render::Overlay::getRenderOperation

(

RenderOperation &

ro

)

[virtual]

Reimplemented from render::Renderable.

References render::RenderOperation::indexData, mIndexData, mVertexData, render::RenderOperation::operationType, render::OT_TRIANGLE_LIST, render::RenderOperation::useIndexes, and render::RenderOperation::vertexData.

Referenced by render::RenderManager::renderSingleOverlay().

f32 render::Overlay::getWidth

(

)

Gets one of the relative dimensions of the overlay, a value between 0.0 and 1.0.

References mWidth.

Referenced by render::TextOverlay::updatePositionBinding().

void render::Overlay::initProperties

(

)

[protected]

Reimplemented from render::Renderable.

Reimplemented in render::TextOverlay.

References core::matrix4::IDENTITY, mGeometryInitialized, mGeomPositionsOutOfDate, mGeomUVsOutOfDate, mHeight, render::MM_RELATIVE, mMaterial, mMetricsMode, mModifiedWorldTransform, mU1, mU2, mV1, mV2, mWidth, and render::Renderable::mWorldMatrix.

Referenced by Overlay().

void render::Overlay::setDimension	(	f32	width,
		f32	height
	)

Sets the dimension.

References mGeomPositionsOutOfDate, mHeight, and mWidth.

Referenced by render::TextOverlay::updatePositionBinding().

void render::Overlay::setMetricsMode

(

MetricsMode

mm

)

[virtual]

Sets the MetricsMode for this overlay.

References mMetricsMode.

void render::Overlay::setPosition	(	f32	x,
		f32	y
	)

Sets the position.

References scene::Node::mModifiedAbsoluteTransform, scene::Node::mPosition, core::vector3d::X, and core::vector3d::Y.

void render::Overlay::updateImpl

(

f32

elapsedTime

)

[protected, virtual]

Reimplemented from scene::Node.

References mGeometryInitialized, mGeomPositionsOutOfDate, mGeomUVsOutOfDate, scene::Node::mModifiedAbsoluteTransform, mModifiedWorldTransform, updatePositionBinding(), updateTextureBinding(), and updateWorldTransform().

virtual void render::Overlay::updatePositionBinding

(

)

[protected, pure virtual]

Internal method for updating the positions of the element.

Implemented in render::PanelOverlay, and render::TextOverlay.

Referenced by updateImpl().

virtual void render::Overlay::updateTextureBinding

(

)

[protected, pure virtual]

Internal method for updating the UVs of the element.

Implemented in render::PanelOverlay, and render::TextOverlay.

Referenced by updateImpl().

void render::Overlay::updateWorldTransform

(

)

[protected]

References core::matrix4::IDENTITY, scene::Node::mAbsoluteOrientation, scene::Node::mAbsolutePosition, scene::Node::mAbsoluteScale, mModifiedWorldTransform, render::Renderable::mWorldMatrix, scene::Node::scale(), core::matrix4::setScale(), core::matrix4::setTranslation(), core::quaternion::toRotationMatrix(), and scene::Node::updateTransformImpl().

Referenced by updateImpl().

---

Member Data Documentation

bool render::Overlay::mGeometryInitialized [protected]

Referenced by render::TextOverlay::initializeImpl(), render::PanelOverlay::initializeImpl(), initProperties(), updateImpl(), and render::TextOverlay::updatePositionBinding().

bool render::Overlay::mGeomPositionsOutOfDate [protected]

Flag indicating if the vertex positions need recalculating.

Referenced by initProperties(), render::TextOverlay::setAlignment(), render::TextOverlay::setCaption(), render::TextOverlay::setCharHeight(), setDimension(), render::TextOverlay::setFont(), render::TextOverlay::setSpaceWidth(), updateImpl(), and render::TextOverlay::updateTransformImpl().

bool render::Overlay::mGeomUVsOutOfDate [protected]

Flag indicating if the vertex uvs need recalculating.

Referenced by initProperties(), render::TextOverlay::setCaption(), render::TextOverlay::setFont(), and updateImpl().

f32 render::Overlay::mHeight [protected]

Referenced by getHeight(), initProperties(), setDimension(), render::TextOverlay::updatePositionBinding(), and render::PanelOverlay::updatePositionBinding().

IndexData* render::Overlay::mIndexData [protected]

Face index data.

Referenced by render::TextOverlay::allocateMemory(), getRenderOperation(), render::TextOverlay::initializeImpl(), render::PanelOverlay::initializeImpl(), render::TextOverlay::updatePositionBinding(), and ~Overlay().

Material* render::Overlay::mMaterial [protected]

Referenced by getMaterial(), initProperties(), and render::PanelOverlay::setMaterial().

MetricsMode render::Overlay::mMetricsMode [protected]

Referenced by getMetricsMode(), initProperties(), render::TextOverlay::setCharHeight(), setMetricsMode(), render::TextOverlay::setSpaceWidth(), render::TextOverlay::updatePositionBinding(), and render::TextOverlay::updateTransformImpl().

bool render::Overlay::mModifiedWorldTransform [protected]

Referenced by initProperties(), updateImpl(), and updateWorldTransform().

u32 render::Overlay::msNextGeneratedOverlayIndex = 0 [static, protected]

f32 render::Overlay::mU1 [protected]

Referenced by initProperties(), and render::PanelOverlay::updateTextureBinding().

f32 render::Overlay::mU2 [protected]

Referenced by initProperties(), and render::PanelOverlay::updateTextureBinding().

f32 render::Overlay::mV1 [protected]

Referenced by initProperties(), and render::PanelOverlay::updateTextureBinding().

f32 render::Overlay::mV2 [protected]

Referenced by initProperties(), and render::PanelOverlay::updateTextureBinding().

VertexData* render::Overlay::mVertexData [protected]

Dedicated vertex data.

Referenced by render::TextOverlay::allocateMemory(), getRenderOperation(), render::TextOverlay::initializeImpl(), render::PanelOverlay::initializeImpl(), render::TextOverlay::updatePositionBinding(), render::PanelOverlay::updatePositionBinding(), render::PanelOverlay::updateTextureBinding(), and ~Overlay().

f32 render::Overlay::mWidth [protected]

Referenced by getWidth(), initProperties(), setDimension(), render::TextOverlay::updatePositionBinding(), and render::PanelOverlay::updatePositionBinding().

---

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

• E:/Programming/MyProject/K_Game_hg/GameEngine/include/render/Overlay.h
• E:/Programming/MyProject/K_Game_hg/GameEngine/src/render/Overlay.cpp