Pick::Location Class Reference

Pick location in space,. More...

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

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

Protected Attributes
Sphere	dir_
Coord3	pos_
BufferString *	text_
TrcKey	trckey_

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/6]

Pick::Location::Location	(	double	x = 0,
		double	y = 0,
		double	z = 0
	)

Location() [2/6]

Pick::Location::Location	(	const Coord &	,
		float	z = 0
	)

Location() [3/6]

Pick::Location::Location

(

const Coord3 &

)

Location() [4/6]

Pick::Location::Location	(	const Coord3 &	pos,
		const Coord3 &	dir
	)

Location() [5/6]

Pick::Location::Location	(	const Coord3 &	pos,
		const Sphere &	dir
	)

Location() [6/6]

Pick::Location::Location

(

const Location &

)

~Location()

Pick::Location::~Location

(

)

Member Function Documentation

binID()

const BinID& Pick::Location::binID

(

)

const

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 *

)

geomID()

Pos::GeomID Pick::Location::geomID

(

)

const

geomSystem()

OD::GeomSystem Pick::Location::geomSystem

(

)

const

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

hasPos()

bool Pick::Location::hasPos ( ) const

inline

hasText()

bool Pick::Location::hasText

(

)

const

hasTextKey()

bool Pick::Location::hasTextKey

(

const char *

key

)

const

hasTrcKey()

bool Pick::Location::hasTrcKey

(

)

const

inlDip()

float Pick::Location::inlDip

(

)

const

is2D()

bool Pick::Location::is2D

(

)

const

lineNr()

Pos::LineID Pick::Location::lineNr

(

)

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

pos()

const Coord3& Pick::Location::pos ( ) const

inline

removeTextKey()

void Pick::Location::removeTextKey

(

const char *

key

)

setBinID()

Location& Pick::Location::setBinID	(	const BinID &	,
		bool	updcoord = false
	)

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 &

)

setGeomID()

Location& Pick::Location::setGeomID

(

Pos::GeomID

)

setGeomSystem()

Location& Pick::Location::setGeomSystem	(	OD::GeomSystem	,
		bool	updfromcoord = true
	)

setKeyedText()

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

setLineNr()

Location& Pick::Location::setLineNr

(

Pos::LineID

)

setPos() [1/4]

Location& Pick::Location::setPos ( const Coord &  c )

inline

setPos() [2/4]

Location& Pick::Location::setPos ( const Coord &  c, float  zval  )

inline

setPos() [3/4]

Location& Pick::Location::setPos ( const Coord3 &  c )

inline

setPos() [4/4]

Location& Pick::Location::setPos ( double  x, double  y, double  zval  )

inline

setSurvID()

Location& Pick::Location::setSurvID	(	OD::GeomSystem	,
		bool	updfromcoord = true
	)

setText() [1/2]

Location& Pick::Location::setText

(

const char *

)

make sure it's compatible with the keying system

setText() [2/2]

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

setTrcKey()

Location& Pick::Location::setTrcKey

(

const TrcKey &

)

setTrcNr()

Location& Pick::Location::setTrcNr

(

Pos::LineID

)

setZ()

template<class FT >

Location& Pick::Location::setZ ( FT  zval )

inline

survID()

OD::GeomSystem Pick::Location::survID

(

)

const

text()

const BufferString& Pick::Location::text

(

)

const

toString()

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

trcKey()

const TrcKey& Pick::Location::trcKey

(

)

const

trcNr()

Pos::TraceID Pick::Location::trcNr

(

)

const

unSetText()

void Pick::Location::unSetText

(

const char *

key

)

z()

float Pick::Location::z ( ) const

inline

Member Data Documentation

dir_

Sphere Pick::Location::dir_

protected

pos_

Coord3 Pick::Location::pos_

protected

text_

BufferString* Pick::Location::text_

protected

trckey_

TrcKey Pick::Location::trckey_

protected