casa::DSEllipse Class Reference

Implementation of a ellipse. More...

#include <DSEllipse.h>

Inheritance diagram for casa::DSEllipse:

Public Member Functions
	DSEllipse (const Bool &onlyShowOneHandle=False)
	Constructors and destructors.
	DSEllipse (const DSEllipse &other)
	DSEllipse (const Float &xPos, const Float &yPos, const Float &major, const Float &minor, const Bool &hasHandles=False, const Bool &drawHandles=False, const Bool &onlyShowOneHandle=False)
virtual	~DSEllipse ()
virtual void	draw (PixelCanvas *pix)
	General DisplayShape functions.
virtual void	move (const Float &dX, const Float &dY)
virtual Bool	inObject (const Float &xPos, const Float &yPos)
	Is the supplied point within the DisplayShape?
virtual void	rotate (const Float &angle)
	Rotate the shape about its center by a set angle (angle in degrees).
virtual void	rotateAbout (const Float &angle, const Float &aboutX, const Float &aboutY)
virtual void	setCenter (const Float &xPos, const Float &yPos)
	Sets the center of the DisplayShape.
virtual Vector< Float >	getCenter ()
	Returns the center of the DisplayShape (x,y).
virtual void	changePoint (const Vector< Float > &newPoint)
	Changes the closest point to the supplied location to that location.
virtual void	changePoint (const Vector< Float > &newPoint, const Int nPoint)
	Changes the nth point making up the DisplayShape ot the specified location.
virtual void	scale (const Float &scaleFactor)
	Scale the shape about its center by the scaleFactor.
virtual Float	getMinorAxis ()
	Functions to set / get the minor and major axis of the ellipse (in pixels).
virtual Float	getMajorAxis ()
virtual void	setMajorAxis (const Float &newMajor)
virtual void	setMinorAxis (const Float &newMinor)
virtual Record	getOptions ()
	Get and set options.
virtual Bool	setOptions (const Record &settings)
Protected Member Functions
virtual void	calculateHandlePositions ()
	Required on update.
Private Member Functions
virtual void	setDefaultOptions ()
	Called when def.
Private Attributes
Vector< Float >	itsCenter
Float	itsAngle
Float	itsMajorAxis
Float	itsMinorAxis
Bool	itsValid
Bool	itsOneHandle
Matrix< Float >	itsHandleLocation

Detailed Description

Implementation of a ellipse.

Prerequisite

DisplayShape

Etymology

DSEllipse is a method of managing the drawing of a ellipse onto a PixelCanvas.

Synopsis

DSEllipse is the DisplayShape implementation of the primitive ellipse.

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 allow the management of ellipses being draw to a pixel canvas.

Example

Definition at line 71 of file DSEllipse.h.

Constructor & Destructor Documentation

casa::DSEllipse::DSEllipse ( const Bool & onlyShowOneHandle = False )

Constructors and destructors.

the 'onlyShowOneHandle' flag is primarily for use if the ellipse is intended to remain symmetrical i.e. a circle.

casa::DSEllipse::DSEllipse ( const DSEllipse & other )

casa::DSEllipse::DSEllipse	(	const Float &	xPos,
		const Float &	yPos,
		const Float &	major,
		const Float &	minor,
		const Bool &	hasHandles = `False`,
		const Bool &	drawHandles = `False`,
		const Bool &	onlyShowOneHandle = `False`
	)