RE_QPainterDrawable.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        RE_QPainterDrawable.h (RE Library, C++)
 *
 * COMMENTS:
 *
 *  This is a drawable that hanles only QPainter painting.
 *  It does not support OpenGL painting and therefore does not work with RE_Render.
 *
 *  This drawable is more lightweight and faster than RE_WindowDrawable
 *  since it does not work with OpenGL and does not require an OpenGL window 
 *  backend.
 */

#ifndef __RE_QPAINTERDRAWABLE_H_INCLUDED__
#define __RE_QPAINTERDRAWABLE_H_INCLUDED__

#include "RE_API.h"

#include "RE_WindowDrawable.h"

#include <QtWidgets/QWidget>

#undef emit


#define RE_QPAINTER_DRAWABLE_OBJ_NAME "RE_QPainterDrawable"


class QPaintEvent;
class QShowEvent;
class RE_Window;

/// Window drawable that uses only QPainter for the new UI path.
class RE_API RE_QPainterDrawable : public QWidget
{
public:
    explicit RE_QPainterDrawable(QWidget *parent = nullptr);
    ~RE_QPainterDrawable() override;

    /// Assign the drawable to the given window.
    /// The given drawable will be used to render the contents of the window.
    void setREWindow(RE_Window *window);

    /// Return the window that the drawable is currently assigned to.
    const RE_Window *getREWindow() const { return myREWindow; }

    static const char *widgetTag() { return RE_QPAINTER_DRAWABLE_OBJ_NAME; }

    /// Return the painter used to paint the contents of the drawable.
    RE_WindowDrawablePainter &painter();

protected:
    void paintEvent(QPaintEvent *event) override;
    void showEvent(QShowEvent *event) override;

private:
    void init_();

    RE_Window *myREWindow = nullptr;
    bool myIsPainting = false;
    bool myNeedsOwnerUpdate = false;
    RE_WindowDrawablePainter myPainter;
};


#endif // __RE_QPAINTERDRAWABLE_H_INCLUDED__