ElasticWindowEffect Class Reference

Inheritance diagram for ElasticWindowEffect:

Collaboration diagram for ElasticWindowEffect:

Public Member Functions
	ElasticWindowEffect (CEGUI::Window *window)
int	getPassCount () const
	Return the number of passes required by this effect. More...
void	performPreRenderFunctions (const int pass)
	Function called prior to RenderingWindow::draw being called. This is intended to be used for any required setup / state initialisation and is called once for each pass in the effect. More...
void	performPostRenderFunctions ()
	Function called after RenderingWindow::draw is called. This is intended to be used for any required cleanup / state restoration. This function is called once only, unlike performPreRenderFunctions which may be called multiple times; once for each pass in the effect. More...
bool	realiseGeometry (CEGUI::RenderingWindow &window, CEGUI::GeometryBuffer &geometry)
	Function called to generate geometry for the RenderingWindow. More...
bool	update (const float elapsed, CEGUI::RenderingWindow &window)
	Function called to perform any time based updates on the RenderEffect state. More...

Protected Attributes
CEGUI::Vector2f	d_currentPosition
CEGUI::Vector2f	d_currentVelocity
bool	d_initialised
CEGUI::Vertex	d_vertices [ds_vertexCount]
CEGUI::Window *	d_window

Static Protected Attributes
static const unsigned int	ds_vertexCount = 6

Member Function Documentation

int ElasticWindowEffect::getPassCount ( ) const

virtual

Return the number of passes required by this effect.

Returns

integer value indicating the number of rendering passes required to fully render this effect.

Implements CEGUI::RenderEffect.

void ElasticWindowEffect::performPostRenderFunctions ( )

virtual

Function called after RenderingWindow::draw is called. This is intended to be used for any required cleanup / state restoration. This function is called once only, unlike performPreRenderFunctions which may be called multiple times; once for each pass in the effect.

Note

Note that this function is called before any standard state cleanup that might be peformed by the Renderer module.

Implements CEGUI::RenderEffect.

void ElasticWindowEffect::performPreRenderFunctions ( const int  pass )

virtual

Function called prior to RenderingWindow::draw being called. This is intended to be used for any required setup / state initialisation and is called once for each pass in the effect.

Parameters

pass	Indicates the pass number to be initialised (starting at pass 0).

Note

Note that this function is called after any standard state initialisation that might be peformed by the Renderer module.

Implements CEGUI::RenderEffect.

bool ElasticWindowEffect::realiseGeometry ( CEGUI::RenderingWindow &  window, CEGUI::GeometryBuffer &  geometry  )

virtual

Function called to generate geometry for the RenderingWindow.

The geometry generated should be fully unclipped and window local. The origin for the geometry is located at the top-left corner.

Parameters

window	The RenderingWindow object that is being processed.
geometry	GeometryBuffer object where the generated geometry should be added. This object will be cleared before this function is invoked.

Returns

boolean value indicating whether the RenderingWindow should generate it's own geometry.

• true if the RenderingWindow should generate it's own geometry. You will usually only return true if you do not need to use custom geometry.
• false if you have added any required geometry needed to represent the RenderingWindow.

Implements CEGUI::RenderEffect.

References CEGUI::GeometryBuffer::appendGeometry(), CEGUI::RenderingWindow::getPosition(), CEGUI::RenderingWindow::getSize(), CEGUI::TextureTarget::getTexture(), CEGUI::RenderingWindow::getTextureTarget(), CEGUI::TextureTarget::isRenderingInverted(), and CEGUI::GeometryBuffer::setActiveTexture().

bool ElasticWindowEffect::update ( const float  elapsed, CEGUI::RenderingWindow &  window  )

virtual

Function called to perform any time based updates on the RenderEffect state.

Note

This function should only affect the internal state of the RenderEffect object. This function should definitely not be used to directly affect any render states of the underlying rendering API or engine.

Parameters

elapsed	The number of seconds that have elapsed since the last time this function was called.
window	RenderingWindow object that the RenderEffect is being applied to.

Returns

boolean that indicates whether the window geometry will still be valid after the update.

Implements CEGUI::RenderEffect.

References CEGUI::Element::addChild(), CEGUI::Combobox::addItem(), CEGUI::RenderEffectManager::create(), CEGUI::WindowManager::createWindow(), CEGUI::Combobox::EventListSelectionAccepted, CEGUI::Window::getChild(), CEGUI::GUIContext::getMouseCursor(), CEGUI::Window::getParent(), CEGUI::RenderingWindow::getPosition(), CEGUI::Window::getRenderingSurface(), CEGUI::Combobox::getSelectedItem(), CEGUI::WindowManager::loadLayoutFromFile(), CEGUI::FrameWindow::setCloseButtonEnabled(), CEGUI::GUIContext::setDefaultFont(), CEGUI::MouseCursor::setDefaultImage(), CEGUI::Combobox::setItemSelectState(), CEGUI::Element::setPosition(), CEGUI::PropertySet::setProperty(), CEGUI::RenderingWindow::setRenderEffect(), CEGUI::Element::setSize(), CEGUI::FrameWindow::setSizingEnabled(), CEGUI::Window::setText(), CEGUI::FrameWindow::setTitleBarEnabled(), CEGUI::EventSet::subscribeEvent(), and CEGUI::WindowEventArgs::window.