lib/client/canvas.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_CANVAS_H
#define EQ_CANVAS_H

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

#include <eq/net/object.h>
#include <string>

namespace eq
{
namespace server
{
    class Canvas;
}
    class CanvasVisitor;

    class Canvas : public Frustum
    {
    public:
        EQ_EXPORT Canvas();

        EQ_EXPORT virtual ~Canvas();

        Config*       getConfig()       { return _config; }
        const Config* getConfig() const { return _config; }

        uint32_t getActiveLayoutIndex() const { return _activeLayout; }

        EQ_EXPORT const Layout* getActiveLayout() const;

        const SegmentVector& getSegments() const { return _segments; }        

        const LayoutVector& getLayouts() const { return _layouts; }        

        EQ_EXPORT virtual void useLayout( const uint32_t index );

        EQ_EXPORT VisitorResult accept( CanvasVisitor& visitor );

        EQ_EXPORT virtual void deregister();

        enum DirtyBits
        {
            DIRTY_LAYOUT     = Frustum::DIRTY_CUSTOM << 0,
            DIRTY_CHILDREN   = Frustum::DIRTY_CUSTOM << 1,
            DIRTY_FILL1      = Frustum::DIRTY_CUSTOM << 2,
            DIRTY_FILL2      = Frustum::DIRTY_CUSTOM << 3,
            DIRTY_CUSTOM     = Frustum::DIRTY_CUSTOM << 4
        };

    protected:
        EQ_EXPORT void serialize( net::DataOStream& os, 
                                  const uint64_t dirtyBits );

        EQ_EXPORT virtual void deserialize( net::DataIStream& is, 
                                            const uint64_t dirtyBits );
    private:
        Config* _config;
        friend class Config;

        uint32_t _activeLayout;

        LayoutVector _layouts;

        SegmentVector _segments;

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