Pick::Location Class Reference

Pick location in space,. More...

#include <picklocation.h>

Inheritance diagram for Pick::Location:

Public Member Functions
	Location (const Coord &, double z=0., const Coord3 &dir=Coord3::udf(), const Pos::GeomID &=Pos::GeomID::udf())
	Location (const Coord3 &pos, const Coord3 &dir=Coord3::udf(), const Pos::GeomID &=Pos::GeomID::udf())
	Location (const Coord3 &pos, const Sphere &dir, const Pos::GeomID &=Pos::GeomID::udf())
	Location (const Location &)
	Location (double x=0., double y=0., double z=0., const Coord3 &dir=Coord3::udf(), const Pos::GeomID &=Pos::GeomID::udf())
	~Location ()
float	crlDip () const
const Sphere &	dir () const
bool	fromString (const char *)
	< make sure it's compatible with the keying system
bool	getKeyedText (const char *key, BufferString &) const
bool	getText (const char *key, BufferString &) const
bool	hasDir () const
bool	hasText () const
bool	hasTextKey (const char *key) const
float	inlDip () const
bool	operator!= (const Location &oth) const
void	operator= (const Location &)
bool	operator== (const Location &oth) const
void	removeTextKey (const char *key)
void	setDip (float, float)
Location &	setDir (const Coord &)
Location &	setDir (const Sphere &)
void	setKeyedText (const char *key, const char *txt)
Location &	setText (const char *)
void	setText (const char *key, const char *txt)
const BufferString &	text () const
void	toString (BufferString &, bool forexport=false, const Coords::CoordSystem *crs=0) const
void	unSetText (const char *key)
Public Member Functions inherited from LocationBase
	LocationBase (const Coord &, double z=0., const Pos::GeomID &=Pos::GeomID::udf())
	LocationBase (const Coord3 &, const Pos::GeomID &=Pos::GeomID::udf())
	LocationBase (const LocationBase &)
	LocationBase (double x=0., double y=0., double z=0., const Pos::GeomID &=Pos::GeomID::udf())
	~LocationBase ()
const BinID &	binID () const
Pos::GeomID	geomID () const
OD::GeomSystem	geomSystem () const
bool	hasPos () const
bool	hasTrcKey () const
bool	is2D () const
Pos::LineID	lineNr () const
bool	operator!= (const LocationBase &) const
void	operator= (const LocationBase &)
bool	operator== (const LocationBase &) const
const Coord3 &	pos () const
void	setBinID (const BinID &, bool updcoord=false)
void	setGeomID (const Pos::GeomID &)
void	setGeomSystem (OD::GeomSystem, bool updfromcoord=true)
void	setLineNr (Pos::LineID)
void	setPos (const Coord &)
void	setPos (const Coord &c, float zval)
void	setPos (const Coord3 &)
void	setPos (double x, double y, double zval)
void	setTrcKey (const TrcKey &)
void	setTrcNr (Pos::LineID)
template<class T >
void	setZ (T zval)
const TrcKey &	trcKey () const
Pos::TraceID	trcNr () const
float	z () const

Protected Member Functions
bool	fndKeyTxt (const char *, BufferString *) const

Protected Attributes
Sphere	dir_
BufferString *	text_
Protected Attributes inherited from LocationBase
Coord3	pos_ = Coord3::udf()
TrcKey	trckey_ = TrcKey::udf()

Detailed Description

Pick location in space,.

A pick location always has a position in X, Y and Z ('pos()'). If asked, you'll always get the corresponding TrcKey. But, the TrcKey may not be stored as such. If this matters, try hasTrcKey(). If there is no available TrcKey, then it will be generated from the default survey geometry.

A Location has an optional text. This has to be used as a keyed storage like: key1'xx'key2'yy If no text is available, you'll get an empty string.

A Location also has an optional direction: phi is defined as the direction's counter-clockwise angle from the x-axis in the x-y plane. theta is defined as the directions angle from the upward pointing z axis (i.e. opposite to survey-z-axis). Theta and the radius are defined after the SI().zFactor is applied to the z-coordinate. If no direction is available, you'll get nullSphere().

<>

Constructor & Destructor Documentation

Location() [1/5]

Pick::Location::Location	(	const Coord3 &	pos,
		const Coord3 &	dir = Coord3::udf(),
		const Pos::GeomID &	= Pos::GeomID::udf() )

Location() [2/5]

Pick::Location::Location	(	const Coord3 &	pos,
		const Sphere &	dir,
		const Pos::GeomID &	= Pos::GeomID::udf() )

Location() [3/5]

Pick::Location::Location	(	const Coord &	,
		double	z = 0.,
		const Coord3 &	dir = Coord3::udf(),
		const Pos::GeomID &	= Pos::GeomID::udf() )

Location() [4/5]

Pick::Location::Location	(	double	x = 0.,
		double	y = 0.,
		double	z = 0.,
		const Coord3 &	dir = Coord3::udf(),
		const Pos::GeomID &	= Pos::GeomID::udf() )

Location() [5/5]

Pick::Location::Location

(

const Location &

)

~Location()

Pick::Location::~Location

(

)

Member Function Documentation

crlDip()

float Pick::Location::crlDip

(

)

const

dir()

const Sphere & Pick::Location::dir

(

)

const

fndKeyTxt()

bool Pick::Location::fndKeyTxt ( const char * , BufferString *  ) const

protected

fromString()

bool Pick::Location::fromString

(

const char *

)

< make sure it's compatible with the keying system

getKeyedText()

bool Pick::Location::getKeyedText	(	const char *	key,
		BufferString &	) const

getText()

bool Pick::Location::getText	(	const char *	key,
		BufferString &	) const

hasDir()

bool Pick::Location::hasDir ( ) const

inline

hasText()

bool Pick::Location::hasText

(

)

const

hasTextKey()

bool Pick::Location::hasTextKey

(

const char *

key

)

const

inlDip()

float Pick::Location::inlDip

(

)

const

operator!=()

bool Pick::Location::operator!= ( const Location & oth ) const

inline

operator=()

void Pick::Location::operator=

(

const Location &

)

operator==()

bool Pick::Location::operator== ( const Location & oth ) const

inline

removeTextKey()

void Pick::Location::removeTextKey

(

const char *

key

)

setDip()

void Pick::Location::setDip	(	float	,
		float	)

setDir() [1/2]

Location & Pick::Location::setDir

(

const Coord &

)

setDir() [2/2]

Location & Pick::Location::setDir

(

const Sphere &

)

setKeyedText()

void Pick::Location::setKeyedText	(	const char *	key,
		const char *	txt )

setText() [1/2]

Location & Pick::Location::setText

(

const char *

)

setText() [2/2]

void Pick::Location::setText	(	const char *	key,
		const char *	txt )

text()

const BufferString & Pick::Location::text

(

)

const

toString()

void Pick::Location::toString	(	BufferString &	,
		bool	forexport = false,
		const Coords::CoordSystem *	crs = 0 ) const

unSetText()

void Pick::Location::unSetText

(

const char *

key

)

Member Data Documentation

dir_

Sphere Pick::Location::dir_

protected

text_

BufferString* Pick::Location::text_

protected