casa::DSClosed Class Reference

DSClosed provides common functionality for all "closed" shapes. More...

#include <DSClosed.h>

Inheritance diagram for casa::DSClosed:

Public Types
enum	FillStyle {   No_Fill,   Full_Fill }
	Type of fill to use. More...
Public Types inherited from casa::DisplayShape
enum	HandleShape {   Filled_Square,   Open_Square,   Filled_Circle,   Open_Circle,   Filled_Triangle,   Open_Triangle }
	Handle style. More...

Public Member Functions
	DSClosed ()
	Constructors and destructors. More...
	DSClosed (const DSClosed &other)
virtual	~DSClosed ()
virtual void	setFillStyle (DSClosed::FillStyle fill)
	Get / Set fill options. More...
virtual DSClosed::FillStyle	getFillStyle ()
virtual void	setFillColor (casacore::String color)
virtual casacore::String	getFillColor ()
virtual void	draw (PixelCanvas *pc)
	General DisplayShape functions. More...
virtual void	rotateAbout (const casacore::Float &angle, const casacore::Float &aboutX, const casacore::Float &aboutY)
virtual void	move (const casacore::Float &dX, const casacore::Float &dY)
virtual casacore::Record	getOptions ()
	Get and set options. More...
virtual casacore::Bool	setOptions (const casacore::Record &settings)
Public Member Functions inherited from casa::DSBasic
	DSBasic ()
	Default constructor. More...
	DSBasic (const DSBasic &other)
	Copy constructor. More...
virtual	~DSBasic ()
	Destructor. More...
virtual void	setLineWidth (const casacore::Int pixels)
	Manage line width. More...
virtual casacore::Int	getLineWidth ()
Public Member Functions inherited from casa::DisplayShape
	DisplayShape ()
	Default constructor. More...
	DisplayShape (const DisplayShape &other)
	Copy constructor. More...
virtual	~DisplayShape ()
	Destructor. More...
virtual casacore::Matrix < casacore::Float >	rotatePolygon (const casacore::Matrix< casacore::Float > &toRotate, const casacore::Float &angle, const casacore::Float &aboutX, const casacore::Float &aboutY)
	Rotate the supplied polygon (column 1 - x values, column 2 - y values) about the supplied point by the supplied angle. More...
virtual casacore::Vector < casacore::Float >	rotatePoint (const casacore::Vector< casacore::Float > &toRotate, const casacore::Float &angle, const casacore::Float &aboutX, const casacore::Float &aboutY)
	Rotates a point around the point specified. More...
virtual casacore::Matrix < casacore::Float >	translateMatrix (const casacore::Matrix< casacore::Float > &points, const casacore::Float &dx, const casacore::Float &dy)
	Translate an entire matrix by the specified dx / dy amounts. More...
virtual casacore::Bool	inPolygon (const casacore::Matrix< casacore::Float > &points, const casacore::Float &xPos, const casacore::Float &yPos)
	Is xPos, YPos inside the supplied points (column 1 - x values, clolumn 2 - y values) More...
virtual casacore::Bool	closestLine (const casacore::Matrix< casacore::Float > &points, const casacore::Float &xPos, const casacore::Float &yPos, casacore::Int &firstVert, casacore::Int &secondVert, const casacore::Bool &closedPoly=true)
	Determine the two vertices (firstVert, secondVert) which join the line closest to the xPos, yPos point supplied. More...
virtual casacore::Bool	closestPoint (const casacore::Matrix< casacore::Float > &points, const casacore::Float &xPos, const casacore::Float &yPos, casacore::Int &out)
	For a specified set of points, find the closest to xPos,YPos. More...
virtual casacore::Bool	closestPoints (const casacore::Matrix< casacore::Float > &points, const casacore::Float &xPos, const casacore::Float &yPos, casacore::Int &outClosest, casacore::Int &outSecond)
	Find the closest two Points from a casacore::Matrix to the specified point. More...
virtual casacore::Bool	inObject (const casacore::Float &xPos, const casacore::Float &yPos)=0
	Is the supplied point within the DisplayShape? More...
virtual casacore::Float	toRadians (const casacore::Float &degrees)
	Convert degrees to radians. More...
virtual casacore::Float	toDegrees (const casacore::Float &radians)
	Conver radians to degree. More...
virtual void	setCenter (const casacore::Float &xPos, const casacore::Float &yPos)=0
	Sets the center of the DisplayShape. More...
virtual casacore::Vector < casacore::Float >	getCenter ()=0
	Returns the center of the DisplayShape (x,y). More...
virtual void	changePoint (const casacore::Vector< casacore::Float > &newPos)=0
	Changes the closest point to the supplied location to that location. More...
virtual void	changePoint (const casacore::Vector< casacore::Float > &newPoint, const casacore::Int nPoint)=0
	Changes the nth point making up the DisplayShape ot the specified location. More...
virtual void	addPoint (const casacore::Vector< casacore::Float > &)
	If applicable, this function will add a point to the shape in the most meaningful location. More...
virtual void	rotate (const casacore::Float &angle)=0
	Rotate the shape about its center by a set angle (angle in degrees). More...
virtual void	scale (const casacore::Float &scaleFactor)=0
	Scale the shape about its center by the scaleFactor. More...
virtual void	addLocked (DisplayShape *toLock)
	Allow locking of other shapes onto this one. More...
virtual void	removeLocked (DisplayShape *removeLock)
	Removes a lock from the specified shape. More...
virtual void	buildHandles (const casacore::Matrix< casacore::Float > &startPoints)
	Handle management. More...
virtual casacore::Matrix < casacore::Float >	getHandleLocations ()
virtual void	setHandlePositions (const casacore::Matrix< casacore::Float > &newPoints)
virtual DSClosed *	makeHandle (const casacore::Vector< casacore::Float > &newHandlePos)
virtual void	addHandle (const casacore::Vector< casacore::Float > &newHandlePos, const casacore::Bool &atEnd=true, const casacore::Int position=0)
virtual casacore::Bool	removeHandle (const casacore::Vector< casacore::Float > &getRidOf)
virtual casacore::Bool	removeHandle (const casacore::Int nHandle)
virtual casacore::Bool	onHandles (const casacore::Float &xPos, const casacore::Float &yPos)
virtual casacore::Bool	whichHandle (const casacore::Float &xPos, const casacore::Float &yPos, casacore::Int &out)
virtual void	setDrawHandles (const casacore::Bool &shouldIDraw)
virtual casacore::Bool	drawingHandles ()
virtual void	setHasHandles (const casacore::Bool &hasHandles)
virtual void	setHandleShape (const DisplayShape::HandleShape &shape)
virtual void	setHandleSize (const casacore::Int pixelSize)
virtual void	setHandleColor (const casacore::String &handleColor)
virtual casacore::uInt	nHandles ()
virtual void	setColor (const casacore::String &newColor)
	Manage the color of object. More...
virtual casacore::String	getColor ()
virtual void	recalculateScreenPosition ()

Private Member Functions
virtual void	setDefaultOptions ()
	Used to set up the class when default constructor called. More...

Private Attributes
DSClosed::FillStyle	itsFillStyle
casacore::String	itsFillColor

Detailed Description

DSClosed provides common functionality for all "closed" shapes.

Prerequisite

• DSBasic
• DisplayShape

Etymology

DSClosed is used to provide a common interface for all closed shapes

Synopsis

DSClosed simply manages the fill options of any closed display shapes.

Motivation

A desire for a common interface for all closed shapes.

Example

Definition at line 64 of file DSClosed.h.

Member Enumeration Documentation

enum casa::DSClosed::FillStyle

Type of fill to use.

Enumerator
No_Fill
Full_Fill

Definition at line 69 of file DSClosed.h.

Constructor & Destructor Documentation

casa::DSClosed::DSClosed

(

)

Constructors and destructors.

casa::DSClosed::DSClosed

(

const DSClosed &

other

)

virtual casa::DSClosed::~DSClosed ( )

virtual

Member Function Documentation

virtual void casa::DSClosed::draw ( PixelCanvas *  pc )

virtual

General DisplayShape functions.

The non abstract functions in this group simply pass on calls up the class tree.

Reimplemented from casa::DSBasic.

Reimplemented in casa::DSPoly, casa::DSEllipse, casa::DSWorldPoly, casa::DSWorldEllipse, and casa::DSWorldRectangle.

virtual casacore::String casa::DSClosed::getFillColor ( )

virtual

virtual DSClosed::FillStyle casa::DSClosed::getFillStyle ( )

virtual

virtual casacore::Record casa::DSClosed::getOptions ( )

virtual

Get and set options.

Reimplemented from casa::DSBasic.

Reimplemented in casa::DSRectangle, casa::DSPoly, casa::DSEllipse, casa::DSCircle, casa::DSSquare, casa::DSWorldPoly, casa::DSWorldEllipse, casa::DSWorldRectangle, casa::DSScreenPoly, casa::DSPixelEllipse, casa::DSPixelRectangle, casa::DSPixelPoly, casa::DSScreenEllipse, and casa::DSScreenRectangle.

virtual void casa::DSClosed::move ( const casacore::Float &  dX, const casacore::Float &  dY  )

virtual

Reimplemented from casa::DSBasic.

Reimplemented in casa::DSRectangle, casa::DSPoly, casa::DSEllipse, casa::DSWorldPoly, casa::DSScreenPoly, casa::DSWorldEllipse, casa::DSWorldRectangle, casa::DSScreenEllipse, and casa::DSScreenRectangle.

virtual void casa::DSClosed::rotateAbout ( const casacore::Float &  angle, const casacore::Float &  aboutX, const casacore::Float &  aboutY  )

virtual

Reimplemented from casa::DSBasic.

Reimplemented in casa::DSRectangle, casa::DSPoly, and casa::DSEllipse.

virtual void casa::DSClosed::setDefaultOptions ( )

privatevirtual

Used to set up the class when default constructor called.

Reimplemented from casa::DisplayShape.

Reimplemented in casa::DSRectangle, casa::DSEllipse, casa::DSPoly, and casa::DSCircle.

virtual void casa::DSClosed::setFillColor ( casacore::String  color )

virtual

virtual void casa::DSClosed::setFillStyle ( DSClosed::FillStyle  fill )

virtual

Get / Set fill options.

virtual casacore::Bool casa::DSClosed::setOptions ( const casacore::Record &  settings )

virtual

Reimplemented from casa::DSBasic.

Reimplemented in casa::DSRectangle, casa::DSPoly, casa::DSEllipse, casa::DSCircle, casa::DSSquare, casa::DSWorldPoly, casa::DSWorldEllipse, casa::DSWorldRectangle, casa::DSScreenPoly, casa::DSPixelEllipse, casa::DSPixelRectangle, casa::DSPixelPoly, casa::DSScreenEllipse, and casa::DSScreenRectangle.

Member Data Documentation

casacore::String casa::DSClosed::itsFillColor

private

Definition at line 108 of file DSClosed.h.

DSClosed::FillStyle casa::DSClosed::itsFillStyle

private

Definition at line 107 of file DSClosed.h.

---

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

• casa/code/display/DisplayShapes/DSClosed.h