Base class for MultiWorldCanvas event-based rectangle tools. More...

#include <MultiPointTool.h>

Inheritance diagram for casa::MultiPointTool:

Public Member Functions
	MultiPointTool (viewer::RegionSourceFactory rsf, PanelDisplay pd, Display::KeySym keysym=Display::K_Pointer_Button1, const casacore::Bool persistent=false)
	Constructor. More...

virtual	~MultiPointTool ()
	Destructor. More...

const std::set < viewer::region::RegionTypes > &	regionsCreated () const
	returns a set which indicates regions this creator creates... More...

RegionToolTypes	type () const

Public Member Functions inherited from casa::MultiRectTool
	MultiRectTool (viewer::RegionSourceFactory rsf, PanelDisplay pd, Display::KeySym keysym=Display::K_Pointer_Button1, const casacore::Bool persistent=false)
	Constructor. More...

virtual	~MultiRectTool ()
	Destructor. More...

virtual void	disable ()
	Switch the tool off - this erases the rectangle, if any, and calls the base class disable. More...

virtual void	reset (casacore::Bool skipRefresh=false)
	reset to non-existent, non-active rectangle. More...

virtual casacore::Bool	rectangleDefined ()
	Is a rectangle currently defined? More...

viewer::RegionSource *	getRegionSource ()

void	checkPoint (WorldCanvas *wc, State &state)
	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...

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

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 )
	create regions of various types (e.g. More...

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

	~RegionTool ()

void	otherKeyReleased (const WCPositionEvent &)

void	enable ()
	DISPLAY_PURE_VIRTUAL(RegionTool::create,true);. 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...

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 ()

Public Member Functions inherited from casa::DTVisible
	DTVisible ()
	Default constructor. More...

virtual	~DTVisible ()
	Destructor. More...

virtual casacore::String	drawColor () const
	Return the color to use. More...

virtual casacore::Int	lineWidth () const
	Return the line width to use. More...

virtual casacore::Double	doubleClickInterval () const
	Return the double click interval (in seconds). More...

Public Member Functions inherited from casa::viewer::RegionCreator
	RegionCreator ()
	DISPLAY_PURE_VIRTUAL(RegionCreator::create,true);. More...

virtual	~RegionCreator ()

Protected Member Functions
bool	checkType (viewer::region::RegionTypes t)

virtual std::shared_ptr < viewer::Rectangle >	allocate_region (WorldCanvas wc, double x1, double y1, double x2, double y2, VOID region_specific_state) const

Protected Member Functions inherited from casa::MultiRectTool
virtual void	keyPressed (const WCPositionEvent &ev)
	Functions called by the base class event handling operators–and normally only those. More...

virtual void	keyReleased (const WCPositionEvent &ev)

virtual void	otherKeyPressed (const WCPositionEvent &ev)

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

virtual void	draw (const WCRefreshEvent &, const viewer::region::region_list_type &)
	draw the rectangle (if any) on the object's currently active WC. More...

virtual void	doubleInside ()
	Output callback functions–to be overridden in derived class. More...

virtual void	doubleOutside ()

virtual void	rectangleReady ()
	Called when a rectangle is ready and not being edited. More...

virtual void	get (casacore::Int &x1, casacore::Int &y1, casacore::Int &x2, casacore::Int &y2) const
	Retrieve the rectangle coordinates, in screen pixels. More...

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 Member Functions inherited from casa::DTVisible
	DTVisible (const DTVisible &other)
	(Required) copy constructor. More...

DTVisible &	operator= (const DTVisible &other)
	(Required) copy assignment. More...

Additional Inherited Members
Public Types inherited from casa::RegionTool
enum	RegionToolTypes { POLYTOOL, RECTTOOL, POINTTOOL, ELLIPSETOOL, POLYLINETOOL, PVLINETOOL }

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

Public Types inherited from casa::viewer::RegionCreator
typedef std::list < RegionCreator * >	creator_list_type

Static Public Member Functions inherited from casa::viewer::RegionCreator
static const creator_list_type &	findCreator (region::RegionTypes type)

Protected Attributes inherited from casa::MultiRectTool
viewer::RegionSource *	rfactory

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

Detailed Description

Base class for MultiWorldCanvas event-based rectangle tools.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

<prerequisites> WCTool </prerequisites>

Etymology

MultiPointTool stands for MultiWorldCanvas Rectangle Tool

Synopsis

This class adds to its base WCTool to provide a tool for drawing, resizing and moving rectangles on a WorldCanvas. While MultiPointTool is not abstract, it performs no useful function. The programmer should derive from this class, and implement the functions doubleInside and doubleOutside, which are called when the user double-clicks the key or mouse button inside or outside an existing rectangle respectively. It is up to the programmer to decide what double clicks inside and outside the rectangle correspond to, although it is recommended that a double click inside correspond to the main action of the tool, and a double click outside correspond to a secondary action of the tool, if indeed a secondary action exists.

The rectangle is drawn by dragging the mouse from one corner to the diagonally opposite corner. Once constructed, the rectangle can be resized by dragging its corners, or relocated by dragging inside the rectangle. The rectangle is removed from the display when the Esc key is pressed.

Example

Motivation

Many activities on the WorldCanvas will be based on the user drawing a rectangle, and then proceeding to some action with that rectangle. A nice example is zooming.

Definition at line 84 of file MultiPointTool.h.

Constructor & Destructor Documentation

casa::MultiPointTool::MultiPointTool	(	viewer::RegionSourceFactory *	rsf,
		PanelDisplay *	pd,
		Display::KeySym	keysym = `Display::K_Pointer_Button1`,
		const casacore::Bool	persistent = `false`
	)

inline

Constructor.

Definition at line 89 of file MultiPointTool.h.

virtual casa::MultiPointTool::~MultiPointTool ( )

inlinevirtual

Destructor.

Definition at line 94 of file MultiPointTool.h.

Member Function Documentation

virtual std::shared_ptr<viewer::Rectangle> casa::MultiPointTool::allocate_region	(	WorldCanvas *	wc,
		double	x1,
		double	y1,
		double	x2,
		double	y2,
		VOID *	region_specific_state
	)		const

protectedvirtual

Reimplemented from casa::MultiRectTool.

bool casa::MultiPointTool::checkType ( viewer::region::RegionTypes t )

inlineprotectedvirtual

Reimplemented from casa::MultiRectTool.

Definition at line 105 of file MultiPointTool.h.

References casa::viewer::region::PointRegion.

const std::set<viewer::region::RegionTypes>& casa::MultiPointTool::regionsCreated ( ) const

virtual

returns a set which indicates regions this creator creates...

Reimplemented from casa::MultiRectTool.

RegionToolTypes casa::MultiPointTool::type ( ) const

inlinevirtual

Reimplemented from casa::MultiRectTool.

Definition at line 99 of file MultiPointTool.h.

References casa::RegionTool::POINTTOOL.

The documentation for this class was generated from the following file:

casa/code/display/DisplayEvents/MultiPointTool.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Intended use:

Review Status

Etymology

Synopsis

Example

Motivation

Constructor & Destructor Documentation

Member Function Documentation