PickRetriever Class Reference

Inheritance diagram for PickRetriever:

Public Member Functions
	PickRetriever ()
virtual bool	enable (const TypeSet< int > *allowedsc)=0
virtual NotifierAccess *	finished ()=0
virtual Pos::GeomID	getGeomID () const =0
virtual const TypeSet< int > &	getPickedObjIDs () const =0
virtual const Coord3 &	getPos () const =0
virtual int	getSceneID () const =0
virtual int	getTrcNr () const =0
virtual const ZAxisTransform *	getZAxisTransform () const =0
virtual void	reset ()=0
virtual bool	success () const =0
virtual int	unTransformedSceneID () const =0
virtual bool	waiting () const =0
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const
bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const
void	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
virtual bool	isCapsule () const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...
void	stopReceivingNotifications () const

Static Public Member Functions
static PickRetriever *	getInstance ()
static void	setInstance (PickRetriever *)
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Public Attributes
OD::ButtonState	buttonstate_

Static Protected Attributes
static RefMan< PickRetriever >	instance_

Detailed Description

Interface to when an application wants a pick somewere in a 3D environment. There should normally only be one instance in memory, and that should be accessed via PickRetriever::getInstance().

<>

Constructor & Destructor Documentation

PickRetriever()

PickRetriever::PickRetriever

(

)

Member Function Documentation

enable()

virtual bool PickRetriever::enable ( const TypeSet< int > *  allowedsc )

pure virtual

Sets the object in a state where it's retrieving picks.

Note

if allowedsc is empty or null, picks are allowed in all scenes.

Implemented in uiVisPickRetriever.

finished()

virtual NotifierAccess* PickRetriever::finished ( )

pure virtual

Triggers when it does not look for pick any longer. The outcome can be retrieved bu success(), getPos() and getSceneID().

Implemented in uiVisPickRetriever.

getGeomID()

virtual Pos::GeomID PickRetriever::getGeomID ( ) const

pure virtual

Implemented in uiVisPickRetriever.

getInstance()

static PickRetriever* PickRetriever::getInstance ( )

static

Main access function.

getPickedObjIDs()

virtual const TypeSet<int>& PickRetriever::getPickedObjIDs ( ) const

pure virtual

Implemented in uiVisPickRetriever.

getPos()

virtual const Coord3& PickRetriever::getPos ( ) const

pure virtual

Implemented in uiVisPickRetriever.

getSceneID()

virtual int PickRetriever::getSceneID ( ) const

pure virtual

Implemented in uiVisPickRetriever.

getTrcNr()

virtual int PickRetriever::getTrcNr ( ) const

pure virtual

Implemented in uiVisPickRetriever.

getZAxisTransform()

virtual const ZAxisTransform* PickRetriever::getZAxisTransform ( ) const

pure virtual

Implemented in uiVisPickRetriever.

reset()

virtual void PickRetriever::reset ( )

pure virtual

Implemented in uiVisPickRetriever.

setInstance()

static void PickRetriever::setInstance ( PickRetriever *  )

static

Should normally only be called from application initiation.

success()

virtual bool PickRetriever::success ( ) const

pure virtual

Implemented in uiVisPickRetriever.

unTransformedSceneID()

virtual int PickRetriever::unTransformedSceneID ( ) const

pure virtual

Implemented in uiVisPickRetriever.

waiting()

virtual bool PickRetriever::waiting ( ) const

pure virtual

Implemented in uiVisPickRetriever.

Member Data Documentation

buttonstate_

OD::ButtonState PickRetriever::buttonstate_

instance_

RefMan<PickRetriever> PickRetriever::instance_

staticprotected