casa::PlotShape Class Reference

Abstract class for any shape which contains common functionality. More...

#include <PlotShape.h>

Inheritance diagram for casa::PlotShape:

List of all members.

Public Member Functions
	PlotShape ()
	Constructor.
virtual	~PlotShape ()
	Destructor.
virtual unsigned int	drawCount () const
	Implements PlotItem::drawCount().
virtual std::vector < PlotCoordinate >	coordinates () const =0
	ABSTRACT METHODS //.
virtual void	setCoordinates (const std::vector< PlotCoordinate > &c)=0
	Sets this shape's coordinates to the given.
virtual bool	lineShown () const =0
	Returns true if a line is shown for this shape, false otherwise.
virtual void	setLineShown (bool line=true)=0
	Sets whether a line is shown for this shape or not.
virtual PlotLinePtr	line () const =0
	Returns a copy of the line used for this shape.
virtual void	setLine (const PlotLine &line)=0
	Sets this shape's line to the given.
virtual bool	areaFilled () const =0
	Returns true if this shape has an area fill, false otherwise.
virtual void	setAreaFilled (bool area=true)=0
	Sets whether or not this shape has an area fill.
virtual PlotAreaFillPtr	areaFill () const =0
	Returns a copy of the area fill for this shape.
virtual void	setAreaFill (const PlotAreaFill &fill)=0
	Sets this shape's area fill to the given.
virtual void	setLine (const PlotLinePtr l)
	IMPLEMENTED METHODS //.
virtual void	setLine (const String &color, PlotLine::Style style=PlotLine::SOLID, double width=1.0)
virtual void	setAreaFill (const PlotAreaFillPtr f)
	Convenience methods for setting the area fill.
virtual void	setAreaFill (const String &color, PlotAreaFill::Pattern pattern=PlotAreaFill::FILL)

---

Detailed Description

Abstract class for any shape which contains common functionality.

Definition at line 37 of file PlotShape.h.

---

Constructor & Destructor Documentation

casa::PlotShape::PlotShape

(

)

[inline]

Constructor.

Definition at line 40 of file PlotShape.h.

virtual casa::PlotShape::~PlotShape

(

)

[inline, virtual]

Destructor.

Definition at line 43 of file PlotShape.h.

---

Member Function Documentation

virtual PlotAreaFillPtr casa::PlotShape::areaFill

(

)

const [pure virtual]

Returns a copy of the area fill for this shape.

Referenced by setAreaFill().

virtual bool casa::PlotShape::areaFilled

(

)

const [pure virtual]

Returns true if this shape has an area fill, false otherwise.

virtual std::vector<PlotCoordinate> casa::PlotShape::coordinates

(

)

const [pure virtual]

ABSTRACT METHODS //.

Returns the coordinates for this shape. The number and order depends on the specific shape subclass.

Referenced by casa::PlotShapePolygon::drawCount(), and casa::PlotShapePath::drawCount().

virtual unsigned int casa::PlotShape::drawCount

(

)

const [inline, virtual]

Implements PlotItem::drawCount().

Provides default implementation that returns 1.

Implements casa::PlotItem.

Reimplemented in casa::PlotShapePolygon, and casa::PlotShapePath.

Definition at line 48 of file PlotShape.h.

virtual PlotLinePtr casa::PlotShape::line

(

)

const [pure virtual]

Returns a copy of the line used for this shape.

Referenced by setLine().

virtual bool casa::PlotShape::lineShown

(

)

const [pure virtual]

Returns true if a line is shown for this shape, false otherwise.

virtual void casa::PlotShape::setAreaFill	(	const String &	color,
		PlotAreaFill::Pattern	pattern = PlotAreaFill::FILL
	)			[inline, virtual]

Definition at line 111 of file PlotShape.h.

References areaFill(), casacore::pattern(), and setAreaFill().

virtual void casa::PlotShape::setAreaFill

(

const PlotAreaFillPtr

f

)

[inline, virtual]

Convenience methods for setting the area fill.

Definition at line 107 of file PlotShape.h.

References setAreaFill(), and setAreaFilled().

virtual void casa::PlotShape::setAreaFill

(

const PlotAreaFill &

fill

)

[pure virtual]

Sets this shape's area fill to the given.

Referenced by setAreaFill().

virtual void casa::PlotShape::setAreaFilled

(

bool

area = true

)

[pure virtual]

Sets whether or not this shape has an area fill.

Referenced by setAreaFill().

virtual void casa::PlotShape::setCoordinates

(

const std::vector< PlotCoordinate > &

c

)

[pure virtual]

Sets this shape's coordinates to the given.

Must be in the same size and order as that returned by coordinates(). Specific to each shape subclass.

virtual void casa::PlotShape::setLine	(	const String &	color,
		PlotLine::Style	style = PlotLine::SOLID,
		double	width = 1.0
	)			[inline, virtual]

Definition at line 95 of file PlotShape.h.

References line(), and setLine().

virtual void casa::PlotShape::setLine

(

const PlotLinePtr

l

)

[inline, virtual]

IMPLEMENTED METHODS //.

Convenience methods for setting the line for this shape.

Definition at line 91 of file PlotShape.h.

References setLine(), and setLineShown().

virtual void casa::PlotShape::setLine

(

const PlotLine &

line

)

[pure virtual]

Sets this shape's line to the given.

Referenced by setLine().

virtual void casa::PlotShape::setLineShown

(

bool

line = true

)

[pure virtual]

Sets whether a line is shown for this shape or not.

Referenced by setLine().

---

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

• code/graphics/GenericPlotter/PlotShape.h