fabric/observer.h

/* Copyright (c) 2009-2016, Stefan Eilemann <eile@equalizergraphics.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_OBSERVER_H
#define EQFABRIC_OBSERVER_H

#include <eq/fabric/api.h>
#include <eq/fabric/eye.h>       // enum
#include <eq/fabric/focusMode.h> // enum
#include <eq/fabric/object.h>    // base class
#include <eq/fabric/vmmlib.h>
#include <string>
#include <vector>

namespace eq
{
namespace fabric
{
// cppcheck-suppress noConstructor
template <class C, class O>
class Observer : public Object
{
public:
    typedef LeafVisitor<O> Visitor;

    EQFABRIC_INL bool setHeadMatrix(const Matrix4f& matrix);

    const Matrix4f& getHeadMatrix() const { return _data.headMatrix; }
    EQFABRIC_INL void setEyePosition(const Eye eye, const Vector3f& pos);

    EQFABRIC_INL const Vector3f& getEyePosition(const Eye eye) const;

    EQFABRIC_INL void setFocusDistance(const float focusDistance);

    float getFocusDistance() const { return _data.focusDistance; }
    EQFABRIC_INL void setFocusMode(const FocusMode focusMode);

    FocusMode getFocusMode() const { return _data.focusMode; }
    EQFABRIC_INL void setOpenCVCamera(const int32_t index);

    int32_t getOpenCVCamera() const { return _data.camera; }
    EQFABRIC_INL void setVRPNTracker(const std::string& index);

    const std::string& getVRPNTracker() const { return _data.vrpnTracker; }
    const C* getConfig() const { return _config; }
    C* getConfig() { return _config; }
    ObserverPath getPath() const;

    EQFABRIC_INL VisitorResult accept(Visitor& visitor);

    EQFABRIC_INL VisitorResult accept(Visitor& visitor) const;

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


protected:
    EQFABRIC_INL explicit Observer(C* config);

    EQFABRIC_INL virtual ~Observer();

    virtual void serialize(co::DataOStream& os, const uint64_t dirtyBits);
    virtual void deserialize(co::DataIStream& is, const uint64_t dirtyBits);
    virtual void setDirty(const uint64_t bits); 

    enum DirtyBits
    {
        DIRTY_EYE_POSITION = Object::DIRTY_CUSTOM << 0,
        DIRTY_HEAD = Object::DIRTY_CUSTOM << 1,
        DIRTY_FOCUS = Object::DIRTY_CUSTOM << 2,
        DIRTY_TRACKER = Object::DIRTY_CUSTOM << 3,
        DIRTY_OBSERVER_BITS = DIRTY_EYE_POSITION | DIRTY_HEAD | DIRTY_FOCUS |
                              DIRTY_TRACKER | DIRTY_OBJECT_BITS
    };

    virtual uint64_t getRedistributableBits() const
    {
        return DIRTY_OBSERVER_BITS;
    }

private:
    C* const _config;

    struct BackupData
    {
        BackupData();

        Matrix4f headMatrix;            
        Vector3f eyePosition[NUM_EYES]; 
        float focusDistance;            
        FocusMode focusMode;            
        int32_t camera;          
        std::string vrpnTracker; 
    } _data, _backup;

    struct Private;
    Private* _private; // placeholder for binary-compatible changes
};

template <class C, class O>
EQFABRIC_INL std::ostream& operator<<(std::ostream&, const Observer<C, O>&);
}
}
#endif // EQFABRIC_OBSERVER_H