casa::RSCircle Class Reference

Subclass of RSEllipse used for drawing circles. More...

#include <RegionShapes.h>

Inheritance diagram for casa::RSCircle:

List of all members.

Public Member Functions
	RSCircle (double x, double y, double xRadius, MDirection::Types worldSys)
	World constructor.
	RSCircle (double x, double y, double xRadius)
	Pixel constructor.
	RSCircle (const RecordInterface &properties)
	Record Constructor.
	~RSCircle ()
	Destructor.
String	type () const
	Overrides RSEllipse::type.
void	getCircleCoordinates (double &x, double &y, double &xRadius, String toSystem="") const
	Gets circle-specific coordinates, to avoid dependence on coordParameterValues() when the shape type is known.
vector< double >	coordParameterValues () const
	Overrides RSEllipse::coordParameterValues.
vector< double >	coordParameterValues (String toSystem) const
	Overrides RSEllipse::coordParameterValues.
vector< String >	coordParameterNames () const
	Overrides RSEllipse::coordParameterNames.
vector< CoordinateParameterType >	coordParameterTypes () const
	Overrides RSEllipse::coordParameterPositions.
void	setCoordParameters (const vector< double > &vals)
	Overrides RSEllipse::setCoordParameters.
void	setCoordParameters (const vector< double > &vals, String valSystem)
	Overrides RSEllipse::setCoordParameters.
Protected Member Functions
void	getShapeSpecificProperties (Record &properties) const
	Overrides RSEllipse::getShapeSpecificProperties.
bool	updateScreenCoordinates (WorldCanvasHolder &wch, String *err)
	Overrides RSEllipse::updateScreenCoordinates.

---

Detailed Description

Subclass of RSEllipse used for drawing circles.

Only one radius (x) is taken and no angle.

Definition at line 142 of file RegionShapes.h.

---

Constructor & Destructor Documentation

casa::RSCircle::RSCircle	(	double	x,
		double	y,
		double	xRadius,
		MDirection::Types	worldSys
	)

World constructor.

x, y, and xRadius must be of the type defined by worldSys and in units of RegionShape::UNIT.

casa::RSCircle::RSCircle	(	double	x,
		double	y,
		double	xRadius
	)

Pixel constructor.

casa::RSCircle::RSCircle

(

const RecordInterface &

properties

)

Record Constructor.

casa::RSCircle::~RSCircle

(

)

Destructor.

---

Member Function Documentation

vector<String> casa::RSCircle::coordParameterNames

(

)

const [virtual]

Overrides RSEllipse::coordParameterNames.

Reimplemented from casa::RSEllipse.

vector<CoordinateParameterType> casa::RSCircle::coordParameterTypes

(

)

const [virtual]

Overrides RSEllipse::coordParameterPositions.

Reimplemented from casa::RSEllipse.

vector<double> casa::RSCircle::coordParameterValues

(

String

toSystem

)

const [virtual]

Overrides RSEllipse::coordParameterValues.

Reimplemented from casa::RSEllipse.

vector<double> casa::RSCircle::coordParameterValues

(

)

const [virtual]

Overrides RSEllipse::coordParameterValues.

Reimplemented from casa::RSEllipse.

void casa::RSCircle::getCircleCoordinates	(	double &	x,
		double &	y,
		double &	xRadius,
		String	toSystem = ""
	)			const

Gets circle-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(String).

void casa::RSCircle::getShapeSpecificProperties

(

Record &

properties

)

const [inline, protected, virtual]

Overrides RSEllipse::getShapeSpecificProperties.

Reimplemented from casa::RSEllipse.

Definition at line 189 of file RegionShapes.h.

References casa::RegionShape::PROPTYPE, and casa::RegionShape::PROPTYPE_CIRCLE.

void casa::RSCircle::setCoordParameters	(	const vector< double > &	vals,
		String	valSystem
	)			[virtual]

Overrides RSEllipse::setCoordParameters.

Reimplemented from casa::RSEllipse.

void casa::RSCircle::setCoordParameters

(

const vector< double > &

vals

)

[virtual]

Overrides RSEllipse::setCoordParameters.

Reimplemented from casa::RSEllipse.

String casa::RSCircle::type

(

)

const [inline, virtual]

Overrides RSEllipse::type.

Reimplemented from casa::RSEllipse.

Definition at line 158 of file RegionShapes.h.

bool casa::RSCircle::updateScreenCoordinates	(	WorldCanvasHolder &	wch,
		String *	err
	)			[protected, virtual]

Overrides RSEllipse::updateScreenCoordinates.

Reimplemented from casa::RSEllipse.

---

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

• code/display/RegionShapes/RegionShapes.h