Point Class Reference

A Point. More...

#include <Point.h>

Inheritance diagram for Point:

List of all members.

Public Types
enum	PointSymbolTypeEnum {   SOLID, X, CROSS_HAIR, ASTERISK,   HORIZONTAL_LINE, VERTICAL_LINE, FORWARD_SLASH, BACK_SLASH,   BOX, BOXED_X, BOXED_CROSS_HAIR, BOXED_ASTERISK,   BOXED_HORIZONTAL_LINE, BOXED_VERTICAL_LINE, BOXED_FORWARD_SLASH, BOXED_BACK_SLASH,   DIAMOND, DIAMOND_FILLED, DIAMOND_CROSS_HAIR, TRIANGLE,   TRIANGLE_FILLED, RIGHT_TRIANGLE, RIGHT_TRIANGLE_FILLED, LEFT_TRIANGLE,   LEFT_TRIANGLE_FILLED, DOWN_TRIANGLE, DOWN_TRIANGLE_FILLED, CIRCLE,   CIRCLE_FILLED, OCTAGON, OCTAGON_FILLED, OCTAGON_CROSS_HAIR }
typedef EnumWrapper < PointSymbolTypeEnum >	PointSymbolType
Public Member Functions
virtual double	getXLocation () const =0
virtual double	getYLocation () const =0
virtual const LocationType &	getLocation () const =0
virtual PointSymbolType	getSymbol () const =0
virtual int	getSymbolSize () const =0
virtual ColorType	getColor () const =0
virtual const PointSet *	getPointSet () const =0
virtual PointSet *	getPointSet ()=0
virtual bool	hit (LocationType point) const =0
virtual void	setLocation (const LocationType &location)=0
virtual void	setLocation (double dX, double dY)=0
virtual void	setSymbol (const PointSymbolType &eSymbol)=0
virtual void	setSymbolSize (int iSize)=0
virtual void	setColor (const ColorType &clrSymbol)=0
virtual void	setPointSet (PointSet *pPointSet)=0
Static Public Member Functions
static const std::string &	signalLocationChanged ()
static const std::string &	signalSymbolChanged ()
static const std::string &	signalSymbolSizeChanged ()
static const std::string &	signalColorChanged ()
Protected Member Functions
virtual	~Point ()

---

Detailed Description

A Point.

This subclass of Subject will notify upon the following conditions:

• The following methods are called: setLocation(), setSymbol(), setSymbolSize(), setColor().
• Everything else documented in PlotObject.

See also:

PlotObject

Definition at line 33 of file Point.h.

---

Member Typedef Documentation

typedef EnumWrapper<PointSymbolTypeEnum> Point::PointSymbolType

The EnumWrapper contains a given enum value and provides a isValid() method which returns true if the contained enum value is valid.

Please see How To Use EnumWrapper for more information. The wrapped enum values are Point::PointSymbolTypeEnum.

Definition at line 83 of file Point.h.

---

Member Enumeration Documentation

enum Point::PointSymbolTypeEnum

Pixel marker symbol for Point PlotObjects.

Selected pixels are displayed on the scene in various symbols so that the user can identify multiple selections on a single pixel.

Enumerator:

SOLID	Filled box.
X	X.
CROSS_HAIR	Crosshair.
ASTERISK	Asterick.
HORIZONTAL_LINE	Horizontal line.
VERTICAL_LINE	Vertical line.
FORWARD_SLASH	Forward slash.
BACK_SLASH	Back slash.
BOX	Box.
BOXED_X	Box with X.
BOXED_CROSS_HAIR	Box with crosshair.
BOXED_ASTERISK	Box with asterick.
BOXED_HORIZONTAL_LINE	Box with horizontal line.
BOXED_VERTICAL_LINE	Box with vertical line.
BOXED_FORWARD_SLASH	Box with forward slash.
BOXED_BACK_SLASH	Box with back slash.
DIAMOND	Diamond.
DIAMOND_FILLED	Filled Diamond.
DIAMOND_CROSS_HAIR	Diamond with crosshair.
TRIANGLE	Triangle.
TRIANGLE_FILLED	Filled Triangle.
RIGHT_TRIANGLE	Right Triangle.
RIGHT_TRIANGLE_FILLED	Filled Right Triangle.
LEFT_TRIANGLE	Left Triangle.
LEFT_TRIANGLE_FILLED	Filled Left Triangle.
DOWN_TRIANGLE	Down Triangle.
DOWN_TRIANGLE_FILLED	Filled Down Triangle.
CIRCLE	Circle.
CIRCLE_FILLED	Filled Circle.
OCTAGON	Octagon.
OCTAGON_FILLED	Filled Octagon.
OCTAGON_CROSS_HAIR	Octagon with crosshair.

Definition at line 45 of file Point.h.

---

Constructor & Destructor Documentation

virtual Point::~Point

(

)

[protected, virtual]

This should be destroyed by calling PlotView::deleteObject.

Definition at line 231 of file Point.h.

---

Member Function Documentation

static const std::string& Point::signalLocationChanged

(

)

[static]

Emitted with boost::any<LocationType> when the point's location changes.

Definition at line 88 of file Point.h.

static const std::string& Point::signalSymbolChanged

(

)

[static]

Emitted with boost::any<PointSymbolType> when a point's symbol changes.

Definition at line 92 of file Point.h.

static const std::string& Point::signalSymbolSizeChanged

(

)

[static]

Emitted with boost::any<int> when a point's symbol size changes.

Definition at line 96 of file Point.h.

static const std::string& Point::signalColorChanged

(

)

[static]

Emitted with boost::any<ColorType> when a point's color changes.

Definition at line 100 of file Point.h.

virtual double Point::getXLocation

(

)

const [pure virtual]

Returns the x value.

Returns:

A double representation of the x value

virtual double Point::getYLocation

(

)

const [pure virtual]

Returns the y value.

Returns:

A double representation of the y value

virtual const LocationType& Point::getLocation

(

)

const [pure virtual]

Returns the location of the point, both x and y in a LocationType structure.

Returns:

The LocationType structure

See also:

LocationType

virtual PointSymbolType Point::getSymbol

(

)

const [pure virtual]

Returns the point symbol.

Returns:

The symbol type

See also:

PointSymbolType

virtual int Point::getSymbolSize

(

)

const [pure virtual]

Returns the size of the symbol.

Returns:

The symbol size

virtual ColorType Point::getColor

(

)

const [pure virtual]

Returns the color of the point.

Returns:

The point color

virtual const PointSet* Point::getPointSet

(

)

const [pure virtual]

Returns the PointSet that contains the point.

Returns:

The PointSet. Will return NULL if the Point is not in a PointSet.

virtual PointSet* Point::getPointSet

(

)

[pure virtual]

Returns the PointSet that contains the point.

Returns:

The PointSet. Will return NULL if the Point is not in a PointSet.

virtual bool Point::hit

(

LocationType

point

)

const [pure virtual]

Determines if this plot object resides at this point, most likely a mouse click.

Parameters:

point

The location of the mouse click

Returns:

True if the plot object is at this point

virtual void Point::setLocation

(

const LocationType &

location

)

[pure virtual]

Sets the location of the point.

Parameters:

location

The new location

See also:

LocationType

Subject Notifications:

This method will notify signalLocationChanged with any<LocationType>.

virtual void Point::setLocation	(	double	dX,
		double	dY
	)			[pure virtual]

Sets the location of the point.

Parameters:

	dX	The x value
	dY	The y value

Subject Notifications:

This method will notify signalLocationChanged with any<LocationType>.

virtual void Point::setSymbol

(

const PointSymbolType &

eSymbol

)

[pure virtual]

Sets the point symbol.

Parameters:

eSymbol

The new symbol

See also:

PointSymbolType

Subject Notifications:

This method will notify signalSymbolChanged() with boost::any<PointSymbolType>.

virtual void Point::setSymbolSize

(

int

iSize

)

[pure virtual]

Sets the point symbol size.

Parameters:

iSize

The new symbol size

Subject Notifications:

This method will notify signalSymbolSizeChanged with any<int>.

virtual void Point::setColor

(

const ColorType &

clrSymbol

)

[pure virtual]

Sets the point symbol color.

Parameters:

clrSymbol

The new color

Subject Notifications:

This method will notify signalColorChanged with any<ColorType>.

virtual void Point::setPointSet

(

PointSet *

pPointSet

)

[pure virtual]

Sets the PointSet of the Point.

Parameters:

pPointSet

The PointSet. Pass NULL to remove the Point from current PointSet.