Crazy Eddie's GUI System  ${CEGUI_VERSION}
WobblyWindowEffect Class Reference
+ Inheritance diagram for WobblyWindowEffect:
+ Collaboration diagram for WobblyWindowEffect:

Public Member Functions

 WobblyWindowEffect (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 Member Functions

void syncPivots (CEGUI::RenderingWindow &window)
 

Protected Attributes

CEGUI::Vector2f d_pivots [ds_xPivotCount][ds_yPivotCount]
 
CEGUI::Vector2f d_pivotVelocities [ds_xPivotCount][ds_yPivotCount]
 
bool d_initialised
 
CEGUI::Vertex d_vertices [ds_vertexCount]
 
CEGUI::FrameWindowd_window
 

Static Protected Attributes

static const int ds_xPivotCount = 11
 
static const int ds_yPivotCount = 11
 
static const unsigned int ds_vertexCount = (ds_xPivotCount - 1) * (ds_yPivotCount - 1) * 6
 

Member Function Documentation

int WobblyWindowEffect::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 WobblyWindowEffect::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 WobblyWindowEffect::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
passIndicates 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 WobblyWindowEffect::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
windowThe RenderingWindow object that is being processed.
geometryGeometryBuffer 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::Texture::getTexelScaling(), CEGUI::TextureTarget::getTexture(), CEGUI::RenderingWindow::getTextureTarget(), CEGUI::TextureTarget::isRenderingInverted(), and CEGUI::GeometryBuffer::setActiveTexture().

bool WobblyWindowEffect::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
elapsedThe number of seconds that have elapsed since the last time this function was called.
windowRenderingWindow 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::RenderingWindow::getPosition(), and CEGUI::RenderingWindow::getSize().