server/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 EQSERVER_CANVAS_H
#define EQSERVER_CANVAS_H

#include "types.h"
#include "visitorResult.h"  // enum

#include <eq/client/canvas.h>

#include <eq/base/base.h>
#include <string>

namespace eq
{
namespace server
{
    class CanvasVisitor;
    class ConstCanvasVisitor;
    struct CanvasPath;
    struct SegmentPath;

    class Canvas : public eq::Frustum
    {
    public:
        EQSERVER_EXPORT Canvas();

        Canvas( const Canvas& from, Config* config );

        virtual ~Canvas();

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

        EQSERVER_EXPORT void addSegment( Segment* segment );
        
        const SegmentVector& getSegments() const { return _segments; }

        Segment* findSegment( const std::string& name );

        Segment* getSegment( const SegmentPath& path );

        void addLayout( Layout* layout );

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

        void init();
        void exit();

        VisitorResult accept( CanvasVisitor& visitor );
        VisitorResult accept( ConstCanvasVisitor& visitor ) const;

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

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

    private:
        virtual void getInstanceData( net::DataOStream& os );

        Config* _config;
        friend class Config;

        LayoutVector _layouts;
        
        uint32_t _activeLayout;

        SegmentVector _segments;

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

        void _useLayout( const uint32_t index );
        void _switchLayout( const uint32_t oldIndex, const uint32_t newIndex );
    };

    std::ostream& operator << ( std::ostream& os, const Canvas* canvas);
}
}
#endif // EQSERVER_CANVAS_H