Curve Class Reference
A set of points connected by a line. More...
#include <Curve.h>
Inheritance diagram for Curve:
Public Member Functions | |
| virtual bool | setPoints (const std::vector< LocationType > &points)=0 |
| virtual const std::vector < LocationType > & | getPoints () const =0 |
| virtual void | setColor (const ColorType &curveColor)=0 |
| virtual ColorType | getColor () const =0 |
| virtual void | setLineWidth (int iWidth)=0 |
| virtual int | getLineWidth () const =0 |
| virtual void | setLineStyle (const LineStyle &lineStyle)=0 |
| virtual LineStyle | getLineStyle () const =0 |
Static Public Member Functions | |
| static const std::string & | signalPointsChanged () |
Protected Member Functions | |
| virtual | ~Curve () |
Detailed Description
A set of points connected by a line.This subclass of Subject will notify upon the following conditions:
- The following methods are called: setPoints(), setColor(), setLineWidth(), setLineStyle().
- Everything else documented in PlotObject.
- See also:
- PlotObject
Definition at line 32 of file Curve.h.
Constructor & Destructor Documentation
| virtual Curve::~Curve | ( | ) | [protected, virtual] |
Member Function Documentation
| static const std::string& Curve::signalPointsChanged | ( | ) | [static] |
| virtual bool Curve::setPoints | ( | const std::vector< LocationType > & | points | ) | [pure virtual] |
Sets the location of each point in the curve.
- Parameters:
-
points The points for the curve. Any existing points are removed, and the connecting line connects the points in the order in which they are contained in the vector.
- Returns:
- TRUE if the curve points were successfully set, otherwise FALSE.
- Subject Notifications:
- signalPointsChanged with any<vector<LocationType> >
| virtual const std::vector<LocationType>& Curve::getPoints | ( | ) | const [pure virtual] |
Returns the curve point locations.
- Returns:
- The points for the curve. The order of the points in the vector indicate how the connecting line is drawn.
| virtual void Curve::setColor | ( | const ColorType & | curveColor | ) | [pure virtual] |
Sets the curve color.
- Parameters:
-
curveColor The new curve color. Must be a valid color.
- See also:
- ColorType::isValid()
- Subject Notifications:
- Subject::signalModified
| virtual ColorType Curve::getColor | ( | ) | const [pure virtual] |
Returns the curve color.
- Returns:
- The current curve color.
| virtual void Curve::setLineWidth | ( | int | iWidth | ) | [pure virtual] |
Sets the curve line width.
- Parameters:
-
iWidth The new curve line width. Cannot be zero.
- Subject Notifications:
- Subject::signalModified
| virtual int Curve::getLineWidth | ( | ) | const [pure virtual] |
Returns the curve line width.
- Returns:
- The current curve line width.
| virtual void Curve::setLineStyle | ( | const LineStyle & | lineStyle | ) | [pure virtual] |
Sets the curve line style.
- Parameters:
-
lineStyle The new curve line style.
- Subject Notifications:
- Subject::signalModified
- See also:
- LineStyle
| virtual LineStyle Curve::getLineStyle | ( | ) | const [pure virtual] |
Returns the curve line style.
- Returns:
- The current curve line style.