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

WorldCanvas event-based rectangle region drawer. More...

#include <WCRTRegion.h>

Inheritance diagram for casa::WCRTRegion:
casa::WCRectTool casa::WCTool casa::DTVisible casa::DisplayTool

List of all members.

Public Member Functions

 WCRTRegion (WorldCanvas *wcanvas, Display::KeySym keysym=Display::K_Pointer_Button1)
 Constructor.
virtual ~WCRTRegion ()
 Destructor.
virtual void doubleInside ()
 Functions specific to the region drawing - these are called by lower-level event handlers in the base classes.
virtual void regionReady ()
 This function is called when a region is deliberately "finished" by the user.

Private Member Functions

void getLinearCoords (Vector< Double > &blc, Vector< Double > &trc)
 get the linear coords of the current rectangular region

Detailed Description

WorldCanvas event-based rectangle region drawer.

Intended use:

Public interface

Review Status

<prerequisites> WCRectTool </prerequisites>

Etymology

WCRTRegion stands for WorldCanvas Rectangle Tool Region

Synopsis

This class finalises the functionality in WCRectTool to implement event-based drawing of rectangular regions on a WorldCanvas. Double clicking inside the constructed rectangle emits the region, whilst pressing Escape cancels the region.

Example

Motivation

Rectangular regions are the most common regions, and constructing them visually can be very efficient.

To Do

Definition at line 78 of file WCRTRegion.h.


Constructor & Destructor Documentation

Constructor.

virtual casa::WCRTRegion::~WCRTRegion ( ) [virtual]

Destructor.


Member Function Documentation

virtual void casa::WCRTRegion::doubleInside ( ) [virtual]

Functions specific to the region drawing - these are called by lower-level event handlers in the base classes.

Reimplemented from casa::WCRectTool.

void casa::WCRTRegion::getLinearCoords ( Vector< Double > &  blc,
Vector< Double > &  trc 
) [private]

get the linear coords of the current rectangular region

virtual void casa::WCRTRegion::regionReady ( ) [inline, virtual]

This function is called when a region is deliberately "finished" by the user.

It can be implemented to do further actions, such as report the region to the application

Definition at line 96 of file WCRTRegion.h.


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