vissurvscene.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 "vissurveymod.h"
#include "visscene.h"
#include "bufstring.h"
#include "keyboardevent.h"
#include "mouseevent.h"
#include "trckeyzsampling.h"
#include "trckeyvalue.h"
#include "position.h"

class MouseCursor;
class TaskRunner;
class FontData;
class ZAxisTransform;
template <class T> class Selector;

namespace ZDomain { class Info; }

namespace visBase
{
    class Annotation;
    class MarkerSet;
    class PolygonSelection;
    class SceneColTab;
    class TopBotImage;
    class Transformation;
    class VisualObject;
}

namespace visSurvey
{

mExpClass(visSurvey) Scene : public visBase::Scene
{ mODTextTranslationClass(Scene);
public:
    static Scene*               create()
                                mCreateDataObj(Scene);

    virtual void                removeAll();
    virtual void                addObject(visBase::DataObject*);
    virtual int                 size() const;
    virtual int                 getFirstIdx(const DataObject*) const;
    virtual int                 getFirstIdx(int did) const
                                { return visBase::Scene::getFirstIdx(did); }
    visBase::DataObject*        getObject(int);
    const visBase::DataObject*  getObject(int) const;

    void                        addUTMObject(visBase::VisualObject*);
    void                        addInlCrlZObject(visBase::DataObject*);
    virtual void                removeObject(int idx);

    void                        setTrcKeyZSampling(const TrcKeyZSampling&);
    const TrcKeyZSampling&      getTrcKeyZSampling() const { return tkzs_; }
    void                        showAnnotText(bool);
    bool                        isAnnotTextShown() const;
    void                        showAnnotScale(bool);
    bool                        isAnnotScaleShown() const;
    void                        showAnnotGrid(bool);
    bool                        isAnnotGridShown() const;
    void                        showAnnot(bool);
    bool                        isAnnotShown() const;
    void                        setAnnotText(int dim,const uiString&);
    void                        setAnnotFont(const FontData&);
    const FontData&             getAnnotFont() const;
    void                        setAnnotScale(const TrcKeyZSampling&);
    const TrcKeyZSampling&      getAnnotScale() const;
    void                        savePropertySettings();

    visBase::PolygonSelection*  getPolySelection() { return polyselector_; }
    void                        setPolygonSelector(visBase::PolygonSelection*);
    const Selector<Coord3>*     getSelector() const;    
    visBase::SceneColTab*       getSceneColTab()        { return scenecoltab_; }
    void                        setSceneColTab(visBase::SceneColTab*);

    Notifier<Scene>             mouseposchange;
    Notifier<Scene>             mousecursorchange;
    Notifier<Scene>             keypressed;
    Notifier<Scene>             mouseclicked;
    Notifier<Scene>             sceneboundingboxupdated;
    Coord3                      getMousePos(bool displayspace) const;
    TrcKeyValue                 getMousePos() const;
    BufferString                getMousePosValue() const;
    BufferString                getMousePosString() const;
    const MouseCursor*          getMouseCursor() const;
    void                        passMouseCursor(const MouseCursor&);
    const KeyboardEvent&        getKeyboardEvent() const { return kbevent_; }
    const MouseEvent&           getMouseEvent() const    { return mouseevent_; }
    void                        setEventHandled();

    void                        objectMoved(CallBacker*);

    void                        setFixedZStretch(float);
    float                       getFixedZStretch() const;

    void                        setTempZStretch(float);
    float                       getTempZStretch() const;

    void                        setZScale(float);
    float                       getZScale() const;
    float                       getApparentVelocity(float zstretch) const;
                                /*<!Velocity Unit depends on display depth in
                                    feet setting. */

    const mVisTrans*            getTempZStretchTransform() const;
    const mVisTrans*            getInlCrl2DisplayTransform() const;
    const mVisTrans*            getUTM2DisplayTransform() const;
    void                        setZAxisTransform(ZAxisTransform*,TaskRunner*);
    ZAxisTransform*             getZAxisTransform();
    const ZAxisTransform*       getZAxisTransform() const;

    bool                        isRightHandSystem() const;

    void                        setZDomainInfo(const ZDomain::Info&);
    const ZDomain::Info&        zDomainInfo() const;
    void                        getAllowedZDomains(BufferString&) const;

    // Convenience
    const char*                 zDomainKey() const;
    uiString                    zDomainUserName() const;
    const char*                 zDomainUnitStr(bool withparens=false) const;
    int                         zDomainUserFactor() const;
    const char*                 zDomainID() const;

    void                        setAnnotColor(const Color&);
    const Color                 getAnnotColor() const;
    void                        setMarkerPos(const TrcKeyValue&,int sceneid);
    void                        setMarkerSize(float );
    float                       getMarkerSize() const;
    const Color&                getMarkerColor() const;
    void                        setMarkerColor(const Color&);

    void                        createTopBotImage(bool istop);
    visBase::TopBotImage*       getTopBotImage(bool istop);

    Coord3                      getTopBottomIntersection(
                                    const visBase::EventInfo&,
                                    bool outerface,bool ignoreocclusion) const;
    Coord3                      getTopBottomSurveyPos(
                                    const visBase::EventInfo&, bool outerface,
                                    bool ignoreocclusion,bool inlcrlspace=true,
                                    BufferString* topbotstr=0 ) const;

    void                        setMoreObjectsToDoHint(bool yn);
    bool                        getMoreObjectsToDoHint() const;

    void                        selectPosModeManipObj(int selid);

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

    static const char*          sKeyZStretch();

protected:
                                ~Scene();

    void                        setup();
    void                        updateAnnotationText();
    void                        updateTransforms(const TrcKeyZSampling&);
    void                        mouseCB(CallBacker*);
    void                        keyPressCB(CallBacker*);
    visBase::MarkerSet*         createMarkerSet() const;
    void                        mouseCursorCB(CallBacker*);
    static const Color&         cDefaultMarkerColor();

    void                        togglePosModeManipObjSel();
    void                        selChangeCB(CallBacker*);

    TypeSet<int>                hoveredposmodemanipobjids_;
    int                         posmodemanipdeselobjid_;
    bool                        spacebarwaspressed_;

    RefMan<visBase::Transformation>     tempzstretchtrans_;

    RefMan<visBase::Transformation>     inlcrlrotation_;
    RefMan<visBase::Transformation>     inlcrlscale_;
    RefMan<visBase::Transformation>     utm2disptransform_;

    ZAxisTransform*                     datatransform_;

    visBase::Annotation*        annot_;
    visBase::MarkerSet*         markerset_;
    visBase::PolygonSelection*  polyselector_;
    Selector<Coord3>*           coordselector_;
    visBase::SceneColTab*       scenecoltab_;

    visBase::TopBotImage*       topimg_;
    visBase::TopBotImage*       botimg_;
    int                         getImageFromPar(const IOPar&,const char*,
                                                visBase::TopBotImage*&);

    Coord3                      xytmousepos_;
    TrcKey                      mousetrckey_;
    BufferString                mouseposval_;
    BufferString                mouseposstr_;
    const MouseCursor*          mousecursor_;
    IOPar&                      infopar_;

    float                       curzstretch_;

    ZDomain::Info*              zdomaininfo_;
    float                       zscale_;
    KeyboardEvent               kbevent_;
    MouseEvent                  mouseevent_;
    TrcKeyZSampling             tkzs_;
    TrcKeyZSampling             annotscale_;

    bool                        ctshownusepar_;
    bool                        usepar_;
    bool                        moreobjectstodo_;
    Threads::Lock               updatelock_;

    static const char*          sKeyShowAnnot();
    static const char*          sKeyShowScale();
    static const char*          sKeyShowGrid();
    static const char*          sKeyAnnotFont();
    static const char*          sKeyAnnotColor();
    static const char*          sKeyMarkerColor();
    static const char*          sKeyShowCube();
    static const char*          sKeyZAxisTransform();
    static const char*          sKeyAppAllowShading();
    static const char*          sKeyTopImageID();
    static const char*          sKeyBotImageID();
};

} // namespace visSurvey