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

Class which provides non-linear axis labelling using a CoordinateSystem. More...

#include <WCCSNLAxisLabeller.h>

Inheritance diagram for casa::WCCSNLAxisLabeller:
casa::WCCSAxisLabeller casa::WCAxisLabeller casa::DisplayOptions

List of all members.

Public Member Functions

 WCCSNLAxisLabeller ()
 Constructor.
virtual ~WCCSNLAxisLabeller ()
 Destructor.
virtual Bool draw (const WCRefreshEvent &ev)
 Draw axis labels for the provided WorldCanvas refresh event.
virtual void invalidate ()
 Invalidate/return any cached drawing list.
virtual void setCoordinateSystem (const CoordinateSystem &coordsys)
 Install the CoordinateSystem to use.
void setWorldRanges (const Vector< Double > &worldMin, const Vector< Double > &worldMax, const Vector< String > &units)
 Set the world min and max ranges (and their associated units) to be used by the CoordinateSystem::toMix computations.
virtual void setDefaultOptions ()
 install the default options for this DisplayData
virtual Bool setOptions (const Record &rec, Record &updatedOptions)
 apply options stored in rec to the DisplayData; return value True means a refresh is needed.
virtual Record getOptions () const
 retrieve the current and default options and parameter types.

Private Attributes

Bool itsValid
 Is the drawlist state below valid?
uInt itsDrawListNumber
 our drawlist number
AttributeBuffer itsDrawStateBuffer
 attribute buffer that suits the drawlist we have made
WorldCanvasitsLastWorldCanvas
 last WorldCanvas drawn upon

Detailed Description

Class which provides non-linear axis labelling using a CoordinateSystem.

Synopsis

This class implements the interface defined in WCCSAxisLabeller to provide arbitrary non-linear axis labelling, using coordinate transformations provided by a supplied CoordinateSystem.

Definition at line 48 of file WCCSNLAxisLabeller.h.


Constructor & Destructor Documentation

Constructor.

Destructor.


Member Function Documentation

virtual Bool casa::WCCSNLAxisLabeller::draw ( const WCRefreshEvent ev) [virtual]

Draw axis labels for the provided WorldCanvas refresh event.

Note: it is the responsibility of the caller to assure that this object is invalidated (or destroyed) before the WorldCanvas corresponding to ev gets destroyed, so that any cached axis drawing which the WC is holding for us can be deleted properly.

Implements casa::WCAxisLabeller.

virtual Record casa::WCCSNLAxisLabeller::getOptions ( ) const [virtual]

retrieve the current and default options and parameter types.

Reimplemented from casa::WCCSAxisLabeller.

virtual void casa::WCCSNLAxisLabeller::invalidate ( ) [virtual]

Invalidate/return any cached drawing list.

Reimplemented from casa::WCAxisLabeller.

virtual void casa::WCCSNLAxisLabeller::setCoordinateSystem ( const CoordinateSystem coordsys) [virtual]

Install the CoordinateSystem to use.

Reimplemented from casa::WCCSAxisLabeller.

virtual void casa::WCCSNLAxisLabeller::setDefaultOptions ( ) [virtual]

install the default options for this DisplayData

Reimplemented from casa::WCCSAxisLabeller.

virtual Bool casa::WCCSNLAxisLabeller::setOptions ( const Record rec,
Record updatedOptions 
) [virtual]

apply options stored in rec to the DisplayData; return value True means a refresh is needed.

Any fields added to the updatedOptions argument are options which have changed in some way due to the setting of other options - ie. they are context sensitive.

Reimplemented from casa::WCCSAxisLabeller.

void casa::WCCSNLAxisLabeller::setWorldRanges ( const Vector< Double > &  worldMin,
const Vector< Double > &  worldMax,
const Vector< String > &  units 
)

Set the world min and max ranges (and their associated units) to be used by the CoordinateSystem::toMix computations.

If not specified with this function, -180->180, -90->90 for DirectionCoordinates used (rest don't matter). Specifying this correctly can make the toMix computations much faster (it uses an iterative solution) and avoid solution ambiguities.


Member Data Documentation

our drawlist number

Definition at line 101 of file WCCSNLAxisLabeller.h.

attribute buffer that suits the drawlist we have made

Definition at line 104 of file WCCSNLAxisLabeller.h.

last WorldCanvas drawn upon

Definition at line 107 of file WCCSNLAxisLabeller.h.

Is the drawlist state below valid?

Definition at line 98 of file WCCSNLAxisLabeller.h.


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