Class which stores WorldCanvas motion event information. More...

#include <WCMotionEvent.h>

Inheritance diagram for casa::WCMotionEvent:

Public Member Functions
	WCMotionEvent (WorldCanvas *wc, const casacore::uInt &modifiers, const casacore::Int &pixX, const casacore::Int &pixY, const casacore::Double &linX, const casacore::Double &linY, const casacore::Vector< casacore::Double > &world)
	Constructor taking a pointer to the WorldCanvas for which the event is valid, the state of the keyboard and pointer modifiers, and the pixel, linear and world coordinates of the event. More...

	WCMotionEvent (const WCMotionEvent &other)
	copy constructor. More...

virtual	~WCMotionEvent ()
	Destructor. More...

virtual casacore::Int	pixX () const
	The x and y pixel position of the pointer when the event occurred. More...

virtual casacore::Int	pixY () const

virtual casacore::Double	linX () const
	The x and y linear coordinates of the event. More...

virtual casacore::Double	linY () const

virtual const casacore::Vector < casacore::Double > &	world () const
	The world coordinates describing where the event occurred. More...

virtual casacore::uInt	modifiers () const
	Return the state of the "modifiers": this is made up of mask bits referring to various keys on the keyboard (eg. More...

Public Member Functions inherited from casa::WorldCanvasEvent
	WorldCanvasEvent (WorldCanvas *wc)
	Constructor, taking a pointer to a WorldCanvas. More...

virtual	~WorldCanvasEvent ()
	Destructor. More...

virtual WorldCanvas *	worldCanvas () const
	Return a pointer to the WorldCanvas on which the event occurred. More...

Public Member Functions inherited from casa::DisplayEvent
	DisplayEvent ()
	Constructor. More...

	DisplayEvent (const DisplayEvent &other)
	Copy constructor - construct a new DisplayEvent from `other`. More...

virtual	~DisplayEvent ()
	Destructor. More...

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

virtual casacore::Double	timeOfEvent () const
	Return the Julian date (in fractional seconds) that this event occured. More...

Protected Member Functions
	WCMotionEvent ()
	(Required) default constructor. More...

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

Protected Member Functions inherited from casa::WorldCanvasEvent
	WorldCanvasEvent ()
	(Required) default constructor. More...

	WorldCanvasEvent (const WorldCanvasEvent &other)
	(Required) copy constructor. More...

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

Private Attributes
casacore::Int	itsPixX
	Store the pixel position of the event here. More...

casacore::Int	itsPixY

casacore::Double	itsLinX
	Store the linear position of the event here. More...

casacore::Double	itsLinY

casacore::Vector < casacore::Double >	itsWorld
	Store the world position of the event here. More...

casacore::uInt	itsModifiers
	Store the button and keyboard modifier masks here. More...

Friends
class	QtDisplayPanel

Detailed Description

Class which stores WorldCanvas motion event information.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

"WCMotionEvent" is a contraction and concatentation of "WorldCanvas", "Motion" and "Event", and describes motion events occuring on WorldCanvases.

Synopsis

This class adds to the information stored in the WorldCanvasEvent class. It adds informatino describing the current position of the mouse or pointing device, and the state of the keyboard modifiers (including the mouse buttons).

Example

Motivation

A compact way of passing motion event information around the WorldCanvas-oriented display classes was needed, with a functional but tight and efficient interface.

Thrown Exceptions

.

Definition at line 79 of file WCMotionEvent.h.

Constructor & Destructor Documentation

casa::WCMotionEvent::WCMotionEvent	(	WorldCanvas *	wc,
		const casacore::uInt &	modifiers,
		const casacore::Int &	pixX,
		const casacore::Int &	pixY,
		const casacore::Double &	linX,
		const casacore::Double &	linY,
		const casacore::Vector< casacore::Double > &	world
	)

Constructor taking a pointer to the WorldCanvas for which the event is valid, the state of the keyboard and pointer modifiers, and the pixel, linear and world coordinates of the event.

casa::WCMotionEvent::WCMotionEvent ( const WCMotionEvent & other )

copy constructor.

virtual casa::WCMotionEvent::~WCMotionEvent ( )

virtual

Destructor.

casa::WCMotionEvent::WCMotionEvent ( )

protected

(Required) default constructor.

Member Function Documentation

virtual casacore::Double casa::WCMotionEvent::linX ( ) const

inlinevirtual

The x and y linear coordinates of the event.

Definition at line 110 of file WCMotionEvent.h.

References itsLinX.

virtual casacore::Double casa::WCMotionEvent::linY ( ) const

inlinevirtual

Definition at line 113 of file WCMotionEvent.h.

References itsLinY.

virtual casacore::uInt casa::WCMotionEvent::modifiers ( ) const

inlinevirtual

Return the state of the "modifiers": this is made up of mask bits referring to various keys on the keyboard (eg.

Control, Shift, etc.) and the mouse buttons.

Definition at line 126 of file WCMotionEvent.h.

References itsModifiers.

WCMotionEvent& casa::WCMotionEvent::operator= ( const WCMotionEvent & other )

protected

(Required) copy assignment.

virtual casacore::Int casa::WCMotionEvent::pixX ( ) const

inlinevirtual

The x and y pixel position of the pointer when the event occurred.

Definition at line 100 of file WCMotionEvent.h.

References itsPixX.

virtual casacore::Int casa::WCMotionEvent::pixY ( ) const

inlinevirtual

Definition at line 103 of file WCMotionEvent.h.

References itsPixY.

virtual const casacore::Vector<casacore::Double>& casa::WCMotionEvent::world ( ) const

inlinevirtual

The world coordinates describing where the event occurred.

Definition at line 119 of file WCMotionEvent.h.

References itsWorld.

Friends And Related Function Documentation

friend class QtDisplayPanel

friend

Definition at line 137 of file WCMotionEvent.h.

Member Data Documentation

casacore::Double casa::WCMotionEvent::itsLinX

private

Store the linear position of the event here.

Definition at line 145 of file WCMotionEvent.h.

Referenced by linX().

casacore::Double casa::WCMotionEvent::itsLinY

private

Definition at line 145 of file WCMotionEvent.h.

Referenced by linY().

casacore::uInt casa::WCMotionEvent::itsModifiers

private

Store the button and keyboard modifier masks here.

Definition at line 151 of file WCMotionEvent.h.

Referenced by modifiers().

casacore::Int casa::WCMotionEvent::itsPixX

private

Store the pixel position of the event here.

Definition at line 142 of file WCMotionEvent.h.

Referenced by pixX().

casacore::Int casa::WCMotionEvent::itsPixY

private

Definition at line 142 of file WCMotionEvent.h.

Referenced by pixY().

casacore::Vector<casacore::Double> casa::WCMotionEvent::itsWorld

private

Store the world position of the event here.

Definition at line 148 of file WCMotionEvent.h.

Referenced by world().

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

casa/code/display/DisplayEvents/WCMotionEvent.h

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Intended use:

Review Status

Etymology

Synopsis

Example

Motivation

Thrown Exceptions

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation