fabric/layout.h

/* Copyright (c) 2009-2016, 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 EQFABRIC_LAYOUT_H
#define EQFABRIC_LAYOUT_H

#include <eq/fabric/object.h>        // base class
#include <eq/fabric/pixelViewport.h> // member
#include <eq/fabric/types.h>
#include <string>

namespace eq
{
namespace fabric
{
// cppcheck-suppress noConstructor
template <class C, class L, class V>
class Layout : public Object
{
public:
    typedef std::vector<V*> Views;
    typedef ElementVisitor<L, LeafVisitor<V>> Visitor;

    C* getConfig() { return _config; }
    const C* getConfig() const { return _config; }
    const Views& getViews() const { return _views; }
    EQFABRIC_INL bool isActive() const;

    V* getView(const ViewPath& path);

    V* findView(const std::string& name);

    LayoutPath getPath() const;

    EQFABRIC_INL VisitorResult accept(Visitor& visitor);

    EQFABRIC_INL VisitorResult accept(Visitor& visitor) const;

    EQFABRIC_INL void setPixelViewport(const PixelViewport& pvp);

    EQFABRIC_INL const PixelViewport& getPixelViewport() const;

    void create(V** view); 
    void release(V* view); 


protected:
    EQFABRIC_INL explicit Layout(C* config);

    EQFABRIC_INL virtual ~Layout();

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

    EQFABRIC_INL virtual 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(); 
    virtual void notifyViewportChanged() {}   

    EQFABRIC_INL virtual void setDirty(const uint64_t bits);

    enum DirtyBits
    {
        DIRTY_VIEWS = Object::DIRTY_CUSTOM << 0,
        DIRTY_VIEWPORT = Object::DIRTY_CUSTOM << 1,
        DIRTY_LAYOUT_BITS = DIRTY_VIEWS | DIRTY_VIEWPORT | DIRTY_OBJECT_BITS
    };

    virtual uint64_t getRedistributableBits() const
    {
        return DIRTY_LAYOUT_BITS;
    }

private:
    C* const _config;

    Views _views;

    PixelViewport _pvp; 

    template <class, class, class>
    friend class View;
    friend class Object;
    void _addChild(V* view);
    bool _removeChild(V* view);

    EQFABRIC_INL virtual uint128_t commit(const uint32_t incarnation);

    template <class O>
    void _removeObserver(const O* observer);
    template <class, class, class, class, class, class, class>
    friend class Config;

    typedef co::CommandFunc<Layout<C, L, V>> CmdFunc;
    bool _cmdNewView(co::ICommand& command);
    bool _cmdNewViewReply(co::ICommand& command);
};

template <class C, class L, class V>
std::ostream& operator<<(std::ostream&, const Layout<C, L, V>&);
}
}
#endif // EQFABRIC_LAYOUT_H