VoltAir
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Groups Pages
Static Public Attributes | Protected Member Functions | List of all members
ParticleRendererItem Class Reference

Graphic which renders LiquidFun particles as blobs with a variety of effects. More...

Inheritance diagram for ParticleRendererItem:
Graphic RenderableInterface QQuickItem QObject QQmlParserStatus

Static Public Attributes

static constexpr const int FBO_SIZE = 1024
 Width and height of the main frame buffer object used to render particles to. More...
 
static constexpr const int AUX_FBO_SIZE = 384
 Width and height of the secondary frame buffer object used to render fake specular lighting to. More...
 
static const float PARTICLE_SCALE
 Visual size of particles, relative to their physical size. More...
 

Protected Member Functions

virtual void render (RenderNode *node) override
 Implementation of RenderableInterface blending our frame buffers onto the current scene. More...
 
virtual void synchronizeForRendering (RenderList *renderList) override
 Synchronize and queue RenderNodes for rendering. More...
 
- Protected Member Functions inherited from Graphic
void getFlattenedRenderParameters (RenderParameters *parameters)
 Compute the rendering parameters and transform of this Graphic by moving up the QQuickItem tree and accumulating results. More...
 
- Protected Member Functions inherited from QQuickItem
virtual bool event (QEvent *ev)
 
bool isComponentComplete () const
 
virtual void itemChange (ItemChange change, const ItemChangeData &value)
 
void updateInputMethod (Qt::InputMethodQueries queries)
 
bool widthValid () const
 
bool heightValid () const
 
virtual void classBegin ()
 
virtual void componentComplete ()
 
virtual void keyPressEvent (QKeyEvent *event)
 
virtual void keyReleaseEvent (QKeyEvent *event)
 
virtual void inputMethodEvent (QInputMethodEvent *event)
 
virtual void focusInEvent (QFocusEvent *event)
 
virtual void focusOutEvent (QFocusEvent *event)
 
virtual void mousePressEvent (QMouseEvent *event)
 
virtual void mouseMoveEvent (QMouseEvent *event)
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 
virtual void mouseUngrabEvent ()
 
virtual void touchUngrabEvent ()
 
virtual void wheelEvent (QWheelEvent *event)
 
virtual void touchEvent (QTouchEvent *event)
 
virtual void hoverEnterEvent (QHoverEvent *event)
 
virtual void hoverMoveEvent (QHoverEvent *event)
 
virtual void hoverLeaveEvent (QHoverEvent *event)
 
virtual void dragEnterEvent (QDragEnterEvent *event)
 
virtual void dragMoveEvent (QDragMoveEvent *event)
 
virtual void dragLeaveEvent (QDragLeaveEvent *event)
 
virtual void dropEvent (QDropEvent *event)
 
virtual bool childMouseEventFilter (QQuickItem *item, QEvent *event)
 
virtual void geometryChanged (const QRectF &newGeometry, const QRectF &oldGeometry)
 
virtual QSGNodeupdatePaintNode (QSGNode *oldNode, UpdatePaintNodeData *updatePaintNodeData)
 
virtual void releaseResources ()
 
virtual void updatePolish ()
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 

Additional Inherited Members

- Public Member Functions inherited from Graphic
 Graphic (QQuickItem *parent=nullptr)
 Construct a Graphic. More...
 
- Public Member Functions inherited from QQuickItem
 QQuickItem (QQuickItem *parent)
 
QQuickWindowwindow () const
 
QQuickItemparentItem () const
 
void setParentItem (QQuickItem *parent)
 
void stackBefore (const QQuickItem *sibling)
 
void stackAfter (const QQuickItem *sibling)
 
QRectF childrenRect ()
 
QList< QQuickItem * > childItems () const
 
bool clip () const
 
void setClip (bool)
 
QString state () const
 
void setState (const QString &)
 
qreal baselineOffset () const
 
void setBaselineOffset (qreal)
 
qreal x () const
 
qreal y () const
 
void setX (qreal)
 
void setY (qreal)
 
qreal width () const
 
void setWidth (qreal)
 
void resetWidth ()
 
void setImplicitWidth (qreal)
 
qreal implicitWidth () const
 
qreal height () const
 
void setHeight (qreal)
 
void resetHeight ()
 
void setImplicitHeight (qreal)
 
qreal implicitHeight () const
 
TransformOrigin transformOrigin () const
 
void setTransformOrigin (TransformOrigin)
 
qreal z () const
 
void setZ (qreal)
 
qreal rotation () const
 
void setRotation (qreal)
 
qreal scale () const
 
void setScale (qreal)
 
qreal opacity () const
 
void setOpacity (qreal)
 
bool isVisible () const
 
void setVisible (bool)
 
bool isEnabled () const
 
void setEnabled (bool)
 
bool smooth () const
 
void setSmooth (bool)
 
bool activeFocusOnTab () const
 
void setActiveFocusOnTab (bool)
 
bool antialiasing () const
 
void setAntialiasing (bool)
 
void resetAntialiasing ()
 
Flags flags () const
 
void setFlag (Flag flag, bool enabled)
 
void setFlags (QFlags< QQuickItem::Flag > flags)
 
bool hasActiveFocus () const
 
bool hasFocus () const
 
void setFocus (bool)
 
void setFocus (bool focus, Qt::FocusReason reason)
 
bool isFocusScope () const
 
QQuickItemscopedFocusItem () const
 
Qt::MouseButtons acceptedMouseButtons () const
 
void setAcceptedMouseButtons (Qt::MouseButtons buttons)
 
bool acceptHoverEvents () const
 
void setAcceptHoverEvents (bool enabled)
 
QCursor cursor () const
 
void setCursor (const QCursor &cursor)
 
void unsetCursor ()
 
void grabMouse ()
 
void ungrabMouse ()
 
bool keepMouseGrab () const
 
void setKeepMouseGrab (bool keep)
 
bool filtersChildMouseEvents () const
 
void setFiltersChildMouseEvents (bool filter)
 
void grabTouchPoints (const QVector< int > &ids)
 
void ungrabTouchPoints ()
 
bool keepTouchGrab () const
 
void setKeepTouchGrab (bool keep)
 
virtual bool contains (const QPointF &point) const
 
QPointF mapToItem (const QQuickItem *item, const QPointF &point) const
 
QPointF mapToScene (const QPointF &point) const
 
QRectF mapRectToItem (const QQuickItem *item, const QRectF &rect) const
 
QRectF mapRectToScene (const QRectF &rect) const
 
QPointF mapFromItem (const QQuickItem *item, const QPointF &point) const
 
QPointF mapFromScene (const QPointF &point) const
 
QRectF mapRectFromItem (const QQuickItem *item, const QRectF &rect) const
 
QRectF mapRectFromScene (const QRectF &rect) const
 
void polish ()
 
void forceActiveFocus ()
 
void forceActiveFocus (Qt::FocusReason reason)
 
QQuickItemnextItemInFocusChain (bool forward)
 
QQuickItemchildAt (qreal x, qreal y) const
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const
 
virtual bool isTextureProvider () const
 
virtual QSGTextureProvidertextureProvider () const
 
void update ()
 
void windowChanged (QQuickWindow *window)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
virtual const QMetaObjectmetaObject () const
 
QString objectName () const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const
 
bool isWindowType () const
 
bool signalsBlocked () const
 
bool blockSignals (bool block)
 
QThreadthread () const
 
void moveToThread (QThread *targetThread)
 
int startTimer (int interval, Qt::TimerType timerType)
 
void killTimer (int id)
 
findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
 
const QObjectList & children () const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const
 
bool disconnect (const QObject *receiver, const char *method) const
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const
 
QList< QByteArraydynamicPropertyNames () const
 
void destroyed (QObject *obj)
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const
 
bool inherits (const char *className) const
 
void deleteLater ()
 
- Public Member Functions inherited from QQmlParserStatus
virtual void classBegin ()=0
 
virtual void componentComplete ()=0
 
- Static Public Member Functions inherited from QObject
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
- Public Attributes inherited from QQuickItem
typedef Flags
 
- Properties inherited from QQuickItem
 parent
 
 x
 
 y
 
 z
 
 width
 
 height
 
 opacity
 
 enabled
 
 visible
 
 state
 
 childrenRect
 
 baselineOffset
 
 clip
 
 focus
 
 activeFocus
 
 activeFocusOnTab
 
 rotation
 
 scale
 
 transformOrigin
 
 smooth
 
 antialiasing
 
 implicitWidth
 
 implicitHeight
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Graphic which renders LiquidFun particles as blobs with a variety of effects.

GL frame buffers are used to render particles offscreen, then blend them into the current scene. The effect contains three components:

  1. Highlight around particles
  2. Fake specular lighting
  3. Inner shadow effect

Both (1) and (2) are accomplished using an inner bevel effect. This is implemented in ParticleRendererInnerBevel.fsh. The inner shadow effect is implemented in ParticleRendererInnerShadow.fsh. To render both of these effects, particles are first rendered to an FBO of size FBO_SIZE. This generates an approximate "height map", with the centers of particles being the highest points, and the edges of particles being lowest points. From that we can then compute edges and gradient vectors used for highlights and fake lighting.

For efficiency, these two effects are combined when possible into a single shader. This is implemented in ParticleRendererCombined.fsh, and currently requires the GL extension GL_EXT_shader_framebuffer_fetch.

Note
Currently particles are rendered to our offscreen frame buffer during the synchronization phase. This means that we lose the benefits of having a render thread for that process.

Member Function Documentation

virtual void ParticleRendererItem::render ( RenderNode node)
overrideprotectedvirtual

Implementation of RenderableInterface blending our frame buffers onto the current scene.

Parameters
nodeRenderNode being rendered

Implements RenderableInterface.

virtual void ParticleRendererItem::synchronizeForRendering ( RenderList renderList)
overrideprotectedvirtual

Synchronize and queue RenderNodes for rendering.

Note
This method currently also renders particles to our FBOs.
Parameters
renderListRenderList to add RenderNodes to

Reimplemented from Graphic.

Member Data Documentation

constexpr const int ParticleRendererItem::AUX_FBO_SIZE = 384
static

Width and height of the secondary frame buffer object used to render fake specular lighting to.

constexpr const int ParticleRendererItem::FBO_SIZE = 1024
static

Width and height of the main frame buffer object used to render particles to.

const float ParticleRendererItem::PARTICLE_SCALE
static

Visual size of particles, relative to their physical size.

When drawing particles, we overdraw them. That is, the square that represents each particle is significantly bigger than the particle itself. This is to allow smoother transitions between particles, and to prevent unwanted gaps between groups of particles at rest. This constant controls how much overdraw we perform.