uigraphicsviewbase.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:          March 2009
________________________________________________________________________

-*/

#include "uibasemod.h"
#include "uiobj.h"

namespace OD { class Alignment; }
class uiGraphicsItem;
class uiGraphicsScene;
class uiGraphicsViewBody;
class GestureEventHandler;
class KeyboardEventHandler;
class MouseEventHandler;
class uiRect;


mExpClass(uiBase) uiGraphicsViewBase : public uiObject
{
friend class uiGraphicsViewBody;
public:
                                uiGraphicsViewBase(uiParent*,const char*);
                                ~uiGraphicsViewBase();

    void                        setScene(uiGraphicsScene&);
    uiGraphicsScene&            scene();
    const uiGraphicsScene&      scene() const;
    void                        show();
    enum ODDragMode             { NoDrag, ScrollHandDrag, RubberBandDrag };
    enum ScrollBarPolicy        { ScrollBarAsNeeded, ScrollBarAlwaysOff,
                                  ScrollBarAlwaysOn };

    void                        setScrollBarPolicy(bool hor,ScrollBarPolicy);
    void                        setDragMode(ODDragMode);
    ODDragMode                  dragMode() const;
    bool                        isRubberBandingOn() const;

    void                        setMouseTracking(bool);
    bool                        hasMouseTracking() const;

    void                        setMouseWheelReversal(bool);
    bool                        getMouseWheelReversal() const;

    void                        setMidMouseButtonForDrag(bool);
    bool                        hasMidMouseButtonForDrag() const;

    int                         width() const;          
    int                         height() const;         
    int                         viewWidth() const;      
    int                         viewHeight() const;     

    void                        setViewSize(int width,int height);
    void                        setViewWidth(int);
    void                        setViewHeight(int);

    int                         getSceneBorder() const;
    void                        setSceneBorder(int);

    void                        centreOn(uiPoint);
    uiRect                      getSceneRect() const;
    void                        setSceneRect(const uiRect&);
    void                        setSceneAlignment(const OD::Alignment&);
    void                        setScaleFactor(float,float);

    uiPoint                     getCursorPos() const;
    void                        getScaleFactor(float&,float&) const;
    uiPoint                     getScenePos(float,float) const;
    const uiPoint&              getStartPos() const;
    const uiRect*               getSelectedArea() const {return selectedarea_;}
    void                        setViewArea(double x,double y,
                                            double w,double h);
    uiRect                      getViewArea() const;

    void                        setBackgroundColor(const Color&);
    Color                       backgroundColor() const;
    void                        setNoBackGround();
    void                        rePaint();
    void                        enableScrollZoom(bool yn=true);
    void                        disableScrollZoom();
    bool                        scrollZoomEnabled()
                                { return enabscrollzoom_; }
    uiSize                      scrollBarSize(bool horizontal) const;

    const uiPoint               mapFromScene(const Geom::Point2D<float>&) const;
    const Geom::Point2D<float>  mapToScene(const uiPoint&) const;

    bool                        isCtrlPressed() const   {return isctrlpressed_;}
    void                        setCtrlPressed( bool yn )
                                { isctrlpressed_ = yn; }

    bool                        print();

    MouseEventHandler&          getNavigationMouseEventHandler();
    MouseEventHandler&          getMouseEventHandler();
    KeyboardEventHandler&       getKeyboardEventHandler();
    GestureEventHandler&        gestureEventHandler();


    CNotifier<uiGraphicsViewBase,uiSize> reSize; 
    Notifier<uiGraphicsViewBase> rubberBandUsed;
    Notifier<uiGraphicsViewBase> reDrawNeeded;
    Notifier<uiGraphicsViewBase> reDrawn;
    Notifier<uiGraphicsViewBase> preDraw;
    Notifier<uiGraphicsViewBase> scrollBarUsed;
    Notifier<uiObject>          pointerEntered;
    Notifier<uiObject>          pointerLeft;


    static const ObjectSet<uiGraphicsViewBase>& allInstances();

protected:

    void                        translateText();

    uiGraphicsViewBody*         body_;
    uiGraphicsViewBody&         mkbody(uiParent*,const char*);

    uiRect*                     selectedarea_;
    uiGraphicsScene*            scene_;
    int                         sceneborder_;

    bool                        isctrlpressed_;
    bool                        enabscrollzoom_;
    void                        rubberBandCB(CallBacker*);

};