casa::DSCircle Class Reference

Circle implementation;extends DSEllipse, adding general circle functions. More...

#include <DSCircle.h>

Inheritance diagram for casa::DSCircle:

List of all members.

Public Member Functions
	DSCircle ()
	Constructors and destructors.
	DSCircle (const Float &xPos, const Float &yPos, const Float &radius, const Bool &hasHandles, const Bool &drawHandles)
	DSCircle (const DSCircle &other)
virtual	~DSCircle ()
virtual void	rotate (const Float &)
	General DisplayShape functionality.
virtual void	setCenter (const Float &xPos, const Float &yPos)
	Sets the center of the DisplayShape.
virtual Bool	inObject (const Float &dX, const Float &dY)
	Is the supplied point within the DisplayShape?
virtual void	changePoint (const Vector< Float > &newPos)
	Changes the closest point to the supplied location to that location.
virtual void	changePoint (const Vector< Float > &newPos, const Int nPoint)
	Changes the nth point making up the DisplayShape ot the specified location.
virtual void	setRadius (const Float &radius)
	Circle specific functionality.
virtual void	setMajorAxis (const Float &)
virtual void	setMinorAxis (const Float &)
virtual Bool	setOptions (const Record &settings)
	Get and set options.
virtual Record	getOptions ()
	Get and set options.
Private Member Functions
virtual void	setDefaultOptions ()
	Function to set defaults when default constructor called.

---

Detailed Description

Circle implementation;extends DSEllipse, adding general circle functions.

Prerequisite

• DSEllipse
• DisplayShape

Etymology

DSCircle is a method of managing the drawing of a circle onto a PixelCanvas.

Synopsis

DSCircle simply extends from DSEllipse, and adds some general circle functionality. It basically replaces the set major and set minor axis functions with a setRadius function. Almost all of the functionality is contained in DSEllipse.

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 display of circles onto a pixel canvas.

Example

Definition at line 77 of file DSCircle.h.

---

Constructor & Destructor Documentation

casa::DSCircle::DSCircle

(

)

Constructors and destructors.

casa::DSCircle::DSCircle	(	const Float &	xPos,
		const Float &	yPos,
		const Float &	radius,
		const Bool &	hasHandles,
		const Bool &	drawHandles
	)

casa::DSCircle::DSCircle

(

const DSCircle &

other

)

virtual casa::DSCircle::~DSCircle

(

)

[virtual]

---

Member Function Documentation

virtual void casa::DSCircle::changePoint	(	const Vector< Float > &	newPoint,
		const Int	nPoint
	)			[virtual]

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

Reimplemented from casa::DSEllipse.

virtual void casa::DSCircle::changePoint

(

const Vector< Float > &

newPos

)

[virtual]

Changes the closest point to the supplied location to that location.

Reimplemented from casa::DSEllipse.

virtual Record casa::DSCircle::getOptions

(

)

[virtual]

Get and set options.

Reimplemented from casa::DSEllipse.

virtual Bool casa::DSCircle::inObject	(	const Float &	xPos,
		const Float &	yPos
	)			[virtual]

Is the supplied point within the DisplayShape?

Reimplemented from casa::DSEllipse.

virtual void casa::DSCircle::rotate

(

const Float &

)

[inline, virtual]

General DisplayShape functionality.

Reimplemented from casa::DSEllipse.

Definition at line 92 of file DSCircle.h.

virtual void casa::DSCircle::setCenter	(	const Float &	xPos,
		const Float &	yPos
	)			[virtual]

Sets the center of the DisplayShape.

Reimplemented from casa::DSEllipse.

virtual void casa::DSCircle::setDefaultOptions

(

)

[private, virtual]

Function to set defaults when default constructor called.

Reimplemented from casa::DSEllipse.

virtual void casa::DSCircle::setMajorAxis

(

const Float &

)

[inline, virtual]

Reimplemented from casa::DSEllipse.

Definition at line 102 of file DSCircle.h.

virtual void casa::DSCircle::setMinorAxis

(

const Float &

)

[inline, virtual]

Reimplemented from casa::DSEllipse.

Definition at line 103 of file DSCircle.h.

virtual Bool casa::DSCircle::setOptions

(

const Record &

settings

)

[virtual]

Get and set options.

Reimplemented from casa::DSEllipse.

virtual void casa::DSCircle::setRadius

(

const Float &

radius

)

[virtual]

Circle specific functionality.

---

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

• code/display/DisplayShapes/DSCircle.h