casa::RSEllipse Class Reference

Subclass of RegionShape used for drawing ellipses. More...

#include <RegionShapes.h>

Inheritance diagram for casa::RSEllipse:

List of all members.

Public Member Functions
	RSEllipse (double x, double y, double xRadius, double yRadius, MDirection::Types worldSystem, double angle=0)
	World Constructor.
	RSEllipse (double x, double y, double xRadius, double yRadius, double angle=0)
	Pixel Constructor.
	RSEllipse (const RecordInterface &properties)
	Record Constructor.
virtual	~RSEllipse ()
	Destructor.
virtual bool	drawAndUpdateBoundingBox (WorldCanvasHolder &wch, String *error=NULL)
	Implements RegionShape::drawAndUpdateBoundingBox.
virtual String	type () const
	Implements RegionShape::type.
void	getEllipseCoordinates (double &x, double &y, double &xRadius, double &yRadius, double &angle, String toSystem="") const
	Gets ellipse-specific coordinates, to avoid dependence on coordParameterValues() when the shape type is known.
virtual vector< double >	coordParameterValues () const
	Implements RegionShape::coordParameterValues.
virtual vector< double >	coordParameterValues (String toSystem) const
	Implements RegionShape::coordParameterValues.
virtual vector< String >	coordParameterNames () const
	Implements RegionShape::coordParameterNames.
virtual vector < CoordinateParameterType >	coordParameterTypes () const
	Implements RegionShape::coordParameterPositions.
virtual void	setCoordParameters (const vector< double > &vals)
	Implements RegionShape::setCoordParameters.
virtual void	setCoordParameters (const vector< double > &vals, String system)
	Implements RegionShape::setCoordParameters.
virtual void	move (double dx, double dy, String system="")
	Implements RegionShape::move.
virtual RSHandle	getHandle () const
	Implements RegionShape::getHandle.
virtual vector< String >	optionNames () const
	Implements RegionShape option methods.
virtual vector< OptionType >	optionTypes () const
	Returns the types for options.
virtual vector< RSOption >	optionValues () const
	Returns the current values for options.
virtual void	setOptionValues (const vector< RSOption > &)
	Sets the options to the given.
Protected Member Functions
virtual void	getShapeSpecificProperties (Record &properties) const
	Implements RegionShape::getShapeSpecificProperties.
virtual void	setShapeSpecificProperties (const RecordInterface &)
	Implements RegionShape::setShapeSpecificProperties.
virtual bool	updateScreenCoordinates (WorldCanvasHolder &wch, String *err)
	Updates screen coords using world/pixel coords and the given WorldCanvas.
virtual void	updateMinMax ()
	Update m_xMin, m_xMax, m_yMin, and m_yMax.
Protected Attributes
vector< double >	m_spec
vector< double >	m_screenSpec
	either world or pixel coords

---

Detailed Description

Subclass of RegionShape used for drawing ellipses.

An ellipse has the following properties in addition to those listed for RegionShape:

• x and y coordinate
• x-radius and y-radius
• angle of rotation

Definition at line 43 of file RegionShapes.h.

---

Constructor & Destructor Documentation

casa::RSEllipse::RSEllipse	(	double	x,
		double	y,
		double	xRadius,
		double	yRadius,
		MDirection::Types	worldSystem,
		double	angle = 0
	)

World Constructor.

x, y, xRadius, yRadius, and angle must all be 1) using the same world system as defined by worldSystem, and 2) in unit RegionShape::UNIT. Angle is counterclockwise, and angle 0 is the east vector.

casa::RSEllipse::RSEllipse	(	double	x,
		double	y,
		double	xRadius,
		double	yRadius,
		double	angle = 0
	)

Pixel Constructor.

Angle in counterclockwise degrees.

casa::RSEllipse::RSEllipse

(

const RecordInterface &

properties

)

Record Constructor.

virtual casa::RSEllipse::~RSEllipse

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual vector<String> casa::RSEllipse::coordParameterNames

(

)

const [virtual]

Implements RegionShape::coordParameterNames.

Implements casa::RegionShape.

Reimplemented in casa::RSCircle.

virtual vector<CoordinateParameterType> casa::RSEllipse::coordParameterTypes

(

)

const [virtual]

Implements RegionShape::coordParameterPositions.

Implements casa::RegionShape.

Reimplemented in casa::RSCircle.

virtual vector<double> casa::RSEllipse::coordParameterValues

(

)

const [virtual]

Implements RegionShape::coordParameterValues.

Implements casa::RegionShape.

Reimplemented in casa::RSCircle.

virtual vector<double> casa::RSEllipse::coordParameterValues

(

String

toSystem

)

const [virtual]

Implements RegionShape::coordParameterValues.

Implements casa::RegionShape.

Reimplemented in casa::RSCircle.

virtual bool casa::RSEllipse::drawAndUpdateBoundingBox	(	WorldCanvasHolder &	wch,
		String *	error = NULL
	)		[virtual]

Implements RegionShape::drawAndUpdateBoundingBox.

Implements casa::RegionShape.

void casa::RSEllipse::getEllipseCoordinates	(	double &	x,
		double &	y,
		double &	xRadius,
		double &	yRadius,
		double &	angle,
		String	toSystem = ""
	)		const

Gets ellipse-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).

virtual RSHandle casa::RSEllipse::getHandle

(

)

const [virtual]

Implements RegionShape::getHandle.

Implements casa::RegionShape.

virtual void casa::RSEllipse::getShapeSpecificProperties

(

Record &

properties

)

const [inline, protected, virtual]

Implements RegionShape::getShapeSpecificProperties.

Implements casa::RegionShape.

Reimplemented in casa::RSCircle.

Definition at line 118 of file RegionShapes.h.

References casa::RecordInterface::define(), casa::RegionShape::PROPTYPE, and casa::RegionShape::PROPTYPE_ELLIPSE.

virtual void casa::RSEllipse::move	(	double	dx,
		double	dy,
		String	system = ""
	)		[virtual]

Implements RegionShape::move.

Implements casa::RegionShape.

virtual vector<String> casa::RSEllipse::optionNames

(

)

const [inline, virtual]

Implements RegionShape option methods.

Note: ellipses do not have additonal options.

Implements casa::RegionShape.

Definition at line 104 of file RegionShapes.h.

virtual vector<OptionType> casa::RSEllipse::optionTypes

(

)

const [inline, virtual]

Returns the types for options.

Implements casa::RegionShape.

Definition at line 105 of file RegionShapes.h.

virtual vector<RSOption> casa::RSEllipse::optionValues

(

)

const [inline, virtual]

Returns the current values for options.

Implements casa::RegionShape.

Definition at line 107 of file RegionShapes.h.

virtual void casa::RSEllipse::setCoordParameters

(

const vector< double > &

vals

)

[virtual]

Implements RegionShape::setCoordParameters.

Implements casa::RegionShape.

Reimplemented in casa::RSCircle.

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

Implements RegionShape::setCoordParameters.

Implements casa::RegionShape.

Reimplemented in casa::RSCircle.

virtual void casa::RSEllipse::setOptionValues

(

const vector< RSOption > &

options

)

[inline, virtual]

Sets the options to the given.

Implements casa::RegionShape.

Definition at line 108 of file RegionShapes.h.

virtual void casa::RSEllipse::setShapeSpecificProperties

(

const RecordInterface &

)

[inline, protected, virtual]

Implements RegionShape::setShapeSpecificProperties.

Implements casa::RegionShape.

Definition at line 123 of file RegionShapes.h.

virtual String casa::RSEllipse::type

(

)

const [inline, virtual]

Implements RegionShape::type.

Implements casa::RegionShape.

Reimplemented in casa::RSCircle.

Definition at line 67 of file RegionShapes.h.

virtual void casa::RSEllipse::updateMinMax

(

)

[protected, virtual]

Update m_xMin, m_xMax, m_yMin, and m_yMax.

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

Updates screen coords using world/pixel coords and the given WorldCanvas.

Reimplemented in casa::RSCircle.

---

Member Data Documentation

vector<double> casa::RSEllipse::m_screenSpec [protected]

either world or pixel coords

Definition at line 114 of file RegionShapes.h.

vector<double> casa::RSEllipse::m_spec [protected]

Definition at line 112 of file RegionShapes.h.

---

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

• code/display/RegionShapes/RegionShapes.h