fabric/canvas.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_CANVAS_H
#define EQFABRIC_CANVAS_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 <string>

namespace eq
{
namespace fabric
{
    template< class CFG, class C, class S, class L >
    class Canvas : public Object, public Frustum
    {
    public:
        typedef std::vector< C* > Canvases; 
        typedef std::vector< S* > Segments; 
        typedef std::vector< L* > Layouts; 

        typedef ElementVisitor< C, LeafVisitor< S > > Visitor;

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

        CanvasPath getPath() const;

        uint32_t getActiveLayoutIndex() const { return _data.activeLayout; }

        EQFABRIC_INL const L* getActiveLayout() const;

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

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

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

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

        EQFABRIC_INL void addLayout( L* layout );

        EQFABRIC_INL bool removeLayout( L* layout );

        EQFABRIC_INL void setSwapBarrier( SwapBarrierPtr barrier );

        SwapBarrierConstPtr getSwapBarrier() const { return _swapBarrier; }

        SwapBarrierPtr getSwapBarrier() { return _swapBarrier; }

        EQFABRIC_INL virtual void setWall( const Wall& wall );

        EQFABRIC_INL virtual void setProjection( const Projection& );

        EQFABRIC_INL virtual void unsetFrustum();

        EQFABRIC_INL virtual bool useLayout( const uint32_t index );

        EQFABRIC_INL VisitorResult accept( Visitor& visitor );

        EQFABRIC_INL VisitorResult accept( Visitor& visitor ) const;

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

        void create( S** segment ); 
        void release( S* segment ); 


    protected:
        EQFABRIC_INL Canvas( CFG* config );

        EQFABRIC_INL virtual ~Canvas();

        EQFABRIC_INL virtual void attach( const uint128_t& id,
                                          const uint32_t instanceID );

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

        EQFABRIC_INL virtual void notifyDetach(); 

        EQFABRIC_INL virtual void setDirty( const uint64_t bits );

        virtual void activateLayout( const uint32_t index )
            { _data.activeLayout = index; }

    private:
        CFG* const _config;

        struct BackupData
        {
            BackupData() : activeLayout( 0 ) {}

            uint32_t activeLayout;
        }
            _data, _backup;

        Layouts _layouts;

        Segments _segments;

        SwapBarrierPtr _swapBarrier; 

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

        enum DirtyBits
        {
            DIRTY_LAYOUT    = Object::DIRTY_CUSTOM << 0,
            DIRTY_SEGMENTS  = Object::DIRTY_CUSTOM << 1,
            DIRTY_LAYOUTS   = Object::DIRTY_CUSTOM << 2,
            DIRTY_FRUSTUM   = Object::DIRTY_CUSTOM << 3,
            DIRTY_CANVAS_BITS = DIRTY_LAYOUT | DIRTY_SEGMENTS | DIRTY_LAYOUTS |
                                DIRTY_FRUSTUM | DIRTY_OBJECT_BITS
        };

        virtual uint64_t getRedistributableBits() const
            { return DIRTY_CANVAS_BITS; }

        template< class, class, class > friend class Segment;
        friend class Object;
        void _addChild( S* segment ); 
        bool _removeChild( S* segment ); 

        EQFABRIC_INL virtual uint128_t commit( const uint32_t incarnation );
        bool _mapViewObjects();

        typedef co::CommandFunc< Canvas< CFG, C, S, L > > CmdFunc;
        bool _cmdNewSegment( co::ICommand& command );
        bool _cmdNewSegmentReply( co::ICommand& command );
    };

    template< class CFG, class C, class S, class L >
    std::ostream& operator << ( std::ostream&, const Canvas< CFG, C, S, L >& );
}
}
#endif // EQFABRIC_CANVAS_H