fabric/segment.h

/* Copyright (c) 2010-2013, Stefan Eilemann <eile@eyescale.ch>
 *
 * 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 EQFABRIC_SEGMENT_H
#define EQFABRIC_SEGMENT_H

#include <eq/fabric/types.h>
#include <eq/fabric/frustum.h>        // base class
#include <eq/fabric/object.h>         // base class
#include <eq/fabric/swapBarrier.h>    // RefPtr member
#include <eq/fabric/viewport.h>       // member

namespace eq
{
namespace fabric
{
    template< class C, class S, class CH >
    class Segment : public Object, public Frustum
    {
    public:
        typedef LeafVisitor< S > Visitor;

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

        C* getCanvas() { return _canvas; }

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

        EQFABRIC_INL void setViewport( const Viewport& vp );

        void setChannel( CH* channel )
            { _channel = channel; setDirty( DIRTY_CHANNEL ); }

        CH* getChannel()               { return _channel; }

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

        EQFABRIC_INL virtual void setWall( const Wall& wall );

        EQFABRIC_INL virtual void setProjection( const Projection& );

        EQFABRIC_INL virtual void unsetFrustum();

        uint32_t getEyes() const { return _eyes; }

        EQFABRIC_INL void setEyes( const uint32_t eyes );

        void enableEye( const uint32_t eyes ) { _eyes |= eyes; }

        EQFABRIC_INL void setSwapBarrier( SwapBarrierPtr barrier );

        SwapBarrierConstPtr getSwapBarrier() const { return _swapBarrier; }

        SwapBarrierPtr getSwapBarrier() { return _swapBarrier; }

        EQFABRIC_INL VisitorResult accept( Visitor& visitor );

        EQFABRIC_INL VisitorResult accept( Visitor& visitor ) const;

        void inheritFrustum();

        virtual void backup(); 
        virtual void restore(); 

        virtual uint128_t commit( const uint32_t incarnation=CO_COMMIT_NEXT );

    protected:
        EQFABRIC_INL Segment( C* canvas );

        EQFABRIC_INL virtual ~Segment();

        EQFABRIC_INL virtual void serialize( co::DataOStream& os,
                                                const uint64_t dirtyBits );
        EQFABRIC_INL virtual void deserialize( co::DataIStream& is,
                                                  const uint64_t dirtyBits );
        virtual void setDirty( const uint64_t bits ); 

        enum DirtyBits
        {
            DIRTY_VIEWPORT   = Object::DIRTY_CUSTOM << 0,
            DIRTY_FRUSTUM    = Object::DIRTY_CUSTOM << 1,
            DIRTY_CHANNEL    = Object::DIRTY_CUSTOM << 2,
            DIRTY_EYES       = Object::DIRTY_CUSTOM << 3,
            DIRTY_SEGMENT_BITS = DIRTY_VIEWPORT | DIRTY_FRUSTUM |
                                 DIRTY_CHANNEL | DIRTY_EYES | DIRTY_OBJECT_BITS
        };

        virtual uint64_t getRedistributableBits() const
            { return DIRTY_SEGMENT_BITS; }

        virtual void notifyFrustumChanged() { setDirty( DIRTY_FRUSTUM ); }

    private:
        C* const _canvas;

        Viewport _vp;

        CH* _channel;

        uint32_t _eyes;

        SwapBarrierPtr _swapBarrier; 

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

    template< class C, class S, class CH >
    std::ostream& operator << ( std::ostream&, const Segment< C, S, CH >& );
}
}
#endif // EQFABRIC_SEGMENT_H