coltabsequence.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H. Bril
 Date:          23-3-2000
________________________________________________________________________

-*/


#include "coltab.h"
#include "enums.h"
#include "uistring.h"
#include "sharedobject.h"


namespace ColTab
{

class SequenceManager;


mExpClass(General) Sequence : public SharedObject
{
public:

    typedef TypeSet<PosType>::size_type size_type;
    typedef size_type                   IdxType;
    typedef unsigned char               CompType;
    typedef std::pair<PosType,CompType> TranspPtType;

    enum Status         { System, Edited, Added };
                        mDeclareEnumUtils(Status);

                        Sequence();             
                        Sequence(const char*);  
                        mDeclInstanceCreatedNotifierAccess(Sequence);
                        mDeclMonitorableAssignment(Sequence);

    Color               color(PosType) const; 

    Status              status() const;
    inline bool         isSys() const           { return status()==System; }
    mImplSimpleMonitoredGetSet(inline,disabled,setDisabled,bool,disabled_,
                                                    cStatusChange())
    uiString            statusDispStr() const;

    inline bool         isEmpty() const         { return size() < 1; }
    size_type           size() const;
    PosType             position(IdxType) const;
    CompType            r(IdxType) const;
    CompType            g(IdxType) const;
    CompType            b(IdxType) const;

    size_type           transparencySize() const;
    TranspPtType        transparency(IdxType) const;
    CompType            transparencyAt(PosType) const;
    void                setTransparency(TranspPtType);
    void                changeTransparency(IdxType,TranspPtType);
    void                removeTransparencies();
    void                removeTransparencyAt(IdxType);
    bool                hasTransparency() const;

    mImplSimpleMonitoredGetSet(inline,nrSegments,setNrSegments,size_type,
                                    nrsegments_,cSegmentationChange())
    bool                isSegmentized() const           { return nrSegments(); }

    void                changeColor(IdxType,CompType,CompType,CompType);
    void                changePos(IdxType,PosType);
    IdxType             setColor(PosType, 
                                 CompType,CompType,CompType);
    void                removeColor(IdxType);
    void                removeAllColors();

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

    mImplSimpleMonitoredGetSet(inline,undefColor,setUndefColor,
                                Color,undefcolor_,cUdfColChange())
    mImplSimpleMonitoredGetSet(inline,markColor,setMarkColor,
                                Color,markcolor_,cMarkColChange())

    static ChangeType   cStatusChange()         { return 3; }
    static ChangeType   cColorChange()          { return 4; }
    static ChangeType   cTransparencyChange()   { return 5; }
    static ChangeType   cSegmentationChange()   { return 6; }
    static ChangeType   cMarkColChange()        { return 7; }
    static ChangeType   cUdfColChange()         { return 8; }

    static const char*  sKeyValCol();
    static const char*  sKeyMarkColor();
    static const char*  sKeyUdfColor();
    static const char*  sKeyTransparency();
    static const char*  sKeyCtbl();
    static const char*  sKeyNrSegments();
    static const char*  sKeyDisabled();
    static const char*  sDefaultName(bool for_seismics=false);

protected:

                        ~Sequence();

    TypeSet<PosType>    x_;
    TypeSet<CompType>   r_;
    TypeSet<CompType>   g_;
    TypeSet<CompType>   b_;
    TypeSet<TranspPtType> tr_;

    size_type           nrsegments_     = 0;
    Color               undefcolor_     = Color::LightGrey();
    Color               markcolor_      = Color::DgbColor();
    bool                disabled_       = false;

    inline size_type    gtSize() const  { return x_.size(); }

    PosType             snapToSegmentCenter(PosType) const;
    CompType            gtTransparencyAt(PosType) const;
    bool                chgColor(IdxType,CompType,CompType,CompType);
    bool                rmColor(IdxType);
    void                emitStatusChg() const;

    friend class        SequenceManager;

};


} // namespace ColTab