pickset.h

Go to the documentation of this file.

#ifndef pickset_h
#define pickset_h

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Bert
 Date:          May 2001 / Mar 2016
 Contents:      PickSet base classes
 RCS:           $Id$
________________________________________________________________________

-*/

#include "picklocation.h"
#include "enums.h"
#include "namedobj.h"
#include "trckey.h"
#include "sets.h"
#include "draw.h"
#include "tableascio.h"
template <class T> class ODPolygon;


namespace Pick
{

mExpClass(General) Set : public NamedObject, public TypeSet<Location>
{
public:
                        Set(const char* nm=0);
                        Set(const Set&);
                        ~Set();

    Set&                operator =(const Set&);

    struct Disp
    {
                        Disp()
                            : color_(Color::NoColor())
                            , markertype_(3) // Sphere
                            , connect_(None)
                            , pixsize_(3)               {}
        enum Connection { None, Open, Close };
                        mDeclareEnumUtils(Connection);
        Color           color_;         
        int             pixsize_;       
        int             markertype_;    
        Connection      connect_;       
    };

    Disp                disp_;
    IOPar&              pars_;
    bool                is2D() const;
    Pos::SurvID         getSurvID() const;

    bool                isPolygon() const;
    void                getPolygon(ODPolygon<double>&,int idx=0) const;
    void                getLocations(ObjectSet<Location>&,int idx=0);
    void                getLocations(ObjectSet<const Location>&,int idx=0)const;
    float               getXYArea(int idx=0) const;
    size_type           find(const TrcKey&) const;
    size_type           nearestLocation(const Coord&) const;
    size_type           nearestLocation(const Coord3&,bool ignorez=false) const;

    static const char*  sKeyMarkerType()        { return "Marker Type"; }
    void                fillPar(IOPar&) const;
    bool                usePar(const IOPar&);
    void                fillDisplayPars(IOPar&) const;
    bool                useDisplayPars(const IOPar&);
    bool                writeDisplayPars() const;

    void                removeSingleWithUndo(size_type idx);
    void                insertWithUndo(size_type,const Pick::Location&);
    void                appendWithUndo(const Pick::Location&);
    void                moveWithUndo(size_type,const Pick::Location&,
                                        const Pick::Location&);

    inline Location&    get( size_type idx )            { return (*this)[idx]; }
    inline const Location& get( size_type idx ) const   { return (*this)[idx]; }

    void                setReadOnly( bool yn )          { readonly_ = yn; }
    bool                isReadOnly() const              { return readonly_; }

    // The following stuff with indexes is a kludge that will be replaced
    // by the Group Label in 7.X
    void                addStartIdx(int locidx);
    void                setStartIdx(int setidx,int locidx);
    int                 nrSets() const          { return startidxs_.size(); }
    void                getStartStopIdx(int setidx,int& start,int&stop) const;
    const TypeSet<int>& startIndexs() const { return startidxs_; }

    bool                isSizeLargerThanThreshold() const;
    static const char*  sKeyThresholdSize()
                        { return "PointSet Size Threshold";}
    static const char*  sKeyUseThreshold()
                        { return "Use PointSet Size Threshold";}
    static int          getSizeThreshold();

private:

    enum EventType      { Insert, PolygonClose, Remove, Move };
    void                addUndoEvent(EventType,size_type,const Pick::Location&);

    TypeSet<int>        startidxs_;
    bool                readonly_;

};

mExpClass(General) List : public ObjectSet<Location>
{
public:

                        List()                          {}
                        List( const Pick::Set& ps )     { addAll( ps ); }

    List&               add(const Pick::Location&,bool mkcopy=false);
    inline void         addAll( const Pick::Set& ps )
                        { const_cast<Pick::Set&>(ps).getLocations(*this); }

    inline bool         is2D() const;
    inline Pos::SurvID  getSurvID() const;
    size_type           find(const TrcKey&) const;
    size_type           nearestLocation(const Coord&) const;
    size_type           nearestLocation(const Coord3&,bool ignorez=false) const;

    inline Location&    get( size_type idx )            { return *(*this)[idx];}
    inline const Location& get( size_type idx ) const   { return *(*this)[idx];}

};


template <class PicksType>
inline bool is2D( const PicksType& picks )
{
    return TrcKey::is2D( picks.getSurvID() );
}

template <class PicksType>
inline bool getSurvID( const PicksType& picks )
{
    return picks.isEmpty() ? false : picks.get(0).trcKey().survID();
}

inline bool Pick::List::is2D() const            { return Pick::is2D( *this ); }
inline Pos::SurvID Pick::List::getSurvID() const
{ return Pick::getSurvID( *this ); }


} // namespace Pick


mExpClass(General) PickSetAscIO : public Table::AscIO
{
public:
                                PickSetAscIO( const Table::FormatDesc& fd )
                                    : Table::AscIO(fd)          {}

    static Table::FormatDesc*   getDesc(bool iszreq);
    static void                 updateDesc(Table::FormatDesc&,bool iszreq);
    static void                 createDescBody(Table::FormatDesc*,bool iszreq);

    bool                        isXY() const;
    bool                        get(od_istream&,Pick::Set&,bool iszreq,
                                    float zval) const;
};


/* This include will go away after 6.0 */
#include "picksetmgr.h"


#endif