PlotGroup Class Reference
A set of plotobjects. More...
#include <PlotGroup.h>
Public Member Functions | |
| virtual PlotObject * | addObject (const PlotObjectType &eType)=0 |
| virtual void | insertObjects (const std::vector< PlotObject * > &objects)=0 |
| virtual bool | hasObject (PlotObject *pObject) const =0 |
| virtual const std::vector < PlotObject * > & | getObjects () const =0 |
| virtual unsigned int | getNumObjects () const =0 |
| virtual PlotObject * | hitObject (LocationType point) const =0 |
| virtual bool | hit (LocationType point) const =0 |
| virtual void | setVisible (bool bVisible)=0 |
| virtual void | setSelected (bool bSelect)=0 |
| virtual bool | insertObject (PlotObject *pObject)=0 |
| virtual bool | removeObject (PlotObject *pObject, bool bDelete=false)=0 |
| virtual void | clear (bool bDelete=false)=0 |
Static Public Member Functions | |
| static const std::string & | signalObjectAdded () |
Protected Member Functions | |
| virtual | ~PlotGroup () |
Detailed Description
A set of plotobjects.This subclass of Subject will notify upon the following conditions:
- The following methods are called: insertObject(), removeObject(), addObject(), insertObjects().
- Everything else documented in PlotObject.
- See also:
- PlotObject
Definition at line 30 of file PlotGroup.h.
Constructor & Destructor Documentation
| virtual PlotGroup::~PlotGroup | ( | ) | [protected, virtual] |
This should be destroyed by calling PlotView::deleteObject.
Definition at line 146 of file PlotGroup.h.
Member Function Documentation
| static const std::string& PlotGroup::signalObjectAdded | ( | ) | [static] |
Emitted with any<PlotObject*> when an object is added to the group.
Definition at line 36 of file PlotGroup.h.
| virtual PlotObject* PlotGroup::addObject | ( | const PlotObjectType & | eType | ) | [pure virtual] |
Creates a new plot object of type PlotObjectType and adds it to the PlotGroup.
- Parameters:
-
eType The PlotObjectType
- Returns:
- A pointer to the plot object
- Subject Notifications:
- This method will notify signalObjectAdded with any(PlotObject*>.
| virtual void PlotGroup::insertObjects | ( | const std::vector< PlotObject * > & | objects | ) | [pure virtual] |
Inserts a vector of plot objects into the plot group.
- Parameters:
-
objects The vector of plot objects
- Subject Notifications:
- This method will notify signalObjectAdded with any(PlotObject*>.
| virtual bool PlotGroup::hasObject | ( | PlotObject * | pObject | ) | const [pure virtual] |
Checks to see if the provide plot object is in this plot group.
- Parameters:
-
pObject The plot object to look for
- Returns:
- True if the plot object is in this plot group, false otherwise.
| virtual const std::vector<PlotObject*>& PlotGroup::getObjects | ( | ) | const [pure virtual] |
Retrieves a vector of plot objects from the plot group.
- Returns:
- A vector of plot objects
| virtual unsigned int PlotGroup::getNumObjects | ( | ) | const [pure virtual] |
Returns the number of plot objects in the plot group.
- Returns:
- The number of plot objects
| virtual PlotObject* PlotGroup::hitObject | ( | LocationType | point | ) | const [pure virtual] |
Determines if a plot object resides at this point, most likely a mouse click.
- Parameters:
-
point The location of the mouse click
- Returns:
- The object that was hit, NULL otherwise.
| virtual bool PlotGroup::hit | ( | LocationType | point | ) | const [pure virtual] |
Determines if a plot object within this plot group resides at this point, most likely a mouse click.
- Parameters:
-
point The location of the mouse click
- Returns:
- True if a plot object is at this point
| virtual void PlotGroup::setVisible | ( | bool | bVisible | ) | [pure virtual] |
Sets the plot groups visibility.
- Parameters:
-
bVisible True - visible, False - not visible
Implements PlotObject.
| virtual void PlotGroup::setSelected | ( | bool | bSelect | ) | [pure virtual] |
Sets the plot groups selected property.
- Parameters:
-
bSelect True - selected, False - not selected
Implements PlotObject.
| virtual bool PlotGroup::insertObject | ( | PlotObject * | pObject | ) | [pure virtual] |
Inserts an existing plot object into the plot group.
- Parameters:
-
pObject Pointer to a plot object
- Returns:
- True if successfully inserted, false otherwise
- Subject Notifications:
- This method will notify signalObjectAdded with any(PlotObject*>.
| virtual bool PlotGroup::removeObject | ( | PlotObject * | pObject, | |
| bool | bDelete = false | |||
| ) | [pure virtual] |
Removes a plot object from the plot group.
- Parameters:
-
pObject The plot object to remove bDelete True - deletes the object upon removal, False - just removes the plot object
- Returns:
- True if the removal was successfule, false otherwise.
- Subject Notifications:
- This method will notify Subject::signalModified.
| virtual void PlotGroup::clear | ( | bool | bDelete = false |
) | [pure virtual] |
Clears the plot groups plot objects.
- Parameters:
-
bDelete True - deletes all the plot objects, false - Just removes the plot objects