#include <RegionTool.h>

Inheritance diagram for casa::RegionTool:

Classes
class	State

Public Types
enum	RegionToolTypes { POLYTOOL, RECTTOOL, POINTTOOL, ELLIPSETOOL, POLYLINETOOL, PVLINETOOL }

typedef std::map < viewer::Region *, viewer::region::PointInfo >	region_map_type

Public Member Functions
	RegionTool (Display::KeySym keysym=Display::K_Pointer_Button1)
	Constructor taking the primary key to which this tool will respond. More...

	~RegionTool ()

void	keyPressed (const WCPositionEvent &ev)
	Functions called by the local event handling operators - by default they do nothing, so a derived class needs only implement the events it cares about. More...

void	keyReleased (const WCPositionEvent &)

void	otherKeyPressed (const WCPositionEvent &)

void	otherKeyReleased (const WCPositionEvent &)

void	moved (const WCMotionEvent &ev, const viewer::region::region_list_type &)

void	draw (const WCRefreshEvent &, const viewer::region::region_list_type &)
	Draw whatever should be drawn (if anything) on current WC. More...

virtual void	checkPoint (WorldCanvas *wc, State &state)=0
	this is a non-const function because a non-const RegionTool ptr is returned in 'state' which can then be used for setting the state of the regions managed by the various tools.... More...

virtual bool	create (viewer::region::RegionTypes, WorldCanvas , const std::vector< std::pair< double, double > > &, const std::string &, viewer::region::TextPosition, const std::vector< int > &, const std::string &, int, int, const std::string &, const std::string &, viewer::region::LineStyle, unsigned int, bool, VOID )=0
	create regions of various types (e.g. More...

void	enable ()
	DISPLAY_PURE_VIRTUAL(RegionTool::create,true);. More...

void	disable ()

virtual RegionToolTypes	type () const =0

virtual void	revokeRegion (viewer::Region *)=0
	called when the user (read GUI user) indicates that a region should be deleted... More...

Public Member Functions inherited from casa::MultiWCTool
	MultiWCTool (const Display::KeySym &keysym=Display::K_Pointer_Button1, bool enable_events=true)
	Constructor taking the primary key to which this tool will respond. More...

virtual	~MultiWCTool ()
	Destructor. More...

virtual void	addWorldCanvas (WorldCanvas &worldcanvas)
	Add/remove a WorldCanvas from the control of this tool. More...

virtual void	removeWorldCanvas (WorldCanvas &worldcanvas)

virtual void	addWorldCanvases (PanelDisplay *pdisp)
	Add/Remove a list of WorldCanvases from PanelDisplay. More...

virtual void	removeWorldCanvases (PanelDisplay *pdisp)

virtual void	operator() (const WCPositionEvent &ev)
	Required operators for event handling - these are called when events occur, and distribute the events to the "user-level" methods. More...

virtual void	operator() (const WCMotionEvent &ev)
	default sends event to cout More...

virtual void	operator() (const WCRefreshEvent &ev)
	original handler interface (still used for WCRefreshEvents) More...

virtual void	reset (casacore::Bool=false)
	Derived classes should implement this to return to the non-showing, non-active state. More...

Public Member Functions inherited from casa::DisplayTool
virtual	~DisplayTool ()
	Destructor. More...

virtual void	setKey (const Display::KeySym &keysym)
	Set/get which key to catch. More...

virtual Display::KeySym	getKey () const

Public Member Functions inherited from casa::WCPositionEH
	WCPositionEH ()
	Default Constructor Required. More...

virtual	~WCPositionEH ()
	Destructor. More...

Public Member Functions inherited from casa::WCMotionEH
	WCMotionEH ()
	Default Constructor Required. More...

virtual	~WCMotionEH ()
	Destructor. More...

Public Member Functions inherited from casa::WCRefreshEH
	WCRefreshEH ()
	Default Constructor Required. More...

virtual	~WCRefreshEH ()
	Destructor. More...

Public Member Functions inherited from casa::DisplayEH
virtual void	handleEvent (DisplayEvent &)
	Classes that contain this interface (i.e., derive from it) can override this method to implement actions for whatever types of DisplayEvent they're interested in. More...

virtual	~DisplayEH ()

Additional Inherited Members
Protected Member Functions inherited from casa::MultiWCTool
virtual void	updateRegion ()

virtual void	clicked (casacore::Int, casacore::Int)

virtual void	doubleClicked (casacore::Int, casacore::Int)

virtual void	refresh ()
	Copy back-to-front buffer (erasing all MWCTool drawings), then cause this (and all MWCTools on current WC's PC) to draw (or not draw) themselves, according to their current state. More...

virtual void	setClipToDrawArea ()
	Cause subsequent drawing commands to be clipped to the current WC (or its drawing area). More...

virtual void	setClipToWC ()

virtual void	resetClip ()

Protected Member Functions inherited from casa::DisplayTool
	DisplayTool (const Display::KeySym &keysym=Display::K_Pointer_Button1)
	Constructor taking a key to which this tool will initially be attached, typically one of the pointer buttons. More...

	DisplayTool (const DisplayTool &other)
	Copy constructor - construct a new DisplayTool from `other`, using copy semantics. More...

DisplayTool &	operator= (const DisplayTool &other)
	Copy assignment using copy semantics. More...

Display::KeyModifier	keyModifiers ()
	Return the modifier mask. More...

Protected Attributes inherited from casa::MultiWCTool
WorldCanvas *	itsCurrentWC
	WC being (or to be) drawn on (may be 0 initially). More...

Detailed Description

Definition at line 39 of file RegionTool.h.

Member Typedef Documentation

typedef std::map<viewer::Region*,viewer::region::PointInfo> casa::RegionTool::region_map_type

Definition at line 41 of file RegionTool.h.

Member Enumeration Documentation

enum casa::RegionTool::RegionToolTypes

Enumerator
POLYTOOL
RECTTOOL
POINTTOOL
ELLIPSETOOL
POLYLINETOOL
PVLINETOOL

Definition at line 43 of file RegionTool.h.

Constructor & Destructor Documentation

casa::RegionTool::RegionTool ( Display::KeySym keysym = Display::K_Pointer_Button1 )

inline

Constructor taking the primary key to which this tool will respond.

Definition at line 101 of file RegionTool.h.

casa::RegionTool::~RegionTool ( )

inline

Definition at line 102 of file RegionTool.h.

Member Function Documentation

virtual void casa::RegionTool::checkPoint	(	WorldCanvas *	wc,
		State &	state
	)

pure virtual

this is a non-const function because a non-const RegionTool ptr is returned in 'state' which can then be used for setting the state of the regions managed by the various tools....

Implemented in casa::MultiPVTool, casa::MultiRectTool, casa::MultiPolyTool, and casa::MultiPolylineTool.

virtual bool casa::RegionTool::create	(	viewer::region::RegionTypes	,
		WorldCanvas *	,
		const std::vector< std::pair< double, double > > &	,
		const std::string &	,
		viewer::region::TextPosition	,
		const std::vector< int > &	,
		const std::string &	,
		int	,
		int	,
		const std::string &	,
		const std::string &	,
		viewer::region::LineStyle	,
		unsigned	int,
		bool	,
		VOID *
	)

pure virtual

create regions of various types (e.g.

point, rect, poly, etc.). For use when loading casa region files...

Implemented in casa::MultiPVTool, casa::MultiRectTool, casa::MultiPolyTool, and casa::MultiPolylineTool.

void casa::RegionTool::disable ( )

inlinevirtual

Reimplemented from casa::MultiWCTool.

Reimplemented in casa::MultiPVTool, casa::MultiRectTool, casa::MultiPolyTool, and casa::MultiPolylineTool.

Definition at line 128 of file RegionTool.h.

void casa::RegionTool::draw	(	const WCRefreshEvent &	,
		const viewer::region::region_list_type &
	)

virtual

Draw whatever should be drawn (if anything) on current WC.

Should only be called by refresh event handler.

Reimplemented from casa::MultiWCTool.

Reimplemented in casa::MultiPVTool, casa::MultiRectTool, casa::MultiPolyTool, and casa::MultiPolylineTool.

void casa::RegionTool::enable ( )

inlinevirtual

DISPLAY_PURE_VIRTUAL(RegionTool::create,true);.

defeat the registering/unregistering done by MultiWCTool (because polygon regions stop working because they see a double-click from both the RegionToolManager and MultiWCTool)...

Reimplemented from casa::MultiWCTool.

Definition at line 127 of file RegionTool.h.

void casa::RegionTool::keyPressed ( const WCPositionEvent & )

virtual

Functions called by the local event handling operators - by default they do nothing, so a derived class needs only implement the events it cares about.

Reimplemented from casa::MultiWCTool.

Reimplemented in casa::MultiPVTool, casa::MultiRectTool, casa::MultiPolyTool, and casa::MultiPolylineTool.

void casa::RegionTool::keyReleased ( const WCPositionEvent & )

virtual

Reimplemented from casa::MultiWCTool.

Reimplemented in casa::MultiPVTool, casa::MultiRectTool, casa::MultiPolyTool, and casa::MultiPolylineTool.