fabric/view.h

/* Copyright (c) 2008-2017, Stefan Eilemann <eile@equalizergraphics.com>
 *                          Daniel Nachbaur <danielnachbaur@gmail.com>
 *                          Cedric Stalder <cedric.stalder@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 EQFABRIC_VIEW_H
#define EQFABRIC_VIEW_H

#include <eq/fabric/api.h>
#include <eq/fabric/equalizer.h> // member
#include <eq/fabric/frame.h>     // enum Frame::Buffer
#include <eq/fabric/frustum.h>   // base class
#include <eq/fabric/object.h>    // base class
#include <eq/fabric/types.h>
#include <eq/fabric/viewport.h> // member

#define EQ_MM 1000.f
#define EQ_CM 100.f
#define EQ_DM 10.f
#define EQ_M 1.f
#define EQ_KM 0.001f
#define EQ_UNDEFINED_UNIT -1.f

namespace eq
{
namespace fabric
{
template <class L, class V, class O>
// cppcheck-suppress noConstructor
class View : public Object, public Frustum
{
public:
    enum Mode
    {
        MODE_MONO = 1, 
        MODE_STEREO    
    };

    EQFABRIC_INL const Viewport& getViewport() const;

    L* getLayout() { return _layout; }
    const L* getLayout() const { return _layout; }
    EQFABRIC_INL void setObserver(O* observer);

    O* getObserver() { return _observer; }
    const O* getObserver() const { return _observer; }
    EQFABRIC_INL void setOverdraw(const Vector2i& pixels);

    const Vector2i& getOverdraw() const { return _overdraw; }
    EQFABRIC_INL void useEqualizer(uint32_t equalizerMask);

    uint32_t getEqualizers() const { return _equalizers; }
    EQFABRIC_INL const Equalizer& getEqualizer() const;

    EQFABRIC_INL Equalizer& getEqualizer();

    EQFABRIC_INL void setViewport(const Viewport& viewport);

    Mode getMode() const { return _data.mode; }
    EQFABRIC_INL virtual void changeMode(const Mode mode);

    virtual void activateMode(const Mode mode) { _data.mode = mode; }
    EQFABRIC_INL bool isActive() const;

    EQFABRIC_INL bool setModelUnit(const float modelUnit);

    EQFABRIC_INL float getModelUnit() const;

    EQFABRIC_INL VisitorResult accept(LeafVisitor<V>& visitor);

    EQFABRIC_INL VisitorResult accept(LeafVisitor<V>& visitor) const;

    virtual EQFABRIC_INL void backup();  
    virtual EQFABRIC_INL void restore(); 

    EQFABRIC_INL void setMinimumCapabilities(const uint64_t bitmask);

    EQFABRIC_INL uint64_t getMinimumCapabilities() const;

    EQFABRIC_INL void setMaximumCapabilities(const uint64_t bitmask);

    EQFABRIC_INL uint64_t getMaximumCapabilities() const;

    EQFABRIC_INL uint64_t getCapabilities() const;

    EQFABRIC_INL Frame::Buffer getScreenshotBuffers() const;

    void setCapabilities(const uint64_t bitmask); 
    virtual void updateCapabilities() {}          

    enum DirtyBits
    {
        DIRTY_VIEWPORT = Object::DIRTY_CUSTOM << 0,
        DIRTY_OBSERVER = Object::DIRTY_CUSTOM << 1,
        DIRTY_OVERDRAW = Object::DIRTY_CUSTOM << 2,
        DIRTY_FRUSTUM = Object::DIRTY_CUSTOM << 3,
        DIRTY_MODE = Object::DIRTY_CUSTOM << 4,
        DIRTY_MINCAPS = Object::DIRTY_CUSTOM << 5,
        DIRTY_MAXCAPS = Object::DIRTY_CUSTOM << 6,
        DIRTY_CAPABILITIES = Object::DIRTY_CUSTOM << 7,
        DIRTY_EQUALIZER = Object::DIRTY_CUSTOM << 8,
        DIRTY_EQUALIZERS = Object::DIRTY_CUSTOM << 9,
        DIRTY_MODELUNIT = Object::DIRTY_CUSTOM << 10,
        DIRTY_ATTRIBUTES = Object::DIRTY_CUSTOM << 11,
        DIRTY_SCREENSHOT = Object::DIRTY_CUSTOM << 12,
        DIRTY_VIEW_BITS =
            DIRTY_VIEWPORT | DIRTY_OBSERVER | DIRTY_OVERDRAW | DIRTY_FRUSTUM |
            DIRTY_MODE | DIRTY_MINCAPS | DIRTY_MAXCAPS | DIRTY_CAPABILITIES |
            DIRTY_OBJECT_BITS | DIRTY_EQUALIZER | DIRTY_EQUALIZERS |
            DIRTY_MODELUNIT | DIRTY_ATTRIBUTES | DIRTY_SCREENSHOT
    };

    enum SAttribute
    {
        SATTR_DEFLECT_HOST,
        SATTR_DEFLECT_ID,
        SATTR_LAST,
        SATTR_ALL = SATTR_LAST + 5
    };

    EQFABRIC_INL
    const std::string& getSAttribute(const SAttribute attr) const;

    EQFABRIC_INL
    static const std::string& getSAttributeString(const SAttribute attr);

protected:
    EQFABRIC_INL explicit View(L* layout);

    EQFABRIC_INL virtual ~View();

    virtual bool hasMasterUserData() { return getLayout() != 0; }
    EQFABRIC_INL virtual uint32_t getUserDataLatency() const;

    EQFABRIC_INL virtual void serialize(co::DataOStream& os,
                                        const uint64_t dirtyBits);

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

    EQFABRIC_INL virtual void setDirty(const uint64_t bits);

    void setSAttribute(const SAttribute attr, const std::string& value)
    {
        _sAttributes[attr] = value;
        setDirty(DIRTY_ATTRIBUTES);
    }

    virtual uint64_t getRedistributableBits() const { return DIRTY_VIEW_BITS; }
    virtual void notifyFrustumChanged() { setDirty(DIRTY_FRUSTUM); }
    void _setScreenshotBuffers(Frame::Buffer buffers);

private:
    L* const _layout;

    O* _observer;

    Equalizer _equalizer; 

    Vector2i _overdraw;

    uint64_t _minimumCapabilities; 
    uint64_t _maximumCapabilities; 
    uint64_t _capabilities;        
    uint32_t _equalizers;          
    float _modelUnit;              
    Frame::Buffer _screenshotBuffers;

    struct BackupData
    {
        BackupData();

        Viewport viewport;

        Mode mode; 
    } _data, _backup;

    std::string _sAttributes[SATTR_ALL];
};

template <class L, class V, class O>
EQFABRIC_INL std::ostream& operator<<(std::ostream& os,
                                      const View<L, V, O>& view);
}
}
#endif // EQFABRIC_VIEW_H