include/eq/client/view.h

/* Copyright (c) 2008-2011, 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_VIEW_H
#define EQ_VIEW_H

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

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

namespace eq
{
    class View : public fabric::View< Layout, View, Observer >
    {
    public:
        EQ_API 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( const Event& event );

        EQ_API void freezeLoadBalancing( const bool onOff );

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

        const Frustum& getBaseFrustum() const { return _baseFrustum; }

        EQ_API virtual void detach();

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

        Frustum _baseFrustum;

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

#endif //EQ_VIEW_H