casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
casa::RSRectangle Class Reference

Subclass of RegionShape used for drawing rectangles. More...

#include <RegionShapes.h>

Inheritance diagram for casa::RSRectangle:
casa::RegionShape casa::PassiveCachingDD casa::CachingDisplayData casa::DisplayData casa::DisplayOptions casa::DisplayEH casa::DlTarget

Public Member Functions

 RSRectangle (double x, double y, double width, double height, casacore::MDirection::Types worldSystem, double angle=0)
 Non-Static Members //. More...
 
 RSRectangle (double x, double y, double width, double height, double angle=0)
 Pixel Constructor. More...
 
 RSRectangle (const casacore::RecordInterface &properties)
 casacore::Record Constructor. More...
 
 ~RSRectangle ()
 Destructor. More...
 
bool drawAndUpdateBoundingBox (WorldCanvasHolder &wch, casacore::String *err=NULL)
 Implements RegionShape::drawAndUpdateBoundingBox. More...
 
casacore::String type () const
 Implements RegionShape::type. More...
 
void getRectangleCoordinates (double &x, double &y, double &width, double &height, double &angle, casacore::String toSystem="") const
 Gets rectangle-specific coordinates, to avoid dependence on coordParameterValues() when the shape type is known. More...
 
std::vector< double > coordParameterValues () const
 Implements RegionShape::coordParameterValues. More...
 
std::vector< double > coordParameterValues (casacore::String toSystem) const
 Implements RegionShape::coordParameterValues. More...
 
std::vector< casacore::StringcoordParameterNames () const
 Implements RegionShape::coordParameterNames. More...
 
std::vector
< CoordinateParameterType
coordParameterTypes () const
 Implements RegionShape::coordParameterPositions. More...
 
void setCoordParameters (const std::vector< double > &vals)
 Implements RegionShape::setCoordParameters. More...
 
void setCoordParameters (const std::vector< double > &vals, casacore::String valSystem)
 Implements RegionShape::setCoordParameters. More...
 
void move (double dx, double dy, casacore::String system="")
 Implements RegionShape::move. More...
 
RSHandle getHandle () const
 Implements RegionShape::getHandle. More...
 
std::vector< casacore::StringoptionNames () const
 Implements RegionShape option methods. More...
 
std::vector< OptionTypeoptionTypes () const
 Returns the types for options. More...
 
std::vector< RSOptionoptionValues () const
 Returns the current values for options. More...
 
void setOptionValues (const vector< RSOption > &)
 Sets the options to the given. More...
 
- Public Member Functions inherited from casa::RegionShape
std::string errorMessage () const
 
 RegionShape (casacore::MDirection::Types worldSys)
 Non-Static Members //. More...
 
 RegionShape ()
 Pixel Constructor. More...
 
 RegionShape (const casacore::RecordInterface &properties)
 casacore::Record Constructor. More...
 
virtual ~RegionShape ()
 Destructor. More...
 
const casacore::Unit dataUnit () const
 PassiveCachingDD methods //. More...
 
const casacore::IPosition dataShape () const
 
casacore::uInt dataDim () const
 
std::vector< int > displayAxes () const
 
Display::DisplayDataType classType ()
 Implements PassiveCachingDD::classType. More...
 
CachingDisplayMethodnewDisplayMethod (WorldCanvas *wc, AttributeBuffer *wchAttr, AttributeBuffer *ddAttr, CachingDisplayData *dd)
 Implements PassiveCachingDD::newDisplayMethod. More...
 
virtual casacore::String lineColor () const
 Common RegionShape methods //. More...
 
virtual void setLineColor (const casacore::String &newColor, bool alsoSetLabel=true)
 
virtual double lineWidth () const
 Gets/sets this shape's line width. More...
 
virtual void setLineWidth (double width)
 
virtual LineStyle lineStyle () const
 Gets/sets this shape's line style. More...
 
virtual void setLineStyle (LineStyle style)
 
virtual casacore::String text () const
 Gets/sets this shape's label's text. More...
 
virtual void setText (const casacore::String &text)
 
virtual const RegionShapeLabellabel () const
 Gets/sets this shape's label. More...
 
virtual void setLabel (const RegionShapeLabel &label)
 
virtual bool linethrough () const
 Gets/sets this shape's linethrough properties. More...
 
virtual casacore::String linethroughColor () const
 
virtual double linethroughWidth () const
 
virtual LineStyle linethroughStyle () const
 
virtual void setLinethrough (bool linethrough, casacore::String color="red", double width=1, LineStyle style=SOLID)
 
virtual double xMin () const
 Min/max methods for world/pixel coordinates. More...
 
virtual double xMax () const
 
virtual double yMin () const
 
virtual double yMax () const
 
virtual double screenXMin () const
 Bounding box methods. More...
 
virtual double screenXMax () const
 
virtual double screenYMin () const
 
virtual double screenYMax () const
 
virtual bool isWorld () const
 Returns whether this shape's coordinates are in world or pixel. More...
 
virtual casacore::MDirection::Types worldSystem () const
 If this shape is in world coordinates, returns the system used. More...
 
virtual void setIsWorld (bool isWorld)
 Set world or pixel system. More...
 
virtual void setWorldSystem (casacore::MDirection::Types sys)
 Set world system. More...
 
virtual casacore::String title () const
 Returns this shape's type (color + type). More...
 
bool draw (WorldCanvasHolder &wch)
 Checks whether the given WorldCanvasHolder has a direction coordinate. More...
 
virtual bool hadDrawingError () const
 Returns whether there was an error during the last call to draw() or not. More...
 
const casacore::StringlastDrawingError () const
 Returns the error that occurred during the last call to draw(). More...
 
casacore::Record getProperties () const
 Returns this shape's properties as a Record. More...
 
casacore::Record toRecord () const
 Synonym. More...
 
void setProperties (const casacore::RecordInterface &properties)
 Sets this shape's properties from the given Record. More...
 
casacore::String dataType () const
 Pure virtual function from DisplayData... More...
 
virtual casacore::String oneWordType () const
 Can be overridden by children. More...
 
virtual std::vector
< std::vector
< casacore::String > > 
optionChoices () const
 For options that are string choices, return the available choices. More...
 
- Public Member Functions inherited from casa::PassiveCachingDD
 PassiveCachingDD ()
 Constructor. More...
 
virtual ~PassiveCachingDD ()
 Destructor. More...
 
virtual casacore::Bool linToWorld (casacore::Vector< casacore::Double > &world, const casacore::Vector< casacore::Double > &lin)
 casacore::Coordinate transformation handlers, called by WorldCanvasHolder. More...
 
virtual casacore::Bool worldToLin (casacore::Vector< casacore::Double > &lin, const casacore::Vector< casacore::Double > &world)
 
virtual casacore::String showPosition (const casacore::Vector< casacore::Double > &world, const casacore::Bool &displayAxesOnly=false)
 casacore::Format a string containing coordinate or value information at the given world coordinate. More...
 
virtual casacore::String showValue (const casacore::Vector< casacore::Double > &world)
 casacore::Format a string containing value information at the given world coordinate More...
 
virtual casacore::Vector
< casacore::String
worldAxisNames () const
 World axis information suppliers. More...
 
virtual casacore::Vector
< casacore::String
worldAxisUnits () const
 
const casacore::Unit dataUnit () const
 
const casacore::IPosition dataShape () const
 
casacore::uInt dataDim () const
 
std::vector< int > displayAxes () const
 
virtual casacore::uInt nelements (const WorldCanvasHolder &wcHolder) const
 Return the number of display elements (ie. More...
 
virtual casacore::uInt nelements () const
 and non-specific More...
 
virtual void setDefaultOptions ()
 Install the default options for this DisplayData. More...
 
virtual casacore::Bool setOptions (casacore::Record &rec, casacore::Record &recOut)
 Apply options stored in rec to the DisplayData. More...
 
virtual casacore::Record getOptions (bool scrub=false) const
 Retrieve the current and default options and parameter types. More...
 
virtual void refreshEH (const WCRefreshEvent &ev)
 Negotiatiate WorldCanvas linear coordinate system when asked to do so by the WorldCanvasHolder. More...
 
virtual casacore::Bool sizeControl (WorldCanvasHolder &, AttributeBuffer &)
 Set (coordinate) state of WCH's WC. More...
 
virtual void cleanup ()
 Tidy up the elements of this DisplayData. More...
 
- Public Member Functions inherited from casa::CachingDisplayData
 CachingDisplayData ()
 Constructor. More...
 
virtual ~CachingDisplayData ()
 Destructor. More...
 
virtual void notifyRegister (WorldCanvasHolder *wcHolder)
 
virtual void notifyUnregister (WorldCanvasHolder &wcHolder, casacore::Bool ignoreRefresh=false)
 ignoreRefresh tells the DD not to refresh just to clean up DMs More...
 
virtual void setColormap (Colormap *cmap, casacore::Float weight)
 Purges cache, to avoid reusing images with the wrong colormap, then calls base class version. More...
 
virtual void purgeCache ()
 Empty cache completely. More...
 
virtual void purgeCache (const WorldCanvasHolder &wch)
 Empty cache of all DMs for a given WCH. More...
 
- Public Member Functions inherited from casa::DisplayData
 DisplayData ()
 (Required) default constructor. More...
 
virtual ~DisplayData ()
 required destructor More...
 
virtual void setDisplayState (DisplayState s)
 
virtual DisplayState getDisplayState () const
 
virtual bool isDisplayable () const
 
virtual void addRestrictions (AttributeBuffer &otherBuf)
 Add general restrictions or a restriction for item itemNum of this DisplayData. More...
 
virtual void addRestriction (Attribute &newRestriction, casacore::Bool permanent)
 
virtual void addElementRestrictions (const casacore::uInt itemNum, AttributeBuffer &other)
 
virtual void addElementRestriction (const casacore::uInt itemNum, Attribute &newRestriction, casacore::Bool permanent)
 
virtual void setRestrictions (AttributeBuffer &otherBuf)
 Set general restrictions or a restriction for item itemNum of this DisplayData. More...
 
virtual void setRestriction (Attribute &newRestriction)
 
virtual void setElementRestrictions (const casacore::uInt itemNum, AttributeBuffer &other)
 
virtual void setElementRestriction (const casacore::uInt itemNum, Attribute &newRestriction)
 
virtual void removeRestriction (const casacore::String &name)
 Remove a general restriction or a restriction from item itemNum More...
 
virtual void removeElementRestriction (const casacore::uInt itemNum, const casacore::String &name)
 
virtual void clearRestrictions ()
 Clear all general restrictions or all restrictions of item itemNum (except the ones that are permanent of course...) More...
 
virtual void clearElementRestrictions (const casacore::uInt itemNum)
 
virtual casacore::Bool existRestriction (const casacore::String &name)
 Check if a general restriction or a restriction for item itemNum with name name exists. More...
 
virtual casacore::Bool existElementRestriction (const casacore::uInt itemNum, const casacore::String &name)
 
virtual AttributeBufferrestrictionBuffer ()
 Get a handle to the buffer of general restrictions or of the buffer of restrictions for item itemNum More...
 
virtual AttributeBufferelementRestrictionBuffer (const casacore::uInt itemNum)
 
virtual casacore::Bool conformsTo (const WorldCanvas *wCanvas)
 Check whether the DD is is compatible with all WC[H] state, including its coordinate state, restrictions, and zIndex (if any). More...
 
virtual casacore::Bool conformsTo (const WorldCanvas &wc)
 
virtual casacore::Bool conformsToRstrs (const WorldCanvas &wc)
 Determine whether DD restrictions are in conformance with restrictions on the given WCH. More...
 
virtual casacore::Bool conformsToCS (const WorldCanvas &)
 Determine whether DD is compatible with the WC[H]'s current world coordinates. More...
 
virtual casacore::Bool conformsToZIndex (const WorldCanvas &wc)
 Determine whether DD is compatible with the current canvas animation (zIndex) position. More...
 
virtual casacore::Int activeZIndex (const WorldCanvas *wc=0)
 Retrieve 'Active' zIndex. More...
 
virtual casacore::Bool getFirstZIndex (int &firstZIndex, casacore::Int axZrng=-1) const
 Set firstZIndex to minimum zIndex setting from all canvases where this DD is registered. More...
 
virtual void addPositionEventHandler (WCPositionEH *positionHandler)
 Add event handlers on the DisplayData. More...
 
virtual void addMotionEventHandler (WCMotionEH *motionHandler)
 
virtual void addRefreshEventHandler (WCRefreshEH *refreshHandler)
 
virtual void addDisplayEventHandler (DisplayEH *displayHandler)
 
virtual void removePositionEventHandler (WCPositionEH &positionHandler)
 Remove eventhandlers. More...
 
virtual void removeMotionEventHandler (WCMotionEH &motionHandler)
 
virtual void removeRefreshEventHandler (WCRefreshEH &refreshHandler)
 
virtual void removeDisplayEventHandler (DisplayEH &displayHandler)
 
virtual void removeColormap ()
 
virtual Colormapcolormap () const
 
void setAttribute (Attribute &at)
 set an Attribute or Attributes More...
 
void setAttributes (AttributeBuffer &at)
 
casacore::Bool getAttributeValue (const casacore::String &name, casacore::uInt &newValue)
 User interface to get value from the attribute buffer. More...
 
casacore::Bool getAttributeValue (const casacore::String &name, casacore::Int &newValue)
 
casacore::Bool getAttributeValue (const casacore::String &name, casacore::Float &newValue)
 
casacore::Bool getAttributeValue (const casacore::String &name, casacore::Double &newValue)
 
casacore::Bool getAttributeValue (const casacore::String &name, casacore::Bool &newValue)
 
casacore::Bool getAttributeValue (const casacore::String &name, casacore::String &newValue)
 
casacore::Bool getAttributeValue (const casacore::String &name, casacore::Vector< casacore::uInt > &newValue)
 
casacore::Bool getAttributeValue (const casacore::String &name, casacore::Vector< casacore::Int > &newValue)
 
casacore::Bool getAttributeValue (const casacore::String &name, casacore::Vector< casacore::Float > &newValue)
 
casacore::Bool getAttributeValue (const casacore::String &name, casacore::Vector< casacore::Double > &newValue)
 
casacore::Bool getAttributeValue (const casacore::String &name, casacore::Vector< casacore::Bool > &newValue)
 
casacore::Bool getAttributeValue (const casacore::String &name, casacore::Vector< casacore::String > &newValue)
 
casacore::Bool existsAttribute (casacore::String &name)
 Check if a certain Attribute exists. More...
 
void removeAttribute (casacore::String &name)
 Remove an Attribute. More...
 
AttValue::ValueType attributeType (casacore::String &name)
 Get the type of the Attribute. More...
 
void setAttributeOnPrimaryWCHs (Attribute &at)
 Set an attribute on any WorldCanvas for which this DD is CS master. More...
 
virtual void removeFromAllWCHs ()
 remove this DD everywhere–will stop any more refresh handling by the DD. More...
 
virtual void refresh (casacore::Bool clean=false)
 an explicit refresh: should be called if the DisplayData is changed such that drawing is required. More...
 
virtual casacore::Bool labelAxes (const WCRefreshEvent &ev)
 an explicit request to draw the axes and/or labels. More...
 
virtual casacore::Bool canLabelAxes () const
 
virtual casacore::String className () const
 Return the class name of this DisplayData; useful mostly for debugging purposes, and perhaps future use in the glish widget interface. More...
 
virtual casacore::String description () const
 
virtual ImageAnalysis * imageanalysis () const
 Get image analyis about images... More...
 
virtual std::shared_ptr
< casacore::ImageInterface
< casacore::Float > > 
imageinterface ()
 Returns a pointer that should not be deleted... More...
 
virtual void setSubstituteTitleText (const casacore::String)
 
const WorldCanvasHolderfindHolder (const WorldCanvas *wCanvas) const
 Identify the WorldCanvasHolder for the given WorldCanvas. More...
 
WorldCanvasHolderfindHolder (const WorldCanvas *wCanvas)
 
virtual casacore::Block
< casacore::Int
allZIndices (casacore::Int axZrng=-1) const
 Return a sorted casacore::Block of all animation frame numbers currently set onto all WCHs where this DD is registered. More...
 
virtual casacore::Bool zIndexHint (casacore::Int &) const
 Will be called just before registering the [GTk]DD on a [GTk]PanelDisplay which has none registered on it yet. More...
 
virtual void handleEvent (DisplayEvent &ev)
 Overide DisplayEH::handleEvent. More...
 
virtual casacore::Bool isCSmaster (const WorldCanvasHolder *wch=0) const
 Is this DD the CS master of the passed WCH? Defaulting wch to 0 asks whether this DD is CS master of some WCH on which it is registered. More...
 
virtual casacore::Int uiBase () const
 DD 'Absolute Pixel Coordinates', e.g. More...
 
virtual void setUIBase (casacore::Int uibase)
 
virtual casacore::Bool getDelTmpData ()
 Get and set method for the flag. More...
 
virtual void setDelTmpData (casacore::Bool delTmpData)
 
virtual void setDisplayDataRed (DisplayData *)
 
virtual void setDisplayDataBlue (DisplayData *)
 
virtual void setDisplayDataGreen (DisplayData *)
 
- Public Member Functions inherited from casa::DisplayOptions
 DisplayOptions ()
 Constructor. More...
 
virtual ~DisplayOptions ()
 Destructor. More...
 
template<class T >
casacore::Bool readOptionRecord (casacore::Vector< T > &target, casacore::Bool &error, const casacore::Record &rec, const casacore::String &fieldname) const
 Find the field fieldname in casacore::Record rec, containing the requested type (casacore::Bool, casacore::String, casacore::Float, casacore::Int) in itself or its "value" sub-field, and return the value in target. More...
 
template<class T >
casacore::Bool readOptionRecord (T &target, casacore::Bool &error, const casacore::Record &rec, const casacore::String &fieldname) const
 
virtual casacore::Bool readOptionRecord (casacore::String &target, casacore::Bool &unsetTarget, casacore::Bool &error, const casacore::Record &rec, const casacore::String &fieldname) const
 Find the field fieldname in casacore::Record rec, containing the requested type (casacore::String) in itself or its "value" sub-field, and return the value in target. More...
 
casacore::Record unset () const
 Return a casacore::Record which is an "unset" casacore::Record, ie. More...
 
casacore::Bool isUnset (const casacore::Record &rec) const
 Return true or false indicating if the provided casacore::Record is equal to an "unset" Record. More...
 
- Public Member Functions inherited from casa::DisplayEH
virtual ~DisplayEH ()
 
- Public Member Functions inherited from casa::DlTarget
 DlTarget ()
 
 DlTarget (const DlTarget &)
 
virtual ~DlTarget ()
 
void reg (DlHandleBase *p)
 
void unreg (DlHandleBase *p)
 

Static Public Member Functions

static bool getRectanglePoints (double centerX, double centerY, double radiusX, double radiusY, double angle, casacore::Vector< double > &xPoints, casacore::Vector< double > &yPoints)
 Static Members //. More...
 
- Static Public Member Functions inherited from casa::RegionShape
static RegionShapeshapeFromRecord (const casacore::RecordInterface &properties, casacore::String &error)
 Creates a record of the correct type from the given record (see RegionShape class description), or NULL if a fatal error occurred. More...
 
static std::vector< LineStyleallLineStyles ()
 Returns all available line styles. More...
 
static casacore::String convLineStyle (LineStyle style)
 Convert between line style enum and String. More...
 
static LineStyle convLineStyle (casacore::String style)
 

Protected Member Functions

void getShapeSpecificProperties (casacore::Record &properties) const
 same order More...
 
void setShapeSpecificProperties (const casacore::RecordInterface &)
 Implements RegionShape::setShapeSpecificProperties. More...
 
bool updateScreenCoordinates (WorldCanvasHolder &wch, casacore::String *err)
 Updates screen coords using world/pixel coords and the given WorldCanvas. More...
 
void updatePoints ()
 Translates m_spec into m_x and m_y. More...
 
void updateMinMax ()
 Update m_xMin, m_xMax, m_yMin, and m_yMax. More...
 
- Protected Member Functions inherited from casa::RegionShape
void setLineProperties (PixelCanvas *pc)
 Common RegionShape Methods //. More...
 
void setLinethroughProperties (PixelCanvas *pc)
 Sets the linethrough properties (color, width, style) of this shape for the given PixelCanvas. More...
 
void resetLineStyle (PixelCanvas *pc) const
 Used for resetting the line style on the given PixelCanvas back to solid, in case future uses are expecting solid lines. More...
 
bool worldToPixel (const casacore::Quantum< casacore::Vector< double > > &worldX, const casacore::Quantum< casacore::Vector< double > > &worldY, casacore::Vector< double > &pixelX, casacore::Vector< double > &pixelY, WorldCanvasHolder &wch, bool wrap=true, casacore::String *error=NULL) const
 Convenience access to RSUtils conversion methods. More...
 
bool pixelToWorld (const casacore::Vector< double > &pixelX, const casacore::Vector< double > &pixelY, casacore::Quantum< casacore::Vector< double > > &worldX, casacore::Quantum< casacore::Vector< double > > &worldY, WorldCanvasHolder &wch, bool wrap=true, casacore::String *error=NULL) const
 
bool worldToLinear (const casacore::Quantum< casacore::Vector< double > > &worldX, const casacore::Quantum< casacore::Vector< double > > &worldY, casacore::Vector< double > &linearX, casacore::Vector< double > &linearY, WorldCanvasHolder &wch, bool wrap=true, casacore::String *error=NULL) const
 
bool worldToScreen (const casacore::Quantum< casacore::Vector< double > > &worldX, const casacore::Quantum< casacore::Vector< double > > &worldY, casacore::Vector< double > &screenX, casacore::Vector< double > &screenY, WorldCanvasHolder &wch, bool wrap=true, casacore::String *error=NULL) const
 
bool linearToWorld (const casacore::Vector< double > &linearX, const casacore::Vector< double > &linearY, casacore::Quantum< casacore::Vector< double > > &worldX, casacore::Quantum< casacore::Vector< double > > &worldY, WorldCanvasHolder &wch, casacore::String *error=NULL) const
 
bool linearToWorld (const casacore::Vector< double > &linearX, const casacore::Vector< double > &linearY, casacore::Quantum< casacore::Vector< double > > &worldX, casacore::Quantum< casacore::Vector< double > > &worldY, WorldCanvasHolder &wch, const std::vector< int > &xSign, const std::vector< int > &ySign, casacore::String *error=NULL) const
 
bool screenToWorld (const casacore::Vector< double > &screenX, const casacore::Vector< double > &screenY, casacore::Quantum< casacore::Vector< double > > &worldX, casacore::Quantum< casacore::Vector< double > > &worldY, WorldCanvasHolder &wch, casacore::String *error=NULL) const
 
bool screenToWorld (const casacore::Vector< double > &screenX, const casacore::Vector< double > &screenY, casacore::Quantum< casacore::Vector< double > > &worldX, casacore::Quantum< casacore::Vector< double > > &worldY, WorldCanvasHolder &wch, const std::vector< int > &xSign, const std::vector< int > &ySign, casacore::String *error=NULL) const
 
- Protected Member Functions inherited from casa::PassiveCachingDD
virtual AttributeBuffer optionsAsAttributes ()
 Return the current options of this DisplayData as an AttributeBuffer. More...
 
 PassiveCachingDD (const PassiveCachingDD &other)
 (Required) copy constructor. More...
 
void operator= (const PassiveCachingDD &other)
 (Required) copy assignment. More...
 
- Protected Member Functions inherited from casa::CachingDisplayData
virtual void setCaching (const casacore::Bool caching)
 Return any additional Attributes to consider when searching the cache. More...
 
 CachingDisplayData (const CachingDisplayData &other)
 (Required) copy constructor. More...
 
void operator= (const CachingDisplayData &other)
 (Required) copy assignment. More...
 
- Protected Member Functions inherited from casa::DisplayData
virtual casacore::Bool setActiveZIndex_ (casacore::Int zindex)
 DDs may override to adjust the internal stored current animation index (activeZIndex_) if necessary, and to set return value false iff the passed zindex won't work for the DD. More...
 
casacore::Bool conformed ()
 Returns result of last call to conformsTo(WCH&). More...
 
casacore::Bool isCsAndZIndexConformed ()
 Added so that when two images are loaded with no velocity alignment, they can still show their position coordinates without having to be rstrsConformed. More...
 
virtual void delTmpData (casacore::String &tmpData)
 Delete temporary data. More...
 
virtual const std::list
< WCPositionEH * > * 
positionEventHandlerList ()
 Retrieve position, motion, refresh and display event handler lists. More...
 
virtual const std::list
< WCMotionEH * > * 
motionEventHandlerList ()
 
virtual const std::list
< WCRefreshEH * > * 
refreshEventHandlerList ()
 
virtual const std::list
< DisplayEH * > * 
displayEventHandlerList ()
 
virtual void positionEH (const WCPositionEvent &ev)
 Position, motion and refresh event handlers that will generally be called by a WorldCanvasHolder. More...
 
virtual void motionEH (const WCMotionEvent &ev)
 
 DisplayData (const DisplayData &other)
 (Required) copy constructor. More...
 
void operator= (const DisplayData &other)
 (Required) copy assignment. More...
 
- Protected Member Functions inherited from casa::DisplayOptions
 DisplayOptions (const DisplayOptions &other)
 (Required) copy constructor. More...
 
void operator= (const DisplayOptions &other)
 (Required) copy assignment. More...
 

Protected Attributes

vector< double > m_spec
 
casacore::Vector< double > m_x
 either world or pixel coords More...
 
casacore::Vector< double > m_y
 
casacore::Vector< double > m_screenX
 in order: [upL, boL, boR, upR] More...
 
casacore::Vector< double > m_screenY
 
- Protected Attributes inherited from casa::RegionShape
bool m_isWorld
 Common RegionShape Members //. More...
 
casacore::MDirection::Types m_worldSystem
 World system (undefined if m_isWorld is false). More...
 
casacore::String m_color
 Line color. More...
 
double m_width
 Line width. More...
 
LineStyle m_style
 Line style. More...
 
RegionShapeLabel m_label
 Label. More...
 
bool m_lt
 Linethrough properties. More...
 
casacore::String m_ltColor
 
double m_ltWidth
 
LineStyle m_ltStyle
 
double m_xMin
 Bounding box, in world/pixel coords. More...
 
double m_xMax
 
double m_yMin
 
double m_yMax
 
double m_screenXMin
 Bounding box, in screen pixels. More...
 
double m_screenXMax
 
double m_screenYMin
 
double m_screenYMax
 
WorldCanvasHolderm_lastWCH
 Last seen WorldCanvasHolder. More...
 
bool m_hadDrawingError
 For keeping track of drawing/conversion errors. More...
 
casacore::String m_drawingError
 
- Protected Attributes inherited from casa::CachingDisplayData
casacore::Bool restorePCColormap_
 The default is false. More...
 
- Protected Attributes inherited from casa::DisplayData
AttributeBuffer restrictions
 The Book says that we should not put data members in class that is supposed to only define an interface, but by putting these here, we can implement some of the restriction & eventhandling stuff so that people do not have to repeat it. More...
 
AttributeBuffer attributes
 buffer for storing Attributes More...
 
casacore::PtrBlock< void * > DDelement
 list of DisplayDataElements, which are of type DisplayMethod or derived More...
 
casacore::Int activeZIndex_
 Indicates the 'current' animation frame, i.e. More...
 
casacore::Bool delTmpData_
 Flag indicating that temporary data should be removed when deleting the object. More...
 
casacore::Bool rstrsConformed_
 Somewhat limited-use state, saved here for 'efficiency'. More...
 
casacore::Bool csConformed_
 
casacore::Bool zIndexConformed_
 

Additional Inherited Members

- Public Types inherited from casa::RegionShape
enum  CoordinateParameterType {
  POSITION,
  SIZE,
  ANGLE,
  PIXEL
}
 Different types for coordinate parameters. More...
 
enum  OptionType {
  STRING,
  STRINGCHOICE,
  STRINGARRAY,
  STRINGCHOICEARRAY,
  DOUBLE,
  BOOL
}
 Different types for options. More...
 
enum  LineStyle {
  SOLID,
  DASHED,
  DOTTED
}
 Different line styles. More...
 
- Public Types inherited from casa::DisplayData
enum  DisplayState {
  DISPLAYED,
  UNDISPLAYED,
  LIMBO
}
 
- Static Public Attributes inherited from casa::RegionShape
static const casacore::String UNIT
 Static Members //. More...
 
static const double UNIT_WRAPAROUND
 Value used for wrapping negative/positive unit values. More...
 
static const casacore::String PROPISWORLD
 Properties. More...
 
static const casacore::String PROPWORLDSYSTEM
 
static const casacore::String PROPLINE_COLOR
 
static const casacore::String PROPLINE_WIDTH
 
static const casacore::String PROPLINE_STYLE
 
static const casacore::String PROPTEXT
 
static const casacore::String PROPTEXT_COLOR
 
static const casacore::String PROPTEXT_FONT
 
static const casacore::String PROPTEXT_SIZE
 
static const casacore::String PROPTEXT_ITALIC
 
static const casacore::String PROPTEXT_BOLD
 
static const casacore::String PROPLINETHROUGH
 
static const casacore::String PROPLINETHROUGH_COLOR
 
static const casacore::String PROPLINETHROUGH_WIDTH
 
static const casacore::String PROPLINETHROUGH_STYLE
 
static const casacore::String PROPCOORDINATES
 
static const casacore::String PROPOPTIONS
 
static const casacore::String PROPTYPE
 
static const casacore::String PROPTYPE_ELLIPSE
 
static const casacore::String PROPTYPE_CIRCLE
 
static const casacore::String PROPTYPE_RECTANGLE
 
static const casacore::String PROPTYPE_POLYGON
 
static const casacore::String PROPTYPE_LINE
 
static const casacore::String PROPTYPE_VECTOR
 
static const casacore::String PROPTYPE_MARKER
 
static const casacore::String PROPTYPE_TEXT
 
static const casacore::String PROPTYPE_COMPOSITE
 
static const casacore::String DEFAULT_COLOR
 Defaults. More...
 
static const double DEFAULT_WIDTH
 
static const LineStyle DEFAULT_STYLE
 
- Static Public Attributes inherited from casa::DisplayData
static const casacore::String DATA_MIN
 
static const casacore::String DATA_MAX
 

Detailed Description

Subclass of RegionShape used for drawing rectangles.

A rectangle has the following properties in addition to those listed for RegionShape:

Definition at line 202 of file RegionShapes.h.

Constructor & Destructor Documentation

casa::RSRectangle::RSRectangle ( double  x,
double  y,
double  width,
double  height,
casacore::MDirection::Types  worldSystem,
double  angle = 0 
)

Non-Static Members //.

World Constructor. x, y, width, and height must all be 1) using the same world system as defined by worldSystem, and 2) in unit RegionShape::UNIT. (x, y) specifies the center of the rectangle. Angle is in counterclockwise degrees starting at the east vector.

casa::RSRectangle::RSRectangle ( double  x,
double  y,
double  width,
double  height,
double  angle = 0 
)

Pixel Constructor.

(x, y) specifies the center of the rectangle.

casa::RSRectangle::RSRectangle ( const casacore::RecordInterface properties)

casacore::Record Constructor.

casa::RSRectangle::~RSRectangle ( )

Destructor.

Member Function Documentation

std::vector<casacore::String> casa::RSRectangle::coordParameterNames ( ) const
virtual
std::vector<CoordinateParameterType> casa::RSRectangle::coordParameterTypes ( ) const
virtual

Implements RegionShape::coordParameterPositions.

Implements casa::RegionShape.

std::vector<double> casa::RSRectangle::coordParameterValues ( ) const
virtual
std::vector<double> casa::RSRectangle::coordParameterValues ( casacore::String  toSystem) const
virtual
bool casa::RSRectangle::drawAndUpdateBoundingBox ( WorldCanvasHolder wch,
casacore::String err = NULL 
)
virtual
RSHandle casa::RSRectangle::getHandle ( ) const
virtual

Implements RegionShape::getHandle.

Implements casa::RegionShape.

void casa::RSRectangle::getRectangleCoordinates ( double &  x,
double &  y,
double &  width,
double &  height,
double &  angle,
casacore::String  toSystem = "" 
) const

Gets rectangle-specific coordinates, to avoid dependence on coordParameterValues() when the shape type is known.

If toSystem is empty, no conversion is done; otherwise see the constraints listed in RegionShape::coordParameterValues(casacore::String).

static bool casa::RSRectangle::getRectanglePoints ( double  centerX,
double  centerY,
double  radiusX,
double  radiusY,
double  angle,
casacore::Vector< double > &  xPoints,
casacore::Vector< double > &  yPoints 
)
static

Static Members //.

Gets the four rectangle points for the given center, radii, and angle and puts them in the given vectors. Returns whether or not the operation succeeded. Angle is in counterclockwise degrees. The point order is [top right, top left, bottom left, bottom right] in the coordinate system of the given points.

void casa::RSRectangle::getShapeSpecificProperties ( casacore::Record properties) const
inlineprotectedvirtual
void casa::RSRectangle::move ( double  dx,
double  dy,
casacore::String  system = "" 
)
virtual

Implements RegionShape::move.

Implements casa::RegionShape.

std::vector<casacore::String> casa::RSRectangle::optionNames ( ) const
inlinevirtual

Implements RegionShape option methods.

Note: rectangles do not have additonal options.

Implements casa::RegionShape.

Definition at line 279 of file RegionShapes.h.

std::vector<OptionType> casa::RSRectangle::optionTypes ( ) const
inlinevirtual

Returns the types for options.

Implements casa::RegionShape.

Definition at line 282 of file RegionShapes.h.

std::vector<RSOption> casa::RSRectangle::optionValues ( ) const
inlinevirtual

Returns the current values for options.

Implements casa::RegionShape.

Definition at line 285 of file RegionShapes.h.

void casa::RSRectangle::setCoordParameters ( const std::vector< double > &  vals)
virtual
void casa::RSRectangle::setCoordParameters ( const std::vector< double > &  vals,
casacore::String  valSystem 
)
virtual
void casa::RSRectangle::setOptionValues ( const vector< RSOption > &  options)
inlinevirtual

Sets the options to the given.

Implements casa::RegionShape.

Definition at line 288 of file RegionShapes.h.

void casa::RSRectangle::setShapeSpecificProperties ( const casacore::RecordInterface )
inlineprotectedvirtual

Implements RegionShape::setShapeSpecificProperties.

Implements casa::RegionShape.

Definition at line 305 of file RegionShapes.h.

casacore::String casa::RSRectangle::type ( ) const
inlinevirtual

Implements RegionShape::type.

Implements casa::RegionShape.

Definition at line 240 of file RegionShapes.h.

void casa::RSRectangle::updateMinMax ( )
protected

Update m_xMin, m_xMax, m_yMin, and m_yMax.

void casa::RSRectangle::updatePoints ( )
protected

Translates m_spec into m_x and m_y.

bool casa::RSRectangle::updateScreenCoordinates ( WorldCanvasHolder wch,
casacore::String err 
)
protected

Updates screen coords using world/pixel coords and the given WorldCanvas.

Member Data Documentation

casacore::Vector<double> casa::RSRectangle::m_screenX
protected

in order: [upL, boL, boR, upR]

Definition at line 296 of file RegionShapes.h.

casacore::Vector<double> casa::RSRectangle::m_screenY
protected

Definition at line 296 of file RegionShapes.h.

vector<double> casa::RSRectangle::m_spec
protected

Definition at line 292 of file RegionShapes.h.

casacore::Vector<double> casa::RSRectangle::m_x
protected

either world or pixel coords

Definition at line 294 of file RegionShapes.h.

casacore::Vector<double> casa::RSRectangle::m_y
protected

Definition at line 294 of file RegionShapes.h.


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