server/segment.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_SEGMENT_H
#define EQSERVER_SEGMENT_H

#include "paths.h"
#include "types.h"
#include "segmentVisitor.h"  // used in inline method

#include <eq/client/segment.h>      // base class
#include <eq/client/viewport.h>     // member

namespace eq
{
namespace server
{
    class Canvas;

    class Segment : public eq::Segment
    {
    public:
        EQSERVER_EXPORT Segment();

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

        virtual ~Segment();

        Config* getConfig();

        const Config* getConfig() const;

        SegmentPath getPath() const;

        void setChannel( Channel* channel ) { _channel = channel; }

        Channel* getChannel()               { return _channel; }
        const Channel* getChannel() const   { return _channel; }

        Canvas* getCanvas()               { return _canvas; }
        const Canvas* getCanvas() const   { return _canvas; }

        EQSERVER_EXPORT void setViewport( const eq::Viewport& vp );

        const eq::Viewport& getViewport() const { return _vp; }

        void addDestinationChannel( Channel* channel );

        bool removeDestinationChannel( Channel* channel );

        const ChannelVector& getDestinationChannels() const 
            { return _destinationChannels; }
        
        VisitorResult accept( SegmentVisitor& visitor )
            { return visitor.visit( this ); }
        VisitorResult accept( ConstSegmentVisitor& visitor ) const
            { return visitor.visit( this ); }

    protected:

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

        Canvas* _canvas;
        friend class Canvas;

        Channel* _channel;

        ChannelVector _destinationChannels;

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

        void _updateView();
    };

    std::ostream& operator << ( std::ostream& os, const Segment* segment);
}
}
#endif // EQSERVER_SEGMENT_H