lib/client/observer.h

/* Copyright (c) 2009, 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 EQ_OBSERVER_H
#define EQ_OBSERVER_H

#include <eq/client/object.h>         // base class
#include <eq/client/types.h>
#include <eq/client/visitorResult.h>  // enum

#include <string>

namespace eq
{
    class Config;
    class ObserverVisitor;

    class Observer : public Object
    {
    public:
        EQ_EXPORT Observer();

        EQ_EXPORT virtual ~Observer();

        EQ_EXPORT void setEyeBase( const float eyeBase );

        float getEyeBase() const { return _eyeBase; }

        EQ_EXPORT void setHeadMatrix( const Matrix4f& matrix );

        const Matrix4f& getHeadMatrix() const { return _headMatrix; }

        EQ_EXPORT VisitorResult accept( ObserverVisitor& visitor );

        EQ_EXPORT virtual void deregister();
        
    protected:
        EQ_EXPORT virtual void serialize( net::DataOStream& os,
                                          const uint64_t dirtyBits );
        EQ_EXPORT virtual void deserialize( net::DataIStream& is, 
                                            const uint64_t dirtyBits );

        enum DirtyBits
        {
            DIRTY_EYE_BASE   = Object::DIRTY_CUSTOM << 0,
            DIRTY_HEAD       = Object::DIRTY_CUSTOM << 1,
            DIRTY_FILL1      = Object::DIRTY_CUSTOM << 2,
            DIRTY_FILL2      = Object::DIRTY_CUSTOM << 3,
            DIRTY_CUSTOM     = Object::DIRTY_CUSTOM << 4
        };

    private:
        Config* _config;
        friend class Config;

        float _eyeBase;

        Matrix4f _headMatrix;

        union // placeholder for binary-compatible changes
        {
            char dummy[64];
        };
    };

    EQ_EXPORT std::ostream& operator << ( std::ostream&, const Observer* );
}
#endif // EQ_OBSERVER_H