Lugre::cColourClipPaneOverlay Class Reference

#include <lugre_ColourClipPaneOverlay.h>

Inheritance diagram for Lugre::cColourClipPaneOverlay:

Collaboration diagram for Lugre::cColourClipPaneOverlay:

List of all members.

Public Member Functions

cColourClipPaneOverlay (const Ogre::String &name)

virtual ~cColourClipPaneOverlay ()

virtual void initialise (void)

virtual void setColour (const Ogre::ColourValue &col)

virtual void SetColours (const Ogre::ColourValue colLT, const Ogre::ColourValue colRT, const Ogre::ColourValue colLB, const Ogre::ColourValue colRB)

virtual void SetTexCoords (const Ogre::Real fU1, const Ogre::Real fV1, const Ogre::Real fU2, const Ogre::Real fV2)

u1,v1 is left top u2,v2 is right bottom

virtual void SetClip (const Ogre::Real fCL, const Ogre::Real fCT, const Ogre::Real fCW, const Ogre::Real fCH)

dependant on metrics mode.

void setTransparent (bool isTransparent)

Sets whether this panel is transparent (used only as a grouping level), or if it is actually renderred. mTransparent = isTransparent;.

bool isTransparent (void) const

virtual const Ogre::String & getTypeName (void) const

void getRenderOperation (Ogre::RenderOperation &op)

void setMaterialName (const Ogre::String &matName)

void _updateRenderQueue (Ogre::RenderQueue *queue)

virtual void updatePositionGeometry (void)

internal method for setting up geometry, called by OverlayElement::update

virtual void updateTextureGeometry (void)

Called to update the texture coords when layers change.

void addBaseParameters (void)

Method for setting up base parameters for this class.

Static Public Member Functions

static void RegisterFactory ()

should be called once at programmstart after initialising ogre::root

Public Attributes

Ogre::RenderOperation mRenderOp

bool mTransparent

bool mbClipInitialized

VertexRect mForm

Ogre::Rectangle mClip

in the current MetricsMode, default : GMM_PIXELS

Static Public Attributes

static Ogre::String msTypeName = "ColourClipPane"

Classes

struct Vertex

struct VertexRect

Detailed Description

Definition at line 38 of file lugre_ColourClipPaneOverlay.h.

Constructor & Destructor Documentation

Lugre::cColourClipPaneOverlay::cColourClipPaneOverlay ( const Ogre::String & name )

Definition at line 151 of file lugre_ColourClipPaneOverlay.cpp.

References mForm, Lugre::cColourClipPaneOverlay::VertexRect::SetCol(), and Lugre::cColourClipPaneOverlay::VertexRect::SetUV().

Lugre::cColourClipPaneOverlay::~cColourClipPaneOverlay ( ) [virtual]

Definition at line 160 of file lugre_ColourClipPaneOverlay.cpp.

References mRenderOp.

Member Function Documentation

void Lugre::cColourClipPaneOverlay::RegisterFactory ( ) [static]

should be called once at programmstart after initialising ogre::root

Reimplemented in Lugre::cBorderColourClipPaneOverlay, Lugre::cColourClipTextOverlay, and Lugre::cSortedOverlayContainer.

Definition at line 29 of file lugre_ColourClipPaneOverlay.cpp.

Referenced by Lugre::cOgreWrapper::CreateOgreWindow().

void Lugre::cColourClipPaneOverlay::initialise ( void ) [virtual]

Initialise

Reimplemented in Lugre::cBorderColourClipPaneOverlay.

Definition at line 166 of file lugre_ColourClipPaneOverlay.cpp.

Referenced by Lugre::cBorderColourClipPaneOverlay::initialise().

void Lugre::cColourClipPaneOverlay::setColour ( const Ogre::ColourValue & col ) [virtual]

Reimplemented in Lugre::cBorderColourClipPaneOverlay, and Lugre::cColourClipTextOverlay.

Definition at line 177 of file lugre_ColourClipPaneOverlay.cpp.

References SetColours().

void Lugre::cColourClipPaneOverlay::SetColours	(	const Ogre::ColourValue	colLT,
		const Ogre::ColourValue	colRT,
		const Ogre::ColourValue	colLB,
		const Ogre::ColourValue	colRB
	)			`[virtual]`

Reimplemented in Lugre::cBorderColourClipPaneOverlay.

Definition at line 181 of file lugre_ColourClipPaneOverlay.cpp.

References Lugre::cColourClipPaneOverlay::Vertex::col, Lugre::cColourClipPaneOverlay::VertexRect::lb, Lugre::cColourClipPaneOverlay::VertexRect::lt, mForm, Lugre::cColourClipPaneOverlay::VertexRect::rb, and Lugre::cColourClipPaneOverlay::VertexRect::rt.

Referenced by setColour(), and Lugre::cGfx2D::SetColours().

void Lugre::cColourClipPaneOverlay::SetTexCoords	(	const Ogre::Real	fU1,
		const Ogre::Real	fV1,
		const Ogre::Real	fU2,
		const Ogre::Real	fV2
	)			`[virtual]`

u1,v1 is left top u2,v2 is right bottom

Reimplemented in Lugre::cBorderColourClipPaneOverlay.

Definition at line 172 of file lugre_ColourClipPaneOverlay.cpp.

References mForm, and Lugre::cColourClipPaneOverlay::VertexRect::SetUV().

Referenced by Lugre::cGfx2D::SetUV().

void Lugre::cColourClipPaneOverlay::SetClip	(	const Ogre::Real	fCL,
		const Ogre::Real	fCT,
		const Ogre::Real	fCW,
		const Ogre::Real	fCH
	)			`[virtual]`

dependant on metrics mode.

Definition at line 190 of file lugre_ColourClipPaneOverlay.cpp.

References mbClipInitialized, and mClip.

Referenced by Lugre::cGfx2D::SetClip().

void Lugre::cColourClipPaneOverlay::setTransparent ( bool isTransparent )

Sets whether this panel is transparent (used only as a grouping level), or if it is actually renderred. mTransparent = isTransparent;.

Definition at line 200 of file lugre_ColourClipPaneOverlay.cpp.

References mTransparent.

bool Lugre::cColourClipPaneOverlay::isTransparent ( void ) const

Returns whether this panel is transparent.

Definition at line 206 of file lugre_ColourClipPaneOverlay.cpp.

References mTransparent.

const String & Lugre::cColourClipPaneOverlay::getTypeName ( void ) const [virtual]

See OverlayElement.

Reimplemented in Lugre::cBorderColourClipPaneOverlay, Lugre::cColourClipTextOverlay, and Lugre::cSortedOverlayContainer.

Definition at line 212 of file lugre_ColourClipPaneOverlay.cpp.

References msTypeName.

void Lugre::cColourClipPaneOverlay::getRenderOperation ( Ogre::RenderOperation & op )

See Renderable.

void Lugre::cColourClipPaneOverlay::setMaterialName ( const Ogre::String & matName )

Overridden from OverlayElement

void Lugre::cColourClipPaneOverlay::_updateRenderQueue ( Ogre::RenderQueue * queue )

Overridden from OverlayContainer

Reimplemented in Lugre::cBorderColourClipPaneOverlay.

void Lugre::cColourClipPaneOverlay::updatePositionGeometry ( void ) [virtual]

internal method for setting up geometry, called by OverlayElement::update

Reimplemented in Lugre::cBorderColourClipPaneOverlay, and Lugre::cColourClipTextOverlay.

Definition at line 247 of file lugre_ColourClipPaneOverlay.cpp.

References Lugre::cRobRenderOp::Begin(), Lugre::cColourClipPaneOverlay::VertexRect::DrawStrip(), Lugre::cRobRenderOp::End(), Lugre::cRobRenderOp::GetMaxZ(), Lugre::cColourClipPaneOverlay::VertexRect::Intersect(), mbClipInitialized, mClip, mForm, and Lugre::cColourClipPaneOverlay::VertexRect::SetLTWH().

void Lugre::cColourClipPaneOverlay::updateTextureGeometry ( void ) [virtual]

Called to update the texture coords when layers change.

Definition at line 302 of file lugre_ColourClipPaneOverlay.cpp.

void Lugre::cColourClipPaneOverlay::addBaseParameters ( void )

Method for setting up base parameters for this class.

Definition at line 305 of file lugre_ColourClipPaneOverlay.cpp.

Member Data Documentation

Ogre::RenderOperation Lugre::cColourClipPaneOverlay::mRenderOp

Definition at line 39 of file lugre_ColourClipPaneOverlay.h.

Referenced by ~cColourClipPaneOverlay().

String Lugre::cColourClipPaneOverlay::msTypeName = "ColourClipPane" [static]

Reimplemented in Lugre::cBorderColourClipPaneOverlay, Lugre::cColourClipTextOverlay, and Lugre::cSortedOverlayContainer.

Definition at line 40 of file lugre_ColourClipPaneOverlay.h.

Referenced by getTypeName(), and Lugre::ColourClipPaneOverlayElementFactory::getTypeName().

bool Lugre::cColourClipPaneOverlay::mTransparent

Definition at line 71 of file lugre_ColourClipPaneOverlay.h.

Referenced by Lugre::cColourClipTextOverlay::cColourClipTextOverlay(), isTransparent(), and setTransparent().

bool Lugre::cColourClipPaneOverlay::mbClipInitialized

Definition at line 72 of file lugre_ColourClipPaneOverlay.h.

Referenced by SetClip(), Lugre::cColourClipTextOverlay::updatePositionGeometry(), updatePositionGeometry(), and Lugre::cBorderColourClipPaneOverlay::updatePositionGeometry().

VertexRect Lugre::cColourClipPaneOverlay::mForm

Definition at line 73 of file lugre_ColourClipPaneOverlay.h.

Referenced by cColourClipPaneOverlay(), SetColours(), SetTexCoords(), and updatePositionGeometry().

Ogre::Rectangle Lugre::cColourClipPaneOverlay::mClip

in the current MetricsMode, default : GMM_PIXELS

Definition at line 74 of file lugre_ColourClipPaneOverlay.h.

Referenced by SetClip(), Lugre::cColourClipTextOverlay::updatePositionGeometry(), updatePositionGeometry(), and Lugre::cBorderColourClipPaneOverlay::updatePositionGeometry().

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

/var/www/sfz/trunk/lugre/include/lugre_ColourClipPaneOverlay.h
/var/www/sfz/trunk/lugre/src/lugre_ColourClipPaneOverlay.cpp


Public Member Functions
	cColourClipPaneOverlay (const Ogre::String &name)
virtual	~cColourClipPaneOverlay ()
virtual void	initialise (void)
virtual void	setColour (const Ogre::ColourValue &col)
virtual void	SetColours (const Ogre::ColourValue colLT, const Ogre::ColourValue colRT, const Ogre::ColourValue colLB, const Ogre::ColourValue colRB)
virtual void	SetTexCoords (const Ogre::Real fU1, const Ogre::Real fV1, const Ogre::Real fU2, const Ogre::Real fV2)
	u1,v1 is left top u2,v2 is right bottom
virtual void	SetClip (const Ogre::Real fCL, const Ogre::Real fCT, const Ogre::Real fCW, const Ogre::Real fCH)
	dependant on metrics mode.
void	setTransparent (bool isTransparent)
	Sets whether this panel is transparent (used only as a grouping level), or if it is actually renderred. mTransparent = isTransparent;.
bool	isTransparent (void) const
virtual const Ogre::String &	getTypeName (void) const
void	getRenderOperation (Ogre::RenderOperation &op)
void	setMaterialName (const Ogre::String &matName)
void	_updateRenderQueue (Ogre::RenderQueue *queue)
virtual void	updatePositionGeometry (void)
	internal method for setting up geometry, called by OverlayElement::update
virtual void	updateTextureGeometry (void)
	Called to update the texture coords when layers change.
void	addBaseParameters (void)
	Method for setting up base parameters for this class.
Static Public Member Functions
static void	RegisterFactory ()
	should be called once at programmstart after initialising ogre::root
Public Attributes
Ogre::RenderOperation	mRenderOp
bool	mTransparent
bool	mbClipInitialized
VertexRect	mForm
Ogre::Rectangle	mClip
	in the current MetricsMode, default : GMM_PIXELS
Static Public Attributes
static Ogre::String	msTypeName = "ColourClipPane"
Classes
struct	Vertex
struct	VertexRect