Implementation of a square. More...

#include <DSSquare.h>

Inheritance diagram for casa::DSSquare:

Public Member Functions
	DSSquare ()
	Default constructor. More...

	DSSquare (const casacore::Float &xPos, const casacore::Float &yPos, const casacore::Float &size, const casacore::Bool &handles=false, const casacore::Bool &drawHandles=false)
	Constructor. More...

	DSSquare (const DSSquare &other)
	Copy cons. More...

virtual	~DSSquare ()
	Destructor. More...

virtual void	setSize (const casacore::Float &size)
	Copy constructor. More...

virtual void	changePoint (const casacore::Vector< casacore::Float > &pos)
	Change the points, while maintaining the shape as a square. More...

virtual void	changePoint (const casacore::Vector< casacore::Float > &pos, const casacore::Int nPoint)
	Changes the nth point making up the DisplayShape ot the specified location. More...

virtual casacore::Bool	setOptions (const casacore::Record &settings)
	Get and set options. More...

virtual casacore::Record	getOptions ()
	Get and set options. More...

Public Member Functions inherited from casa::DSRectangle
	DSRectangle ()
	Constructors and Destructors. More...

	DSRectangle (const casacore::Float &xPos, const casacore::Float &yPos, const casacore::Float &width, const casacore::Float &height, const casacore::Bool &handles=false, const casacore::Bool &drawHandles=false)

	DSRectangle (const DSRectangle &other)

virtual	~DSRectangle ()

virtual void	move (const casacore::Float &dX, const casacore::Float &dY)
	Standard DisplayShape functions. More...

virtual void	rotate (const casacore::Float &angle)
	Rotate the shape about its center by a set angle (angle in degrees). More...

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

virtual void	setCenter (const casacore::Float &xPos, const casacore::Float &yPos)
	Sets the center of the DisplayShape. More...

virtual void	addPoint (const casacore::Vector< casacore::Float > &toAdd)
	Polygon specific functions, add, delete and set points, all in pixels. More...

virtual void	setHeight (const casacore::Float &height)
	Rectangle specific. More...

virtual void	setWidth (const casacore::Float &width)

virtual casacore::Float	getHeight ()

virtual casacore::Float	getWidth ()

virtual casacore::Matrix < casacore::Float >	makeAsPoly (const casacore::Float &xPos, const casacore::Float &yPos, const casacore::Float &width, const casacore::Float &height)
	Using supplied parameters, make a polygon of four points representing the rectangle. More...

Public Member Functions inherited from casa::DSPoly
	DSPoly ()
	Constructors and destructor. More...

	DSPoly (const DSPoly &other)

	DSPoly (const casacore::Matrix< casacore::Float > &points, const casacore::Bool &handles=false, const casacore::Bool &drawHandles=false)

virtual	~DSPoly ()

virtual void	draw (PixelCanvas *pc)
	General DisplayShape functions. More...

virtual casacore::Bool	inObject (const casacore::Float &xPos, const casacore::Float &yPos)
	Is the supplied point within the DisplayShape? More...

virtual void	scale (const casacore::Float &scale)
	Scale the shape about its center by the scaleFactor. More...

virtual casacore::Vector < casacore::Float >	getCenter ()
	Returns the center of the DisplayShape (x,y). More...

virtual void	deletePoint (const casacore::Vector< casacore::Float > &removePoint)

virtual void	deletePoint (const casacore::Int nPoint)

virtual void	setPoints (const casacore::Matrix< casacore::Float > &newPoints)

Public Member Functions inherited from casa::DSClosed
	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 ()

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::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	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 ()

Additional Inherited Members
Public Types inherited from casa::DSClosed
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...

Protected Member Functions inherited from casa::DSRectangle
virtual casacore::Float	getAngle ()

Protected Member Functions inherited from casa::DSPoly
virtual casacore::Matrix < casacore::Float >	getPoints ()

Detailed Description

Implementation of a square.

Prerequisite

Etymology

DSSquare is a method of managing the drawing of a square onto a PixelCanvas.

Synopsis

DSSquare simple extends DSRectangle, and takes much of its functionality from there. It also overrides some functions to ensure that during manipulation of the shape, it remains a square.

There are generally two ways to make DisplayShape(s); To create them in "one hit" by providing arguments to the constructor, or by using the default constructor and then the "setOptions" method. A simple interface for all classes inheriting from the DisplayShape class is provided by DisplayShapeInterface.

Motivation

To enable the drawing of squares onto a pixel canvas

Example

Definition at line 72 of file DSSquare.h.

Constructor & Destructor Documentation

casa::DSSquare::DSSquare ( )

Default constructor.

casa::DSSquare::DSSquare	(	const casacore::Float &	xPos,
		const casacore::Float &	yPos,
		const casacore::Float &	size,
		const casacore::Bool &	handles = `false`,
		const casacore::Bool &	drawHandles = `false`
	)

Constructor.

Accepts the centre (xPos, yPos), the size (height/width in pixels), and whether or not it will ever have handles and if so, whether to draw them now.

casa::DSSquare::DSSquare ( const DSSquare & other )

Copy cons.

virtual casa::DSSquare::~DSSquare ( )

virtual

Destructor.

Member Function Documentation

virtual void casa::DSSquare::changePoint ( const casacore::Vector< casacore::Float > & pos )

virtual

Change the points, while maintaining the shape as a square.

Reimplemented from casa::DSRectangle.

virtual void casa::DSSquare::changePoint	(	const casacore::Vector< casacore::Float > &	newPoint,
		const casacore::Int	nPoint
	)

virtual

Changes the nth point making up the DisplayShape ot the specified location.

Reimplemented from casa::DSRectangle.

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

virtual

Get and set options.

Reimplemented from casa::DSRectangle.

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

virtual

Get and set options.

Reimplemented from casa::DSRectangle.

virtual void casa::DSSquare::setSize ( const casacore::Float & size )

virtual

Copy constructor.

Set the size of the square in pixels

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

casa/code/display/DisplayShapes/DSSquare.h

Public Member Functions

Additional Inherited Members

Detailed Description

Prerequisite

Etymology

Synopsis

Motivation

Example

Constructor & Destructor Documentation

Member Function Documentation