emobject.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Kristofer Tingdahl
 Date:          4-11-2002
________________________________________________________________________


-*/

#include "earthmodelmod.h"
#include "notify.h"
#include "trckeyzsampling.h"
#include "draw.h"
#include "emposid.h"
#include "dbkey.h"
#include "coord.h"
#include "uistring.h"

class TrcKeyZSampling;
class Executor;
class IOObj;
class IOObjContext;
class TaskRunner;

namespace Geometry { class Element; }

template <class T> class Selector;
template <class T> class Array2D;

namespace EM
{
class EMManager;

mExpClass(EarthModel) EMObjectCallbackData
{
public:
                EMObjectCallbackData()
                    : pid0( 0, 0, 0 )
                    , pid1( 0, 0, 0 )
                    , attrib( -1 )
                    , flagfor2dviewer( false )
                    , event( EMObjectCallbackData::Undef )
                {}


                EMObjectCallbackData( const EMObjectCallbackData& data )
                    : pid0( data.pid0 )
                    , pid1( data.pid1 )
                    , attrib( data.attrib )
                    , flagfor2dviewer( data.flagfor2dviewer )
                    , event( data.event )
                {}


    enum Event { Undef, PositionChange, PosIDChange, PrefColorChange, Removal,
                 AttribChange, SectionChange, NameChange, SelectionChange,
                 LockChange, BurstAlert, LockColorChange, SelectionColorChnage,
                 ParentColorChange} event;

    EM::PosID   pid0;
    EM::PosID   pid1;   //Only used in PosIDChange
    int         attrib; //Used only with AttribChange
    bool        flagfor2dviewer; //Used only with BurstAlert for 2DViewer
};


mExpClass(EarthModel) EMObjectIterator
{
public:
    virtual             ~EMObjectIterator() {}
    virtual EM::PosID   next()          = 0;
    virtual int         approximateSize() const { return maximumSize(); }
    virtual int         maximumSize() const     { return -1; }
    virtual bool        canGoTo() const         { return false; }
    virtual EM::PosID   goTo(od_int64)          { return EM::PosID(-1,-1,-1); }
};


mExpClass(EarthModel) PosAttrib
{
public:
                        PosAttrib(){}

    enum Type           { PermanentControlNode, TemporaryControlNode,
                          EdgeControlNode, TerminationNode, SeedNode,
                          IntersectionNode };

    Type                type_;
    TypeSet<PosID>      posids_;
    bool                locked_;
};


mExpClass(EarthModel) EMObject  : public RefCount::Referenced
                                , public CallBacker
{
public:

    enum NodeSourceType         { None = (int)'0', Manual=(int)'1',
                                  Auto=(int)'2', Gridding=(int)'3' };
    const ObjectID&             id() const              { return id_; }
    virtual const char*         getTypeStr() const      = 0;
    virtual uiString            getUserTypeStr() const  = 0;
    const DBKey&                dbKey() const           { return storageid_; }
    void                        setDBKey(const DBKey&);

    virtual bool                isOK() const            { return true; }

    void                        setName( const char* nm )  { objname_ = nm; }
    BufferString                name() const;
    uiString                    uiName() const { return toUiString(name()); }
    virtual void                setNewName();

    virtual int                 nrSections() const      = 0;
    virtual SectionID           sectionID(int) const    = 0;
    virtual BufferString        sectionName(const SectionID&) const;
    virtual bool                canSetSectionName() const;
    virtual bool                setSectionName(const SectionID&,const char*,
                                               bool addtohistory);
    virtual int                 sectionIndex(const SectionID&) const;
    virtual bool                removeSection(SectionID,bool hist )
                                                        { return false; }

    void                        removeSelected(const TypeSet<EM::SubID>&);

    const Geometry::Element*    sectionGeometry(const SectionID&) const;
    Geometry::Element*          sectionGeometry(const SectionID&);

    const Color&                preferredColor() const;
    void                        setPreferredColor(const Color&,
                                                  bool addtohistory=false);
    const OD::LineStyle&        preferredLineStyle() const;
    void                        setPreferredLineStyle(const OD::LineStyle&);
    const OD::MarkerStyle3D&    preferredMarkerStyle3D() const;
    void                        setPreferredMarkerStyle3D(
                                                    const OD::MarkerStyle3D&);

    void                        setBurstAlert(bool yn);
    bool                        hasBurstAlert() const;

    virtual Coord3              getPos(const EM::PosID&) const;
    virtual Coord3              getPos(const EM::SectionID&,
                                       const EM::SubID&) const;
    virtual bool                isDefined(const EM::PosID&) const;
    virtual bool                isDefined(const EM::SectionID&,
                                          const EM::SubID&) const;
    bool                        setPos(const EM::PosID&,const Coord3&,
                                       bool addtohistory,
                                       NodeSourceType type=Auto);
    bool                        setPos(const EM::SectionID&,const EM::SubID&,
                                       const Coord3&,bool addtohistory,
                                       NodeSourceType type=Auto);
    virtual bool                unSetPos(const EM::PosID&,bool addtohistory);
    virtual bool                unSetPos(const EM::SectionID&,const EM::SubID&,
                                         bool addtohistory);

    virtual void                setNodeSourceType(const TrcKey&,
                                                        NodeSourceType){}
    virtual bool                hasNodeSourceType( const PosID& ) const
                                                    { return false; }

    virtual bool                isNodeSourceType(const PosID&,
                                    NodeSourceType) const {return false;}
    virtual bool                isNodeSourceType(const TrcKey&,
                                     NodeSourceType)const {return false;}

    virtual void                setNodeLocked(const TrcKey&,bool locked){}
    virtual bool                isNodeLocked(const TrcKey&) const
                                            { return false; }
    virtual bool                isNodeLocked(const PosID&)const {return false;}

    virtual void                lockAll() {}
    virtual void                unlockAll(){}
    virtual const Array2D<char>*
                                getLockedNodes() const { return 0; }
    virtual void                setLockColor(const Color&) {}
    virtual const Color         getLockColor() const { return Color::Blue(); }
    virtual bool                hasLockedNodes() const {return haslockednodes_;}


    virtual bool                enableGeometryChecks(bool);
    virtual bool                isGeometryChecksEnabled() const;

    virtual bool                isAtEdge(const EM::PosID&) const;

    void                        changePosID(const EM::PosID& from,
                                            const EM::PosID& to,
                                            bool addtohistory);
    virtual void                getLinkedPos(const EM::PosID& posid,
                                          TypeSet<EM::PosID>&) const
                                        { return; }
    virtual EMObjectIterator*   createIterator(const EM::SectionID&,
                                               const TrcKeyZSampling* =0) const
                                { return 0; }
    virtual int                 nrPosAttribs() const;
    virtual int                 posAttrib(int idx) const;
    virtual void                addPosAttrib(int attr);
    virtual void                removePosAttribList(int attr,
                                                    bool addtohistory=true);
    virtual void                setPosAttrib(const EM::PosID&,
                                    int attr,bool yn,bool addtohistory=true);
    virtual bool                isPosAttrib(const EM::PosID&,int attr) const;
    virtual const char*         posAttribName(int) const;
    virtual int                 addPosAttribName(const char*);
    const TypeSet<PosID>*       getPosAttribList(int attr) const;
    const OD::MarkerStyle3D&    getPosAttrMarkerStyle(int attr);
    void                        setPosAttrMarkerStyle(int attr,
                                                      const OD::MarkerStyle3D&);
    virtual void                lockPosAttrib(int attr,bool yn);
    virtual bool                isPosAttribLocked(int attr) const;
    virtual void                removeSelected(const Selector<Coord3>&,
                                               TaskRunner*);
    void                        removeListOfSubIDs(const TypeSet<EM::SubID>&,
                                                   const EM::SectionID&);
    void                        removeAllUnSeedPos();
    const TrcKeyZSampling       getRemovedPolySelectedPosBox();
    void                        emptyRemovedPolySelectedPosBox();

    CNotifier<EMObject,const EMObjectCallbackData&>     change;

    virtual Executor*           loader()                { return 0; }
    virtual bool                isLoaded() const        { return false; }
    virtual Executor*           saver()                 { return 0; }
    virtual bool                isChanged() const       { return changed_; }
    virtual bool                isEmpty() const;
    virtual void                setChangedFlag()        { changed_=true; }
    virtual void                resetChangedFlag()      { changed_=false; }
    bool                        isFullyLoaded() const   { return fullyloaded_; }
    void                        setFullyLoaded(bool yn) { fullyloaded_=yn; }

    virtual bool                isLocked() const        { return locked_; }
    virtual void                lock(bool yn)           { locked_=yn;}

    bool                        isInsideSelRemoval() const
                                { return insideselremoval_; }
    bool                        isSelRemoving() const   { return selremoving_; }

    uiString                    errMsg() const;
    void                        setErrMsg(const uiString& m) { errmsg_ = m; }

    void                        setSelectionColor(const Color&);
    const Color&                getSelectionColor() const;

    virtual bool                usePar(const IOPar&);
    virtual void                fillPar(IOPar&) const;
    void                        saveDisplayPars() const;

    static int                  sTerminationNode();
    static int                  sSeedNode();
    static int                  sIntersectionNode();

    virtual const IOObjContext& getIOObjContext() const = 0;

protected:
                                ~EMObject();
                                EMObject( EMManager& );

    virtual bool                setPosition(const EM::SectionID&,
                                            const EM::SubID&,
                                            const Coord3&,bool addtohistory,
                                            NodeSourceType type=Auto);
    virtual Geometry::Element*  sectionGeometryInternal(const SectionID&);
    virtual void                prepareForDelete();
    void                        posIDChangeCB(CallBacker*);
    void                        useDisplayPars(const IOPar&);
    BufferString                objname_;
    ObjectID                    id_;
    DBKey                       storageid_;
    class EMManager&            manager_;
    uiString                    errmsg_;

    Color&                      preferredcolor_;
    OD::LineStyle&              preferredlinestyle_;
    OD::MarkerStyle3D&          preferredmarkerstyle_;
    ObjectSet<PosAttrib>        posattribs_;
    TypeSet<int>                attribs_;
    Color                       selectioncolor_;

    TrcKeyZSampling             removebypolyposbox_;

    bool                        changed_;
    bool                        fullyloaded_;
    bool                        locked_;
    int                         burstalertcount_;
    Threads::Lock               setposlock_;

    bool                        insideselremoval_;
    bool                        selremoving_;
    bool                        haslockednodes_;

    static const char*          nrposattrstr();
    static const char*          posattrprefixstr();
    static const char*          posattrsectionstr();
    static const char*          posattrposidstr();

public:

    mDeprecated const DBKey&    multiID() const         { return storageid_; }
    mDeprecated void            setMultiID( const DBKey& k ) { setDBKey(k); }
    static Color                sDefaultSelectionColor();

};

} // namespace EM

#define mDefineEMObjFuncs( clss ) \
public: \
                                clss(EM::EMManager&); \
    static void                 initClass(); \
    static EMObject*            create(EM::EMManager&); \
    static clss*                create(const char* nm); \
    static FixedString          typeStr(); \
    const char*                 getTypeStr() const; \
    void                        setNewName(); \
protected: \
                                ~clss()

#define mImplementEMObjFuncs( clss, typenm ) \
void clss::initClass() \
{ \
    EMOF().addCreator( create, typeStr() ); \
} \
 \
 \
EMObject* clss::create( EM::EMManager& emm ) \
{ \
    EMObject* obj = new clss( emm ); \
    if ( !obj ) return 0; \
    obj->ref();         \
    emm.addObject( obj ); \
    obj->unRefNoDelete(); \
    return obj; \
} \
\
clss* clss::create( const char* nm ) \
{ \
    const ObjectID objid = EMM().createObject( typeStr(), nm ); \
    EMObject* emobj = EMM().getObject( objid ); \
    mDynamicCastGet(clss*,newobj,emobj); \
    return newobj; \
} \
\
FixedString clss::typeStr() { return typenm; } \
const char* clss::getTypeStr() const { return typeStr(); } \
void clss::setNewName() \
{\
    static int objnr = 1; \
    BufferString nm( "<New ", typenm, " " ); \
    nm.add( objnr++ ).add( ">" ); \
    setName( nm ); \
}