Abstract class for a symbol. More...

#include <PlotOptions.h>

Public Types
enum	Symbol { CHARACTER, CIRCLE, SQUARE, DIAMOND, PIXEL, NOSYMBOL, AUTOSCALING }
	Static //. More...

Public Member Functions
	PlotSymbol ()
	Non-Static //. More...

virtual	~PlotSymbol ()
	PlotSymbol(const PlotSymbol& copy);. More...

virtual psize_t	size () const =0
	ABSTRACT METHODS //. More...

virtual void	setSize (double width, double height, bool heightIsPixel=true)=0
	Sets the size of the symbol in pixels. More...

virtual bool	heightIsPixel () const =0
	Gets/Sets whether the set height is in pixels or points, ONLY for character symbols. More...

virtual void	setHeightIsPixel (bool pixel=true)=0

virtual Symbol	symbol () const =0
	Returns the symbol style. More...

virtual char	symbolChar () const =0
	Returns the character for this symbol. More...

virtual unsigned short	symbolUChar () const =0
	Returns the character unicode for this symbol. More...

virtual void	setSymbol (Symbol symbol)=0
	Sets the symbol style to the given. More...

virtual void	setSymbol (const casacore::String &descriptor)

virtual void	setSymbol (char c)=0
	Sets the symbol character to the given. More...

virtual void	setUSymbol (unsigned short unicode)=0
	Sets the symbol character unicode to the given. More...

virtual PlotLinePtr	line () const =0
	Returns a copy of the line for the outline of this symbol. More...

virtual void	setLine (const PlotLine &color)=0
	Sets the outline of this symbol to the given. More...

virtual PlotAreaFillPtr	areaFill () const =0
	Returns a copy of the area fill for this symbol. More...

virtual void	setAreaFill (const PlotAreaFill &fill)=0
	Sets the area fill of this symbol to the given. More...

virtual void	setSize (psize_t size)
	CONVENIENCE METHODS //. More...

virtual bool	isCharacter () const
	Returns true if this symbol is set to a character or not. More...

virtual void	setLine (const PlotLinePtr l)
	Convenience methods for setting the line. More...

virtual void	setLine (const casacore::String &color, PlotLine::Style style=PlotLine::SOLID, double width=1.0)

virtual void	setAreaFill (const PlotAreaFillPtr a)
	Convenience methods for setting area fill. More...

virtual void	setAreaFill (const casacore::String &color, PlotAreaFill::Pattern pattern=PlotAreaFill::FILL)

virtual void	setColor (const PlotColor &color)
	Convenience method for setting color of both line and area fill. More...

virtual void	setColor (const PlotColorPtr color)

virtual void	setColor (const casacore::String &color)

casacore::String	getColor () const

virtual casacore::Record	toRecord () const
	RECORD METHODS //. More...

virtual void	fromRecord (const casacore::Record &record)

virtual PlotSymbol &	operator= (const PlotSymbol &rh)
	OPERATORS //. More...

virtual bool	operator== (const PlotSymbol &rh) const
	Returns true if this PlotSymbol is equal to the given; false otherwise. More...

virtual bool	operator!= (const PlotSymbol &rh) const
	Returns true if this PlotSymbol is NOT equal to the given; false otherwise. More...

Static Protected Attributes
static const casacore::String	REC_WIDTH
	casacore::Record key names. More...

static const casacore::String	REC_HEIGHT

static const casacore::String	REC_HEIGHTISPIXEL

static const casacore::String	REC_SYMBOL

static const casacore::String	REC_UCHAR

static const casacore::String	REC_LINE

static const casacore::String	REC_AREAFILL

static const casacore::String	REC_COLOR

Private Attributes
const casacore::String	DEFAULT_COLOR

casacore::String	currentColor

Detailed Description

Abstract class for a symbol.

A symbol has a style, size, line, and area fill.

Definition at line 451 of file PlotOptions.h.

Member Enumeration Documentation

enum casa::PlotSymbol::Symbol

Static //.

Symbol style.

Enumerator
CHARACTER
CIRCLE
SQUARE
DIAMOND
PIXEL
NOSYMBOL
AUTOSCALING

Definition at line 456 of file PlotOptions.h.

Constructor & Destructor Documentation

casa::PlotSymbol::PlotSymbol ( )

Non-Static //.

Constructor.

virtual casa::PlotSymbol::~PlotSymbol ( )

virtual

PlotSymbol(const PlotSymbol& copy);.

Destructor.

Member Function Documentation

virtual PlotAreaFillPtr casa::PlotSymbol::areaFill ( ) const

pure virtual

Returns a copy of the area fill for this symbol.

Does not apply to character or pixel symbols.

virtual void casa::PlotSymbol::fromRecord ( const casacore::Record & record )

virtual

casacore::String casa::PlotSymbol::getColor ( ) const

virtual bool casa::PlotSymbol::heightIsPixel ( ) const

pure virtual

Gets/Sets whether the set height is in pixels or points, ONLY for character symbols.

virtual bool casa::PlotSymbol::isCharacter ( ) const

virtual

Returns true if this symbol is set to a character or not.

virtual PlotLinePtr casa::PlotSymbol::line ( ) const

pure virtual

Returns a copy of the line for the outline of this symbol.

Does not apply to character or pixel symbols.

virtual bool casa::PlotSymbol::operator!= ( const PlotSymbol & rh ) const

virtual

Returns true if this PlotSymbol is NOT equal to the given; false otherwise.

virtual PlotSymbol& casa::PlotSymbol::operator= ( const PlotSymbol & rh )

virtual

OPERATORS //.

Assigns the value of the given PlotSymbol to this one.

virtual bool casa::PlotSymbol::operator== ( const PlotSymbol & rh ) const

virtual

Returns true if this PlotSymbol is equal to the given; false otherwise.

virtual void casa::PlotSymbol::setAreaFill ( const PlotAreaFill & fill )

pure virtual

Sets the area fill of this symbol to the given.

Does not apply to character or pixel symbols.

virtual void casa::PlotSymbol::setAreaFill ( const PlotAreaFillPtr a )

virtual

Convenience methods for setting area fill.

virtual void casa::PlotSymbol::setAreaFill	(	const casacore::String &	color,
		PlotAreaFill::Pattern	pattern = `PlotAreaFill::FILL`
	)

virtual

virtual void casa::PlotSymbol::setColor ( const PlotColor & color )

virtual

Convenience method for setting color of both line and area fill.

virtual void casa::PlotSymbol::setColor ( const PlotColorPtr color )

virtual

virtual void casa::PlotSymbol::setColor ( const casacore::String & color )

virtual

virtual void casa::PlotSymbol::setHeightIsPixel ( bool pixel = true )

pure virtual

virtual void casa::PlotSymbol::setLine ( const PlotLine & color )

pure virtual

Sets the outline of this symbol to the given.

Does not apply to character or pixel symbols.

virtual void casa::PlotSymbol::setLine ( const PlotLinePtr l )

virtual

Convenience methods for setting the line.

virtual void casa::PlotSymbol::setLine	(	const casacore::String &	color,
		PlotLine::Style	style = `PlotLine::SOLID`,
		double	width = `1.0`
	)

virtual

virtual void casa::PlotSymbol::setSize	(	double	width,
		double	height,
		bool	heightIsPixel = `true`
	)

pure virtual

Sets the size of the symbol in pixels.

The heightIsPixel parameter is used for character symbols and indicates whether the given height is in points or pixels.

virtual void casa::PlotSymbol::setSize ( psize_t size )

virtual

CONVENIENCE METHODS //.

Convenience method for setting size.

virtual void casa::PlotSymbol::setSymbol ( Symbol symbol )

pure virtual

Sets the symbol style to the given.

virtual void casa::PlotSymbol::setSymbol ( const casacore::String & descriptor )

virtual

virtual void casa::PlotSymbol::setSymbol ( char c )

pure virtual

Sets the symbol character to the given.

Implies setSymbol(CHARACTER).

virtual void casa::PlotSymbol::setUSymbol ( unsigned short unicode )

pure virtual

Sets the symbol character unicode to the given.

Implies setSymbol(CHARACTER).

virtual psize_t casa::PlotSymbol::size ( ) const

pure virtual

ABSTRACT METHODS //.

Returns the size, in pixels, of this symbol. If this symbol is a character, the height corresponds to the font size (in either pixels or points, see heightIsPixel()).

virtual Symbol casa::PlotSymbol::symbol ( ) const

pure virtual

Returns the symbol style.

virtual char casa::PlotSymbol::symbolChar ( ) const

pure virtual

Returns the character for this symbol.

Invalid if the style is not CHARACTER.

virtual unsigned short casa::PlotSymbol::symbolUChar ( ) const

pure virtual

Returns the character unicode for this symbol.

Invalid if the style is not CHARACTER.

virtual casacore::Record casa::PlotSymbol::toRecord ( ) const

virtual

RECORD METHODS //.

Gets/Sets the color as a Record.

Member Data Documentation

casacore::String casa::PlotSymbol::currentColor

private

Definition at line 602 of file PlotOptions.h.

const casacore::String casa::PlotSymbol::DEFAULT_COLOR

private

Definition at line 601 of file PlotOptions.h.

const casacore::String casa::PlotSymbol::REC_AREAFILL

staticprotected

Definition at line 596 of file PlotOptions.h.

const casacore::String casa::PlotSymbol::REC_COLOR

staticprotected

Definition at line 597 of file PlotOptions.h.

const casacore::String casa::PlotSymbol::REC_HEIGHT

staticprotected

Definition at line 591 of file PlotOptions.h.

const casacore::String casa::PlotSymbol::REC_HEIGHTISPIXEL

staticprotected

Definition at line 592 of file PlotOptions.h.

const casacore::String casa::PlotSymbol::REC_LINE

staticprotected

Definition at line 595 of file PlotOptions.h.

const casacore::String casa::PlotSymbol::REC_SYMBOL

staticprotected

Definition at line 593 of file PlotOptions.h.

const casacore::String casa::PlotSymbol::REC_UCHAR

staticprotected

Definition at line 594 of file PlotOptions.h.

const casacore::String casa::PlotSymbol::REC_WIDTH

staticprotected

casacore::Record key names.

Definition at line 590 of file PlotOptions.h.

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

casa/code/graphics/GenericPlotter/PlotOptions.h

Public Types

Public Member Functions

Static Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation