uiaxishandler.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Bert
 Date:          Mar 2008
________________________________________________________________________

-*/

#include "uitoolsmod.h"
#include "draw.h"
#include "bufstringset.h"
#include "namedobj.h"
#include "uigeom.h"
#include "uistring.h"
#include "fontdata.h"

class uiGraphicsScene;
class uiLineItem;
class uiTextItem;
class uiAHPlotAnnotSet;
template <class T> class LineParameters;

mExpClass(uiTools) uiAxisHandler
{
public:

    struct Setup
    {
                        Setup( uiRect::Side s, int w=0, int h=0 )
                            : side_(s)
                            , noaxisline_(false)
                            , noaxisannot_(false)
                            , nogridline_(false)
                            , showauxannot_(false)
                            , auxlinestyle_(OD::LineStyle(OD::LineStyle::Dot))
                            , annotinside_(false)
                            , annotinint_(false)
                            , fixedborder_(false)
                            , ticsz_(2)
                            , width_(w)
                            , height_(h)
                            , maxnrchars_(0)
                            , specialvalue_(0.0f)
                            , islog_(false)
                            , zval_(4)
                            , nmcolor_(Color::NoColor())
                            , fontdata_(FontData(10))
                            {}

        mDefSetupMemb(uiRect::Side,side)
        mDefSetupMemb(int,width)
        mDefSetupMemb(int,height)
        mDefSetupMemb(bool,islog)
        mDefSetupMemb(bool,noaxisline)
        mDefSetupMemb(bool,noaxisannot)
        mDefSetupMemb(bool,nogridline)
        mDefSetupMemb(bool,annotinside)
        mDefSetupMemb(bool,annotinint)
        mDefSetupMemb(bool,fixedborder)
        mDefSetupMemb(bool,showauxannot)
        mDefSetupMemb(int,ticsz)
        mDefSetupMemb(uiBorder,border)
        mDefSetupMemb(OD::LineStyle,style)
        mDefSetupMemb(OD::LineStyle,gridlinestyle)
        mDefSetupMemb(OD::LineStyle,auxlinestyle)
        mDefSetupMemb(OD::LineStyle,auxhllinestyle)
        mDefSetupMemb(uiString,caption)
        mDefSetupMemb(int,maxnrchars)
        mDefSetupMemb(float,specialvalue) 
        mDefSetupMemb(int,zval)
        mDefSetupMemb(Color,nmcolor)
        mDefSetupMemb(FontData,fontdata)

        Setup&          noannot( bool yn )
                        { noaxisline_ = noaxisannot_ = nogridline_ = yn;
                          return *this; }

        void            setShowSpecialValue( bool yn, float newval=0.0f )
                        { specialvalue_ = yn ? newval : mUdf(float); }
        bool            showSpecialValue() const
                        { return !mIsUdf(specialvalue_); }
    };

                        uiAxisHandler(uiGraphicsScene*,const Setup&);
                        ~uiAxisHandler();

    void                setCaption(const uiString&);
    uiString            getCaption() const      { return setup_.caption_; }
    void                setBorder(const uiBorder&);
    void                setIsLog(bool yn);
    void                setBegin( const uiAxisHandler* ah )
                                                { beghndlr_ = ah; newDevSize();}
    void                setEnd( const uiAxisHandler* ah )
                                                { endhndlr_ = ah; newDevSize();}

    void                setRange(const StepInterval<float>&,float* axstart=0);
    void                setBounds(Interval<float>); 

    float               getVal(int pix) const;
    float               getRelPos(float absval) const;
    int                 getPix(float absval) const;
    int                 getPix(double abvsval) const;
    int                 getPix(int) const;
    int                 getRelPosPix(float relpos) const;
    void                setAuxAnnot( const TypeSet<OD::PlotAnnotation>& pos )
                                                { auxannots_ = pos; }

    const Setup&        setup() const           { return setup_; }
    Setup&              setup()                 { return setup_; }
    StepInterval<float> range() const           { return datarg_; }
    float               annotStart() const      { return annotstart_; }
    bool                isHor() const   { return uiRect::isHor(setup_.side_); }
    int                 pixToEdge(bool withborder=true) const;
    int                 pixBefore() const;
    int                 pixAfter() const;
    Interval<int>       pixRange() const;

    void                newDevSize();
    void                updateDevSize();        
    void                setNewDevSize(int,int); 
    void                updateScene();

    uiLineItem*         getTickLine(int pix);
    uiLineItem*         getGridLine(int pix);
    int                 getNrAnnotCharsForDisp() const;
    void                setVisible(bool);
    void                annotAtEnd(const uiString&);

protected:

    uiGraphicsScene*    scene_;
    uiTextItem*         nameitm_;
    uiTextItem*         endannotitm_;
    uiLineItem*         axislineitm_;

    Setup               setup_;
    bool                islog_;
    StepInterval<float> datarg_;
    float               annotstart_;
    uiBorder            border_;
    int                 ticsz_;
    int                 height_;
    int                 width_;
    int                 reqnrchars_;
    const uiAxisHandler* beghndlr_;
    const uiAxisHandler* endhndlr_;

    int                 pxsizeinotherdir_;
    uiAHPlotAnnotSet&   annots_;
    TypeSet<OD::PlotAnnotation> auxannots_;
    float               endpos_;
    int                 devsz_;
    int                 axsz_;
    bool                rgisrev_;
    bool                ynmtxtvertical_;
    float               rgwidth_;
    float               epsilon_;
    StepInterval<float> annotrg_;
    int                 nrsteps_;

    int                 ticSz() const
                                { return setup_.noaxisannot_ ? 0 : ticsz_; }
    int                 tickEndPix(bool farend) const;
    void                updateAxisLine();
    bool                reCalcAnnotation();
    void                updateName();

    friend class        uiAHPlotAnnotSet;

};

mGlobal(uiTools) void setLine(uiLineItem&,const LineParameters<float>&,
                        const uiAxisHandler& xah,const uiAxisHandler& yah,
                        const Interval<float>* xvalrg = 0);