PointSet Class Reference

A set of points. More...

#include <PointSet.h>

Inheritance diagram for PointSet:

Inheritance graph

List of all members.

Public Member Functions

virtual Point * addPoint ()=0
virtual Point * addPoint (double dX, double dY)=0
virtual bool insertPoint (Point *pPoint)=0
virtual void setPoints (const std::vector< Point * > &points)=0
virtual std::vector< Point * > getPoints () const =0
virtual unsigned int getNumPoints () const =0
virtual bool hasPoint (Point *pPoint) const =0
virtual bool removePoint (Point *pPoint, bool bDelete)=0
virtual void clear (bool bDelete)=0
virtual bool areSymbolsDisplayed () const =0
virtual void displaySymbols (bool bDisplay)=0
virtual bool isLineDisplayed () const =0
virtual ColorType getLineColor () const =0
virtual int getLineWidth () const =0
virtual LineStyle getLineStyle () const =0
virtual void displayLine (bool bDisplay)=0
virtual Point * hitPoint (LocationType point) const =0
virtual bool hit (LocationType point) const =0
virtual bool getExtents (double &dMinX, double &dMinY, double &dMaxX, double &dMaxY)=0
virtual void setLineColor (const ColorType &clrLine)=0
virtual void setLineWidth (int iWidth)=0
virtual void setLineStyle (const LineStyle &eStyle)=0
virtual void setInteractive (bool interactive)=0
virtual bool getInteractive ()=0

Static Public Member Functions

static const std::string & signalPointAdded ()
static const std::string & signalPointsSet ()

Protected Member Functions

virtual ~PointSet ()

Detailed Description

A set of points.

This subclass of Subject will notify upon the following conditions:

See also:
PlotObject

Definition at line 32 of file PointSet.h.

Constructor & Destructor Documentation

virtual PointSet::~PointSet (  )  [protected, virtual]

This should be destroyed by calling PlotView::deleteObject.

Definition at line 264 of file PointSet.h.

Member Function Documentation

static const std::string& PointSet::signalPointAdded (  )  [static]

Emitted with any<Point*> when a point is added to the PointSet.

Definition at line 38 of file PointSet.h.

static const std::string& PointSet::signalPointsSet (  )  [static]

Emitted with any<vector<Point*> > when the PointSet's points are replaced.

Definition at line 42 of file PointSet.h.

virtual Point* PointSet::addPoint (  )  [pure virtual]

Creates an empty Point plot object and adds it to the pointset.

Returns:
The newly created Point
Subject Notifications:
This method will notify signalPointAdded with any<Point*>.

virtual Point* PointSet::addPoint ( double  dX,
double  dY 
) [pure virtual]

Creates a Point plot object and adds it to the pointset.

Parameters:
dX The points x value
dY The points y value
Returns:
The newly created point
Subject Notifications:
This method will notify signalPointAdded with any<Point*>.

virtual bool PointSet::insertPoint ( Point *  pPoint  )  [pure virtual]

Inserts an existing Point plot object into the pointset.

Parameters:
pPoint The point to insert
Returns:
True if successfully inserted, false otherwise
Subject Notifications:
This method will notify signalPointAdded with any<Point*>.

virtual void PointSet::setPoints ( const std::vector< Point * > &  points  )  [pure virtual]

Inserts a vector of existing Point plot objects into the pointset, replacing any existing points.

The existing points are removed but not destroyed.

Parameters:
points The new list of points
Subject Notifications:
This method will notify signalPointsSet with any<vector<Point*> >.

virtual std::vector<Point*> PointSet::getPoints (  )  const [pure virtual]

Returns the list of points in the pointset.

Returns:
The list of points

virtual unsigned int PointSet::getNumPoints (  )  const [pure virtual]

Returns the number of points in the pointset.

Returns:
The number of points in the pointset

virtual bool PointSet::hasPoint ( Point *  pPoint  )  const [pure virtual]

Checks the pointsets list of points for the point object.

Parameters:
pPoint The point to look for
Returns:
True if the pointset contains this point, false otherwise.

virtual bool PointSet::removePoint ( Point *  pPoint,
bool  bDelete 
) [pure virtual]

Removes the point from the pointset.

Parameters:
pPoint The point to remove
bDelete True - deletes the point upon removal, False - just removes the point
Returns:
True if the point was removed, false otherwise
Subject Notifications:
This method will notify Subject::signalModified.

virtual void PointSet::clear ( bool  bDelete  )  [pure virtual]

Clears the list of points from the pointset.

Parameters:
bDelete True - deletes the points upon removal, False - just removes the points
Subject Notifications:
This method will notify signalPointsSet with any<vector<Point*> > with the vector empty.

virtual bool PointSet::areSymbolsDisplayed (  )  const [pure virtual]

Checks to see if the symbols are displayed.

Returns:
True if the symbols are displayed, false otherwise

virtual void PointSet::displaySymbols ( bool  bDisplay  )  [pure virtual]

Sets the symbol display attribute.

Parameters:
bDisplay True displays the symbols, false turns the display off

virtual bool PointSet::isLineDisplayed (  )  const [pure virtual]

Returns the state of the line display property.

Returns:
True if lines are displayed, false if they are not

virtual ColorType PointSet::getLineColor (  )  const [pure virtual]

Returns the line color.

Returns:
The line color

virtual int PointSet::getLineWidth (  )  const [pure virtual]

Returns the line width.

Returns:
The line width

virtual LineStyle PointSet::getLineStyle (  )  const [pure virtual]

Returns the line style.

Returns:
The line style
See also:
LineStyle

virtual void PointSet::displayLine ( bool  bDisplay  )  [pure virtual]

Sets the line display property.

Parameters:
bDisplay True - display lines, False - do not display lines

virtual Point* PointSet::hitPoint ( 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:
The Point object if the plot object is at this point

virtual bool PointSet::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

Implemented in PolygonPlotObject.

virtual bool PointSet::getExtents ( double &  dMinX,
double &  dMinY,
double &  dMaxX,
double &  dMaxY 
) [pure virtual]

Returns the extents of the pointset.

(Its bounds)

Parameters:
dMinX The minimum x value
dMinY The minimum y value
dMaxX The maximum x value
dMaxY The maximum y value
Returns:

Implements PlotObject.

virtual void PointSet::setLineColor ( const ColorType &  clrLine  )  [pure virtual]

Sets the line color.

Parameters:
clrLine The new line color
Subject Notifications:
This method will notify Subject::signalModified.

virtual void PointSet::setLineWidth ( int  iWidth  )  [pure virtual]

Sets the line width.

Parameters:
iWidth The new line width
Subject Notifications:
This method will notify Subject::signalModified.

virtual void PointSet::setLineStyle ( const LineStyle &  eStyle  )  [pure virtual]

Sets the line style.

Parameters:
eStyle The new line style
See also:
LineStyle
Subject Notifications:
This method will notify Subject::signalModified.

virtual void PointSet::setInteractive ( bool  interactive  )  [pure virtual]

Set the current interactivity state.

Setting this to false will cause the PointSet to delay processing until set to interactive again. This is useful when making a large number of changes to the PointSet.

Parameters:
interactive The new interactive state.
See also:
setInteractive

virtual bool PointSet::getInteractive (  )  [pure virtual]

Get the current interactivity state.

Returns:
The current interactivity state.
See also:
getInteractive

Software Development Kit - Opticks 4.9.0 Build 16218