casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions | Private Attributes
casa::MWCRulerlineTool Class Reference

Multi WorldCanvas event-based ruler line tool. More...

#include <MWCRulerlineTool.h>

Inheritance diagram for casa::MWCRulerlineTool:
casa::MultiWCTool casa::DTVisible casa::DisplayTool casa::WCPositionEH casa::WCMotionEH casa::WCRefreshEH casa::DisplayEH

List of all members.

Public Member Functions

 MWCRulerlineTool (Display::KeySym keysym=Display::K_Pointer_Button1, Bool scrollingAllowed=True)
 Constructor.
virtual ~MWCRulerlineTool ()
 Destructor.
virtual void reset (Bool skipRefresh=False)
 Reset to non-showing, non-active.

Protected Member Functions

virtual void keyPressed (const WCPositionEvent &)
 Functions called by the base class mouse event handling operators - these maintain the state of the pan vector and order it to be drawn via refresh().
virtual void keyReleased (const WCPositionEvent &)
virtual void moved (const WCMotionEvent &, const viewer::region::region_list_type &)
virtual void draw (const WCRefreshEvent &, const viewer::region::region_list_type &)
 draw the distance vector on a PixelCanvas.

Private Attributes

Bool itsActive
 Should we respond to mouse movement and button release? Should we draw? Set when the button is pushed in one of the tool's WCs.
Bool itsEqualUnits
 are the units in x and y identical?
Int itsX1
 pixel coordinates of the pan vector.
Int itsY1
Int itsX2
Int itsY2
Int itsX3
Int itsY3
Int itsRaIndex
 axis index for RA and DEC
Int itsDecIndex

Detailed Description

Multi WorldCanvas event-based ruler line tool.

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

<prerequisites> </prerequisites>

Etymology

MWCRulerlineTool stands for MultiWorldCanvas ruler line Tool

Synopsis

Example

Motivation

A nice little tool to measure distances on the screen.

Definition at line 69 of file MWCRulerlineTool.h.


Constructor & Destructor Documentation

Constructor.

Destructor.


Member Function Documentation

virtual void casa::MWCRulerlineTool::draw ( const WCRefreshEvent ,
const viewer::region::region_list_type  
) [protected, virtual]

draw the distance vector on a PixelCanvas.

(To be called only by the base class refresh event handler).

Reimplemented from casa::MultiWCTool.

virtual void casa::MWCRulerlineTool::keyPressed ( const WCPositionEvent ) [protected, virtual]

Functions called by the base class mouse event handling operators - these maintain the state of the pan vector and order it to be drawn via refresh().

Reimplemented from casa::MultiWCTool.

virtual void casa::MWCRulerlineTool::keyReleased ( const WCPositionEvent ) [protected, virtual]

Reimplemented from casa::MultiWCTool.

virtual void casa::MWCRulerlineTool::moved ( const WCMotionEvent ,
const viewer::region::region_list_type  
) [protected, virtual]

Reimplemented from casa::MultiWCTool.

virtual void casa::MWCRulerlineTool::reset ( Bool  skipRefresh = False) [virtual]

Reset to non-showing, non-active.

Refreshes if necessary to erase (unless skipRefresh==True). (Does not unregister from WCs or disable future event handling).

Reimplemented from casa::MultiWCTool.


Member Data Documentation

Should we respond to mouse movement and button release? Should we draw? Set when the button is pushed in one of the tool's WCs.

Definition at line 101 of file MWCRulerlineTool.h.

Definition at line 110 of file MWCRulerlineTool.h.

are the units in x and y identical?

Definition at line 104 of file MWCRulerlineTool.h.

axis index for RA and DEC

Definition at line 110 of file MWCRulerlineTool.h.

pixel coordinates of the pan vector.

1 = anchor, 2 = new position.

Definition at line 107 of file MWCRulerlineTool.h.

Definition at line 107 of file MWCRulerlineTool.h.

Definition at line 107 of file MWCRulerlineTool.h.

Definition at line 107 of file MWCRulerlineTool.h.

Definition at line 107 of file MWCRulerlineTool.h.

Definition at line 107 of file MWCRulerlineTool.h.


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