SnapshotCaptureWidget.hpp

#ifndef SNAPSHOTCAPTUREWIDGET_HPP
#define SNAPSHOTCAPTUREWIDGET_HPP

#include "Export.hpp"
#include "Utils.hpp"

#include <MultiWidgets/Widget.hpp>

#include <folly/futures/Future.h>

namespace Showcase {

  enum { OVERSAMPLE = 2 };
  enum { MAXSIZE = 4096 };
  enum { DEFAULT_SNAPSHOT_MASK = Utils::OBJECT_MENU |
                                 Utils::OBJECT_EXCLUDE_FROM_SNAPSHOT};

  class SHOWCASE_API SnapShottable
  {
  public:
    typedef std::function<void(bool ok, QString title)> SnapShotCallback;

    virtual folly::Future<bool> requestSnapshot(const Nimble::SizeI & maximumDimensions,
                                                const QString & filename,
                                                const Nimble::SizeI & preferredDimensions = Nimble::SizeI(0, 0),
                                                int oversample = OVERSAMPLE) = 0;
  };

  class SnapShotCaptureWidget;
  INTRUSIVE_PTR_TYPEDEF(SnapShotCaptureWidget);

  class SHOWCASE_API SnapShotCaptureWidget : public MultiWidgets::Widget
  {
  public:

    typedef SnapShottable::SnapShotCallback Callback;

    SnapShotCaptureWidget();
    virtual ~SnapShotCaptureWidget();

    virtual void update(const MultiWidgets::FrameInfo &frameInfo) OVERRIDE;

    folly::Future<bool> requestSnapshot(MultiWidgets::WidgetPtr w,
                                        const QString & filename,
                                        const Nimble::SizeI & maximumDimensions = Nimble::SizeI(MAXSIZE, MAXSIZE),
                                        const Nimble::SizeI & preferredDimensions = Nimble::SizeI(0, 0),
                                        int oversample = OVERSAMPLE,
                                        const Nimble::Vector2f & viewOffset = Nimble::Vector2f(0, 0),
                                        const Nimble::SizeF & viewSize = Nimble::SizeF(0, 0),
                                        bool forceSnapshot = false,
                                        uint64_t objectMask = DEFAULT_SNAPSHOT_MASK);

    void addFlashEffect(MultiWidgets::WidgetPtr w);

    static folly::Future<bool> takeSnapshot(MultiWidgets::WidgetPtr w,
                                            const QString & filePath, bool flash = false,
                                            const Nimble::SizeI & maximumDimensions = Nimble::SizeI(MAXSIZE, MAXSIZE),
                                            Nimble::Vector2f viewOffset = Nimble::Vector2f(0, 0),
                                            Nimble::SizeF viewSize = Nimble::SizeF(0, 0),
                                            uint64_t objectMask = DEFAULT_SNAPSHOT_MASK);

    static SnapShotCaptureWidgetPtr snapshotWidget();

  protected:

    virtual void renderContent(Luminous::RenderContext &r) const OVERRIDE;

  private:
    class D;
    D * m_d;
  };

}

#endif // SNAPSHOTCAPTUREWIDGET_HPP