Arrow Class Reference
A set of points connected by a line forming an arrow. More...
#include <Arrow.h>
Inheritance diagram for Arrow:
Public Member Functions | |
| virtual ArrowStyle | getArrowStyle () const =0 |
| virtual LocationType | getBaseLocation () const =0 |
| virtual LocationType | getTipLocation () const =0 |
| virtual ColorType | getColor () const =0 |
| virtual bool | hit (LocationType point) const =0 |
| virtual void | setArrowStyle (const ArrowStyle &eStyle)=0 |
| virtual void | setLocation (const LocationType &baseLocation, const LocationType &tipLocation)=0 |
| virtual void | setBaseLocation (const LocationType &baseLocation)=0 |
| virtual void | setTipLocation (const LocationType &tipLocation)=0 |
| virtual void | setColor (const ColorType &newColor)=0 |
Protected Member Functions | |
| virtual | ~Arrow () |
Detailed Description
A set of points connected by a line forming an arrow.This subclass of Subject will notify upon the following conditions:
- The following methods are called: setArrowStyle(), setBaseLocation(), setTipLocation(), setLocation().
- Everything else documented in PlotObject.
- See also:
- PlotObject
Definition at line 30 of file Arrow.h.
Constructor & Destructor Documentation
| virtual Arrow::~Arrow | ( | ) | [protected, virtual] |
Member Function Documentation
| virtual ArrowStyle Arrow::getArrowStyle | ( | ) | const [pure virtual] |
Returns the arrow style.
- Returns:
- Returns the arrow style as an enumerated type
| virtual LocationType Arrow::getBaseLocation | ( | ) | const [pure virtual] |
Returns the location of the beginning of the arrow.
- Returns:
- LocationType
| virtual LocationType Arrow::getTipLocation | ( | ) | const [pure virtual] |
Returns the location of the end of the arrow.
- Returns:
- LocationType
| virtual ColorType Arrow::getColor | ( | ) | const [pure virtual] |
Returns the color of the arrow.
- Returns:
- A color object
| virtual bool Arrow::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 Arrow::setArrowStyle | ( | const ArrowStyle & | eStyle | ) | [pure virtual] |
Sets the objects arrow style.
- Parameters:
-
eStyle The arrow style
- Subject Notifications:
- This method will notify Subject::signalModified.
| virtual void Arrow::setLocation | ( | const LocationType & | baseLocation, | |
| const LocationType & | tipLocation | |||
| ) | [pure virtual] |
Sets the location of the arrow, both beginning and ending.
- Parameters:
-
baseLocation The beginning point tipLocation The ending point
- Subject Notifications:
- This method will notify Subject::signalModified.
| virtual void Arrow::setBaseLocation | ( | const LocationType & | baseLocation | ) | [pure virtual] |
Sets the beginning location of the arrow.
- Parameters:
-
baseLocation
- Subject Notifications:
- This method will notify Subject::signalModified.
| virtual void Arrow::setTipLocation | ( | const LocationType & | tipLocation | ) | [pure virtual] |
Sets the ending location of the arrow.
- Parameters:
-
tipLocation
- Subject Notifications:
- This method will notify Subject::signalModified.
| virtual void Arrow::setColor | ( | const ColorType & | newColor | ) | [pure virtual] |
Sets the color of the arrow.
- Parameters:
-
newColor