Pick::Location Class Reference

Pick location in space,. More...

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

Public Attributes
Coord3	pos_
TrcKey	trckey_
Sphere	dir_
BufferString *	text_

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

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

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

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

Pick::Location::Location

(

const Coord3 &

)

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

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

Pick::Location::Location

(

const Location &

)

Pick::Location::~Location

(

)

Member Function Documentation

const BinID& Pick::Location::binID

(

)

const

float Pick::Location::crlDip

(

)

const

const Sphere& Pick::Location::dir

(

)

const

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

protected

bool Pick::Location::fromString

(

const char *

)

Pos::GeomID Pick::Location::geomID

(

)

const

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

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

bool Pick::Location::hasDir ( ) const

inline

bool Pick::Location::hasPos ( ) const

inline

bool Pick::Location::hasText

(

)

const

bool Pick::Location::hasTextKey

(

const char *

key

)

const

bool Pick::Location::hasTrcKey

(

)

const

float Pick::Location::inlDip

(

)

const

bool Pick::Location::is2D

(

)

const

Pos::LineID Pick::Location::lineNr

(

)

const

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

inline

void Pick::Location::operator=

(

const Location &

)

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

inline

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

inline

void Pick::Location::removeTextKey

(

const char *

key

)

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

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

Location& Pick::Location::setDir

(

const Sphere &

)

Location& Pick::Location::setDir

(

const Coord &

)

Location& Pick::Location::setGeomID

(

Pos::GeomID

)

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

Location& Pick::Location::setLineNr

(

Pos::LineID

)

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

inline

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

inline

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

inline

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

inline

Location& Pick::Location::setSurvID	(	Pos::SurvID	,
		bool	updfromcoord = true
	)

Location& Pick::Location::setText

(

const char *

)

make sure it's compatible with the keying system

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

Location& Pick::Location::setTrcKey

(

const TrcKey &

)

Location& Pick::Location::setTrcNr

(

Pos::LineID

)

template<class FT >

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

inline

Pos::SurvID Pick::Location::survID

(

)

const

const BufferString& Pick::Location::text

(

)

const

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

const TrcKey& Pick::Location::trcKey

(

)

const

Pos::TraceID Pick::Location::trcNr

(

)

const

void Pick::Location::unSetText

(

const char *

key

)

float Pick::Location::z ( ) const

inline

Member Data Documentation

Sphere Pick::Location::dir_

Coord3 Pick::Location::pos_

BufferString* Pick::Location::text_

TrcKey Pick::Location::trckey_