view.h

/* Copyright (c) 2008-2017, Stefan Eilemann <eile@equalizergraphics.com>
 *                          Daniel Nachbaur <danielnachbaur@gmail.com>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQ_VIEW_H
#define EQ_VIEW_H

#include <eq/api.h>
#include <eq/frame.h>         // enum
#include <eq/types.h>         // member
#include <eq/visitorResult.h> // enum

#include <eq/fabric/view.h>     // base class
#include <eq/fabric/viewport.h> // member

namespace eq
{
namespace detail
{
class View;
}

class View : public fabric::View<Layout, View, Observer>
{
public:
    EQ_API explicit View(Layout* parent);

    EQ_API virtual ~View();

    Pipe* getPipe() { return _pipe; }
    EQ_API const Pipe* getPipe() const { return _pipe; }
    EQ_API Config* getConfig();

    EQ_API const Config* getConfig() const;

    EQ_API ServerPtr getServer();

    EQ_API virtual bool handleEvent(EventType type, const SizeEvent& event);

    using ScreenshotFunc = std::function<void(uint32_t, const Image&)>;

    EQ_API void enableScreenshot(Frame::Buffer buffers,
                                 const ScreenshotFunc& func);

    EQ_API void disableScreenshot();

    bool handleEvent(EventICommand& command);

    void sendScreenshotEvent(const Viewport& viewport,
                             const uint32_t frameNumber, const Image& image);

protected:
    virtual bool configInit() { return true; }
    friend class detail::InitVisitor;

    virtual bool configExit() { return true; }
    friend class detail::ExitVisitor;

    EQ_API virtual void deserialize(co::DataIStream& is,
                                    const uint64_t dirtyBits);

    EQ_API const Frustum& getBaseFrustum() const;

    EQ_API virtual void detach();

private:
    detail::View* const _impl;

    bool _handleScreenshot(EventICommand& command);

    Pipe* _pipe; // for render-client views
    friend class Pipe;
};
}

#endif // EQ_VIEW_H