OpendTect  7.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
FlatView::Viewer Class Referenceabstract
General

Flat Viewer using FlatView::Data and FlatView::Appearance. More...

Inheritance diagram for FlatView::Viewer:
[legend]

Public Types

enum  DataChangeType {
  All =0xFFFFFFFF , BitmapData =0x0001 , DisplayPars =0x0002 , Annot =0x0004 ,
  Auxdata =0x0008
}
 
enum  VwrDest { WVA , VD , Both , None }
 

Public Member Functions

 Viewer ()
 
virtual ~Viewer ()
 
virtual void addAuxData (AuxData *a)=0
 
void addPack (::DataPackID)
 
virtual Appearance & appearance ()
 
const Appearance & appearance () const
 
const TypeSet< ::DataPackID > & availablePacks () const
 
void clearAllPacks ()
 
virtual AuxData * createAuxData (const char *nm) const =0
 
void disableStatusBarUpdate ()
 
bool enableChange (bool yn)
 Returns previous state. More...
 
void enableStatusBarUpdate ()
 
virtual void fillAppearancePar (IOPar &iop) const
 Does not store any data, just how data is displayed. More...
 
const TypeSet< Pos::GeomID > & getAllSeisGeomids () const
 
virtual int getAnnotChoice (BufferStringSet &) const
 
virtual const AuxData * getAuxData (int idx) const =0
 
virtual AuxData * getAuxData (int idx)=0
 
void getAuxInfo (const Point &, IOPar &) const
 
Coord3 getCoord (const Point &) const
 
StepInterval< double > getDataPackRange (bool forx1) const
 
virtual Interval< float > getDataRange (bool wva) const
 
WeakPtr< FlatDataPack > getPack (bool wva, bool checkother=false) const
 
ZAxisTransform * getZAxisTransform () const
 
virtual void handleChange (unsigned int datachangetype)=0
 
bool hasPack (bool wva) const
 
bool hasZAxisTransform () const
 
bool isAvailable (::DataPackID id) const
 
virtual bool isVertical () const
 
bool isVisible (bool wva) const
 
bool isVisible (VwrDest) const
 
bool needStatusBarUpdate () const
 
virtual int nrAuxData () const =0
 
int nrDec () const
 
const FlatDataPack * obtainPack (bool wva, bool checkother=false) const
 
DataPackID packID (bool wva) const
 
virtual void reGenerate (AuxData &)
 
virtual void remove (const AuxData &)
 
void removeAllAuxData ()
 
virtual AuxData * removeAuxData (AuxData *a)=0
 
virtual AuxData * removeAuxData (int idx)=0
 
void removeAuxDatas (ObjectSet< AuxData > &)
 
virtual void removePack (::DataPackID)
 Releases DataPack after removing from the list. More...
 
void removePack (VwrDest)
 
void removeUnusedPacks ()
 
virtual void setAnnotChoice (int selannot)
 
void setPack (bool wva, ::DataPackID id, bool usedefs=true)
 
void setPack (VwrDest, FlatDataPack *, bool usedefs=true)
 Sets datapack to use on either wva or vd or both. More...
 
void setPack (VwrDest,::DataPackID, bool usedefs=true)
 
void setSeisGeomidsToViewer (TypeSet< Pos::GeomID > &)
 
void setVisible (bool wva, bool visibility)
 
bool setVisible (VwrDest, bool visibility, od_uint32 *ctype=nullptr)
 
bool setZAxisTransform (ZAxisTransform *)
 
void setZDomain (const ZDomain::Def &)
 
virtual void showAuxDataObjects (AuxData &, bool)
 
void storeDefaults (const char *key) const
 
virtual void updateProperties (const AuxData &)
 
virtual void useAppearancePar (const IOPar &iop)
 
void usePack (bool wva, ::DataPackID id, bool usedefs=true)
 
void usePack (VwrDest,::DataPackID, bool usedefs=true)
 
void useStoredDefaults (const char *key)
 
const ZDomain::Info & zDomain () const
 

Static Public Member Functions

static VwrDest getDest (bool dowva, bool dovd)
 
static const char * sKeyIsZSlice ()
 
static const char * sKeyVDData ()
 
static const char * sKeyVDVal ()
 
static const char * sKeyViewZnrDec ()
 
static const char * sKeyWVAData ()
 
static const char * sKeyWVAVal ()
 

Protected Member Functions

void addAuxInfo (bool, const Point &, IOPar &) const
 
bool shouldHandleChange () const
 

Protected Attributes

FlatView_CB_Rcvr * cbrcvr_
 
ZAxisTransform * datatransform_ = nullptr
 
Appearance * defapp_ = nullptr
 
DataPackMgr & dpm_
 
TypeSet< ::DataPackID > ids_
 
Threads::Lock lock_
 
bool needstatusbarupd_ = true
 
ZDomain::Info * zdinfo_
 

Private Attributes

bool canhandlechange_ = true
 
TypeSet< Pos::GeomID > geom2dids_
 
WeakPtr< FlatDataPack > vdpack_ = nullptr
 
WeakPtr< FlatDataPack > wvapack_ = nullptr
 

Detailed Description

Flat Viewer using FlatView::Data and FlatView::Appearance.

Interface for displaying data and related annotations where at least one of the directions is sampled regularly.

The viewer works with FlatDataPacks - period. in previous versions, you could pass 'loose' data but DataPacks are so neat&clean we got rid of this possibility.

You can attach many datapacks to the viewer; the different modes (WVA, VD) can be attached to zero or one of those packs.

addPack() -> add a DataPack to the list of available data packs usePack() -> sets one of the available packs for wva or vd display or both setPack() -> Combination of addPack and usePack. removePack() -> removes this pack from the available packs, if necessary it also clears the wva or vd display to no display.

<>

Member Enumeration Documentation

◆ DataChangeType

enum FlatView::Viewer::DataChangeType
Enumerator
All 
BitmapData 
DisplayPars 
Annot 
Auxdata 

◆ VwrDest

enum FlatView::Viewer::VwrDest
Enumerator
WVA 
VD 
Both 
None 

Constructor & Destructor Documentation

◆ Viewer()

FlatView::Viewer::Viewer ( )

◆ ~Viewer()

virtual FlatView::Viewer::~Viewer ( )
virtual

Member Function Documentation

◆ addAuxData()

virtual void FlatView::Viewer::addAuxData ( AuxData *  a)
pure virtual

Implemented in uiFlatViewer, and visBase::FlatViewer.

◆ addAuxInfo()

void FlatView::Viewer::addAuxInfo ( bool  ,
const Point &  ,
IOPar &   
) const
protected

◆ addPack()

void FlatView::Viewer::addPack ( ::DataPackID  )

Adds to list and obtains the DataPack, but does not use for WVA or VD. DataPack gets released in the destructor of this class.

◆ appearance() [1/2]

virtual Appearance& FlatView::Viewer::appearance ( )
virtual

◆ appearance() [2/2]

const Appearance& FlatView::Viewer::appearance ( ) const
inline

◆ availablePacks()

const TypeSet< ::DataPackID>& FlatView::Viewer::availablePacks ( ) const
inline

◆ clearAllPacks()

void FlatView::Viewer::clearAllPacks ( )

◆ createAuxData()

virtual AuxData* FlatView::Viewer::createAuxData ( const char *  nm) const
pure virtual

Implemented in uiFlatViewer, and visBase::FlatViewer.

◆ disableStatusBarUpdate()

void FlatView::Viewer::disableStatusBarUpdate ( )
inline

◆ enableChange()

bool FlatView::Viewer::enableChange ( bool  yn)

Returns previous state.

◆ enableStatusBarUpdate()

void FlatView::Viewer::enableStatusBarUpdate ( )
inline

◆ fillAppearancePar()

virtual void FlatView::Viewer::fillAppearancePar ( IOPar &  iop) const
inlinevirtual

Does not store any data, just how data is displayed.

◆ getAllSeisGeomids()

const TypeSet<Pos::GeomID>& FlatView::Viewer::getAllSeisGeomids ( ) const

◆ getAnnotChoice()

virtual int FlatView::Viewer::getAnnotChoice ( BufferStringSet &  ) const
inlinevirtual

◆ getAuxData() [1/2]

virtual const AuxData* FlatView::Viewer::getAuxData ( int  idx) const
pure virtual

Implemented in visBase::FlatViewer, and uiFlatViewer.

◆ getAuxData() [2/2]

virtual AuxData* FlatView::Viewer::getAuxData ( int  idx)
pure virtual

Implemented in visBase::FlatViewer, and uiFlatViewer.

◆ getAuxInfo()

void FlatView::Viewer::getAuxInfo ( const Point &  ,
IOPar &   
) const

◆ getCoord()

Coord3 FlatView::Viewer::getCoord ( const Point &  ) const

◆ getDataPackRange()

StepInterval<double> FlatView::Viewer::getDataPackRange ( bool  forx1) const

◆ getDataRange()

virtual Interval<float> FlatView::Viewer::getDataRange ( bool  wva) const
virtual

Reimplemented in visBase::FlatViewer.

◆ getDest()

static VwrDest FlatView::Viewer::getDest ( bool  dowva,
bool  dovd 
)
static

◆ getPack()

WeakPtr<FlatDataPack> FlatView::Viewer::getPack ( bool  wva,
bool  checkother = false 
) const
Parameters
wvaif true, wiggle, else variable density
checkotherif true, the datapack of other display (i.e. variable density or wiggles) is returned if the specified display has no datapack.

◆ getZAxisTransform()

ZAxisTransform* FlatView::Viewer::getZAxisTransform ( ) const
inline

◆ handleChange()

virtual void FlatView::Viewer::handleChange ( unsigned int  datachangetype)
pure virtual
Parameters
datachangetypecan be any combination of DataChangeType.

Implemented in uiFlatViewer.

◆ hasPack()

bool FlatView::Viewer::hasPack ( bool  wva) const
inline

◆ hasZAxisTransform()

bool FlatView::Viewer::hasZAxisTransform ( ) const
inline

◆ isAvailable()

bool FlatView::Viewer::isAvailable ( ::DataPackID  id) const
inline

◆ isVertical()

virtual bool FlatView::Viewer::isVertical ( ) const
inlinevirtual

◆ isVisible() [1/2]

bool FlatView::Viewer::isVisible ( bool  wva) const

◆ isVisible() [2/2]

bool FlatView::Viewer::isVisible ( VwrDest  ) const

◆ needStatusBarUpdate()

bool FlatView::Viewer::needStatusBarUpdate ( ) const
inline

◆ nrAuxData()

virtual int FlatView::Viewer::nrAuxData ( ) const
pure virtual

Implemented in visBase::FlatViewer, and uiFlatViewer.

◆ nrDec()

int FlatView::Viewer::nrDec ( ) const

◆ obtainPack()

const FlatDataPack* FlatView::Viewer::obtainPack ( bool  wva,
bool  checkother = false 
) const

◆ packID()

DataPackID FlatView::Viewer::packID ( bool  wva) const

◆ reGenerate()

virtual void FlatView::Viewer::reGenerate ( AuxData &  )
inlinevirtual

Reimplemented in uiFlatViewer.

◆ remove()

virtual void FlatView::Viewer::remove ( const AuxData &  )
inlinevirtual

◆ removeAllAuxData()

void FlatView::Viewer::removeAllAuxData ( )

◆ removeAuxData() [1/2]

virtual AuxData* FlatView::Viewer::removeAuxData ( AuxData *  a)
pure virtual

Implemented in visBase::FlatViewer, and uiFlatViewer.

◆ removeAuxData() [2/2]

virtual AuxData* FlatView::Viewer::removeAuxData ( int  idx)
pure virtual

Implemented in visBase::FlatViewer, and uiFlatViewer.

◆ removeAuxDatas()

void FlatView::Viewer::removeAuxDatas ( ObjectSet< AuxData > &  )

◆ removePack() [1/2]

virtual void FlatView::Viewer::removePack ( ::DataPackID  )
virtual

Releases DataPack after removing from the list.

Reimplemented in uiFlatViewer.

◆ removePack() [2/2]

void FlatView::Viewer::removePack ( VwrDest  )

◆ removeUnusedPacks()

void FlatView::Viewer::removeUnusedPacks ( )

◆ setAnnotChoice()

virtual void FlatView::Viewer::setAnnotChoice ( int  selannot)
inlinevirtual

Reimplemented in uiFlatViewer.

◆ setPack() [1/3]

void FlatView::Viewer::setPack ( bool  wva,
::DataPackID  id,
bool  usedefs = true 
)
inline

◆ setPack() [2/3]

void FlatView::Viewer::setPack ( VwrDest  ,
FlatDataPack *  ,
bool  usedefs = true 
)

Sets datapack to use on either wva or vd or both.

◆ setPack() [3/3]

void FlatView::Viewer::setPack ( VwrDest  ,
::DataPackID  ,
bool  usedefs = true 
)

◆ setSeisGeomidsToViewer()

void FlatView::Viewer::setSeisGeomidsToViewer ( TypeSet< Pos::GeomID > &  )

◆ setVisible() [1/2]

void FlatView::Viewer::setVisible ( bool  wva,
bool  visibility 
)
inline

◆ setVisible() [2/2]

bool FlatView::Viewer::setVisible ( VwrDest  ,
bool  visibility,
od_uint32 *  ctype = nullptr 
)

Will also handleChange unless ctype is provided, So, do not use unless you want both. returns if handled

◆ setZAxisTransform()

bool FlatView::Viewer::setZAxisTransform ( ZAxisTransform *  )

◆ setZDomain()

void FlatView::Viewer::setZDomain ( const ZDomain::Def &  )

◆ shouldHandleChange()

bool FlatView::Viewer::shouldHandleChange ( ) const
inlineprotected

◆ showAuxDataObjects()

virtual void FlatView::Viewer::showAuxDataObjects ( AuxData &  ,
bool   
)
inlinevirtual

◆ sKeyIsZSlice()

static const char* FlatView::Viewer::sKeyIsZSlice ( )
static

◆ sKeyVDData()

static const char* FlatView::Viewer::sKeyVDData ( )
static

◆ sKeyVDVal()

static const char* FlatView::Viewer::sKeyVDVal ( )
static

◆ sKeyViewZnrDec()

static const char* FlatView::Viewer::sKeyViewZnrDec ( )
static

◆ sKeyWVAData()

static const char* FlatView::Viewer::sKeyWVAData ( )
static

◆ sKeyWVAVal()

static const char* FlatView::Viewer::sKeyWVAVal ( )
static

◆ storeDefaults()

void FlatView::Viewer::storeDefaults ( const char *  key) const

◆ updateProperties()

virtual void FlatView::Viewer::updateProperties ( const AuxData &  )
inlinevirtual

◆ useAppearancePar()

virtual void FlatView::Viewer::useAppearancePar ( const IOPar &  iop)
inlinevirtual

Does not retrieve any data, just how data is displayed

◆ usePack() [1/2]

void FlatView::Viewer::usePack ( bool  wva,
::DataPackID  id,
bool  usedefs = true 
)
inline

◆ usePack() [2/2]

void FlatView::Viewer::usePack ( VwrDest  ,
::DataPackID  ,
bool  usedefs = true 
)

◆ useStoredDefaults()

void FlatView::Viewer::useStoredDefaults ( const char *  key)

◆ zDomain()

const ZDomain::Info& FlatView::Viewer::zDomain ( ) const

Member Data Documentation

◆ canhandlechange_

bool FlatView::Viewer::canhandlechange_ = true
private

◆ cbrcvr_

FlatView_CB_Rcvr* FlatView::Viewer::cbrcvr_
protected

◆ datatransform_

ZAxisTransform* FlatView::Viewer::datatransform_ = nullptr
protected

◆ defapp_

Appearance* FlatView::Viewer::defapp_ = nullptr
protected

◆ dpm_

DataPackMgr& FlatView::Viewer::dpm_
protected

◆ geom2dids_

TypeSet<Pos::GeomID> FlatView::Viewer::geom2dids_
private

◆ ids_

TypeSet< ::DataPackID> FlatView::Viewer::ids_
protected

◆ lock_

Threads::Lock FlatView::Viewer::lock_
mutableprotected

◆ needstatusbarupd_

bool FlatView::Viewer::needstatusbarupd_ = true
protected

◆ vdpack_

WeakPtr<FlatDataPack> FlatView::Viewer::vdpack_ = nullptr
private

◆ wvapack_

WeakPtr<FlatDataPack> FlatView::Viewer::wvapack_ = nullptr
private

◆ zdinfo_

ZDomain::Info* FlatView::Viewer::zdinfo_
protected

Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B.V. 1995-2024