torque Torque Game Engine Documentation
TGE Version 1.5.2

GuiEffectCanvas Class Reference

#include <guiEffectCanvas.h>

Inheritance diagram for GuiEffectCanvas:

Inheritance graph
[legend]

Public Member Functions

 DECLARE_CONOBJECT (GuiEffectCanvas)
 GuiEffectCanvas ()
 ~GuiEffectCanvas ()
virtual void renderFrame (bool preRenderOnly, bool bufferSwap=true)
 Repaints the dirty regions of the canvas.
virtual void canvasResized ()
virtual void setContentControl (GuiControl *gui)
 This sets the content control to something different.
virtual void processTick ()
 This method is called once every 32ms if isProcessingTicks returns true when called on the object.
virtual void interpolateTick (F32 delta)
 This method is called every frame and lets the control interpolate between ticks so you can smooth things as long as isProcessingTicks returns true when it is called on the object.
virtual void advanceTime (F32 timeDelta)
 This method is called once every frame regardless of the return value of isProcessingTicks and informs the object of the passage of time.

Protected Attributes

bool mEffectInProgress
bool mVisualizeField
bool mUpdateFeedbackTexture
bool mStartEffect
U32 mEffectTickCount
VectorFieldmVectorField
DynamicTexture mFeedbackTexture
ColorF mClearColor
Point2I mLastSize

Private Types

typedef GuiCanvas Parent

Member Typedef Documentation

Reimplemented from GuiCanvas.


Constructor & Destructor Documentation

GuiEffectCanvas::GuiEffectCanvas (  ) 

GuiEffectCanvas::~GuiEffectCanvas (  ) 


Member Function Documentation

GuiEffectCanvas::DECLARE_CONOBJECT ( GuiEffectCanvas   ) 

virtual void GuiEffectCanvas::renderFrame ( bool  preRenderOnly,
bool  bufferSwap = true 
) [virtual]

Repaints the dirty regions of the canvas.

Parameters:
preRenderOnly If set to true, only the onPreRender methods of all the GuiControls will be called
bufferSwap If set to true, it will swap buffers at the end. This is to support canvas-subclassing.

Reimplemented from GuiCanvas.

virtual void GuiEffectCanvas::canvasResized (  )  [virtual]

virtual void GuiEffectCanvas::setContentControl ( GuiControl gui  )  [virtual]

This sets the content control to something different.

Parameters:
gui New content control

Reimplemented from GuiCanvas.

virtual void GuiEffectCanvas::processTick (  )  [virtual]

This method is called once every 32ms if isProcessingTicks returns true when called on the object.

Implements ITickable.

virtual void GuiEffectCanvas::interpolateTick ( F32  delta  )  [inline, virtual]

This method is called every frame and lets the control interpolate between ticks so you can smooth things as long as isProcessingTicks returns true when it is called on the object.

Implements ITickable.

virtual void GuiEffectCanvas::advanceTime ( F32  timeDelta  )  [inline, virtual]

This method is called once every frame regardless of the return value of isProcessingTicks and informs the object of the passage of time.

Implements ITickable.


Field Documentation




All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen