odpresentationmgr.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Satyaki Maitra
 Date:          August 2016
________________________________________________________________________

-*/

#include "bufstringset.h"
#include "generalmod.h"
#include "idxpair.h"
#include "commondefs.h"
#include "callback.h"
#include "notify.h"
#include "typeset.h"
#include "objectset.h"
#include "dbkey.h"
#include "groupedid.h"
#include "zdomain.h"
#include "zaxistransform.h"

namespace OD
{

    typedef GroupedID::GroupID          ViewerTypeID;
    typedef GroupedID::ObjID            ViewerObjID;

    enum PresentationRequestType        { Add, Show, Hide, Vanish };

    mGlobal(General) const char*        sKeyPresentationObj();

mExpClass(General) ViewerID : public GroupedID
{
public:
                                ViewerID()
                                    : GroupedID(GroupedID::getInvalid())
                                {}

                                ViewerID( ViewerTypeID vwrtypeid,
                                          ViewerObjID vwrobjid )
                                    : GroupedID(GroupedID::getInvalid())
                                {
                                    setGroupID( vwrtypeid );
                                    setObjID( vwrobjid );
                                }
                                ViewerID(GroupNrType vwrtypeid, ObjNrType vwrid)
                                    : GroupedID(GroupedID::get(vwrtypeid,vwrid))
                                {}

    ViewerTypeID                viewerTypeID()  { return groupID(); }
    ViewerObjID                 viewerObjID()   { return objID(); }

};


mExpClass(General) ObjPresentationInfo
{
public:

                                        ObjPresentationInfo()   {}
                                        ObjPresentationInfo(const DBKey& dbk)
                                        : storedid_(dbk)        {}
    virtual                             ~ObjPresentationInfo()  {}
    virtual uiString                    getName() const;
    ObjPresentationInfo*                clone() const;
    virtual bool                        isSaveable() const
                                        { return !storedid_.isInvalid();}
    virtual void                        fillPar(IOPar&) const;
    virtual bool                        usePar(const IOPar&);
    void                                setStoredID(const DBKey& id)
                                        { storedid_ = id; }
    const DBKey&                        storedID() const
                                        { return storedid_; }
    const char*                         objTypeKey() const
                                        { return objtypekey_; }
    virtual bool                        isSameObj(
                                        const ObjPresentationInfo&) const;
protected:
    BufferString                        objtypekey_;
    DBKey                               storedid_;
};



mExpClass(General) ObjPresentationInfoSet
{
public:
                                        ~ObjPresentationInfoSet()
                                        { deepErase( prinfoset_ ); }
    bool                                isPresent(
                                        const ObjPresentationInfo&) const;
    int                                 size() const
                                        { return prinfoset_.size(); }
    ObjPresentationInfo*                remove(int idx);
    ObjPresentationInfo*                get(int idx);
    const ObjPresentationInfo*          get(int idx) const;
    bool                                add(ObjPresentationInfo*);
protected:
    ObjectSet<ObjPresentationInfo>      prinfoset_;
};


mExpClass(General) ObjPresentationInfoFactory
{
public:
    typedef ObjPresentationInfo* (*CreateFunc)( const IOPar& );

    void                        addCreateFunc(CreateFunc, const char* key);
    ObjPresentationInfo*        create(const IOPar&);
protected:
    TypeSet<CreateFunc>         createfuncs_;
    BufferStringSet             keys_;
};


mGlobal(General) ObjPresentationInfoFactory& PRIFac();


mExpClass(General) PresentationManagedViewer : public CallBacker
{
public:
                                PresentationManagedViewer();
    virtual                     ~PresentationManagedViewer();
    OD::ViewerID                viewerID()
                                { return OD::ViewerID(viewerTypeID(),
                                                      viewerObjID()); }
    virtual ViewerTypeID        viewerTypeID() const                    =0;
    ViewerObjID                 viewerObjID() const     { return viewerobjid_; }
    void                        setViewerObjID(ViewerObjID id)
                                { viewerobjid_ = id; }
    const ZAxisTransform*       getZAxisTransform() const
                                { return datatransform_.ptr(); }
    void                        setZAxisTransform(ZAxisTransform*);
    bool                        hasZAxisTransform() const
                                { return datatransform_; }
    const ZDomain::Info&        zDomain() const         {return *zdomaininfo_; }

    CNotifier<PresentationManagedViewer,IOPar>  ObjAdded;
    CNotifier<PresentationManagedViewer,IOPar>  ObjOrphaned;
    CNotifier<PresentationManagedViewer,IOPar>  UnsavedObjLastCall;
    CNotifier<PresentationManagedViewer,IOPar>  ShowRequested;
    CNotifier<PresentationManagedViewer,IOPar>  HideRequested;
    CNotifier<PresentationManagedViewer,IOPar>  VanishRequested;

protected:
    ViewerObjID                 viewerobjid_;
    RefMan<ZAxisTransform>      datatransform_;
    ZDomain::Info*              zdomaininfo_;
};



mExpClass(General) VwrTypePresentationMgr : public CallBacker
{
public:
    virtual ViewerTypeID        viewerTypeID() const            =0;
    virtual void                request(ViewerID originivwrid,
                                        PresentationRequestType,
                                        const IOPar&);
    void                        addViewer( PresentationManagedViewer* vwr )
                                { viewers_ += vwr; }
    PresentationManagedViewer*  getViewer(OD::ViewerObjID);
    const PresentationManagedViewer* getViewer(OD::ViewerObjID) const;
protected:
    ObjectSet<PresentationManagedViewer> viewers_;
};

mExpClass(General) PresentationManager
{
public:

    struct SyncInfo
    {
                                SyncInfo( ViewerTypeID vwrtypeid,
                                          bool sync )
                                    : vwrtypeid_(vwrtypeid)
                                    , issynced_(sync)   {}
        ViewerTypeID            vwrtypeid_;
        bool                    issynced_;
        bool operator==( const SyncInfo& rhs ) const
        {
            return vwrtypeid_==rhs.vwrtypeid_ && issynced_==rhs.issynced_;
        }
    };

                                PresentationManager();

    VwrTypePresentationMgr*     getViewerTypeMgr(ViewerTypeID vwrtypeid);
    const VwrTypePresentationMgr*
                                getViewerTypeMgr(ViewerTypeID vwrtypeid) const;
    PresentationManagedViewer*  getViewer(OD::ViewerID vwrid);
    const PresentationManagedViewer*
                                getViewer(OD::ViewerID vwrid) const;
    void                        request(ViewerID id,
                                        PresentationRequestType,
                                        const IOPar&);
    void                        syncAllViewerTypes();
    void                        addViewerTypeManager(VwrTypePresentationMgr*);
    bool                        canViewerBeSynced(ViewerID,
                                                  ViewerID) const;
    bool                        areViewerTypesSynced(ViewerTypeID,
                                                    ViewerTypeID) const;
protected:
    ObjectSet<VwrTypePresentationMgr>   vwrtypemanagers_;
    TypeSet<SyncInfo>                   vwrtypesyncinfos_;

    int                         syncInfoIdx(ViewerTypeID) const;
};

mGlobal(General) PresentationManager& PrMan();

}
//namedpace OD