AoiElement Class Reference
Storage for a collection of pixel locations. More...
#include <AoiElement.h>
Public Member Functions | |
| virtual void | clearPoints ()=0 |
| virtual size_t | getPixelCount () const =0 |
| virtual const BitMask * | getSelectedPoints () const =0 |
| virtual void | toggleAllPoints ()=0 |
| virtual bool | getAllPointsToggled () const =0 |
| virtual GraphicObject * | addPoints (const std::vector< LocationType > &points)=0 |
| virtual GraphicObject * | addPoints (const BitMask *pPoints)=0 |
| virtual GraphicObject * | addPoint (LocationType point)=0 |
| virtual GraphicObject * | removePoints (const std::vector< LocationType > &points)=0 |
| virtual GraphicObject * | removePoints (const BitMask *pPoints)=0 |
| virtual GraphicObject * | removePoint (LocationType point)=0 |
| virtual GraphicObject * | togglePoints (const std::vector< LocationType > &points)=0 |
| virtual GraphicObject * | togglePoints (const BitMask *pPoints)=0 |
| virtual GraphicObject * | togglePoint (LocationType point)=0 |
Static Public Member Functions | |
| static const std::string & | signalPointsChanged () |
Protected Member Functions | |
| virtual | ~AoiElement () |
Detailed Description
Storage for a collection of pixel locations.An area of interest (AOI) is a concept used to select individual pixels within a two-dimensional raster area to limit or control processing. The AOI class contains a number of vector objects which are added together to identify whether each pixel in a scene is included in the collection.
This subclass of Subject will notify upon the following conditions: * The following methods are called: addPoint(), addPoints(), removePoint(), removePoints(), togglePoint(), togglePoints(), toggleAllPoints(), clearPoints(). * Everything else documented in GraphicElement.
- Examples:
Definition at line 35 of file AoiElement.h.
Constructor & Destructor Documentation
| virtual AoiElement::~AoiElement | ( | ) | [protected, virtual] |
This should be destroyed by calling ModelServices::destroyElement.
Definition at line 191 of file AoiElement.h.
Member Function Documentation
| static const std::string& AoiElement::signalPointsChanged | ( | ) | [static] |
Emitted when the points in the AOI are changed, e.g., points are added, removed, toggled, AOI area is moved, etc.
Definition at line 41 of file AoiElement.h.
| virtual void AoiElement::clearPoints | ( | ) | [pure virtual] |
Clear all points from the AOI.
Calling this method will delete all objects within the AOI.
- Subject Notifications:
- This method will notify Subject::signalModified and AoiElement::signalPointsChanged.
| virtual size_t AoiElement::getPixelCount | ( | ) | const [pure virtual] |
Get the count of pixels selected by the AOI.
- Returns:
- The number of points which are selected.
| virtual const BitMask* AoiElement::getSelectedPoints | ( | ) | const [pure virtual] |
Get all points selected by the AOI.
- Returns:
- A BitMask indicating which points are selected.
- Examples:
- Tutorial/Tutorial4.cpp.
| virtual void AoiElement::toggleAllPoints | ( | ) | [pure virtual] |
Toggle all points.
This causes an inversion of the pixels selected.
- Subject Notifications:
- This method will notify Subject::signalModified and AoiElement::signalPointsChanged.
| virtual bool AoiElement::getAllPointsToggled | ( | ) | const [pure virtual] |
Determine whether all points are toggled.
- Returns:
- True if all points have been toggled, false otherwise.
| virtual GraphicObject* AoiElement::addPoints | ( | const std::vector< LocationType > & | points | ) | [pure virtual] |
Adds a list of points to the collection of those currently marked as selected.
- Parameters:
-
points A vector of points to be marked as selected in the AOI.
- Subject Notifications:
- This method will notify Subject::signalModified and AoiElement::signalPointsChanged.
| virtual GraphicObject* AoiElement::addPoints | ( | const BitMask * | pPoints | ) | [pure virtual] |
Updates the AOI to include any additional points marked as selected from the incoming BitMask argument.
- Parameters:
-
pPoints A BitMask containing additional points to mark as selected. The AoiElement does not take ownership over the mask.
- Subject Notifications:
- This method will notify Subject::signalModified and AoiElement::signalPointsChanged.
| virtual GraphicObject* AoiElement::addPoint | ( | LocationType | point | ) | [pure virtual] |
Adds a point to the collection of those currently marked as selected.
- Parameters:
-
point A point to mark as selected in the AOI.
- Subject Notifications:
- This method will notify Subject::signalModified and AoiElement::signalPointsChanged.
| virtual GraphicObject* AoiElement::removePoints | ( | const std::vector< LocationType > & | points | ) | [pure virtual] |
Removes a list of points from the collection of those currently marked as selected.
- Parameters:
-
points A vector of points to be marked as unselected in the AOI.
- Subject Notifications:
- This method will notify Subject::signalModified and AoiElement::signalPointsChanged.
| virtual GraphicObject* AoiElement::removePoints | ( | const BitMask * | pPoints | ) | [pure virtual] |
Updates the AOI to remove any additional points marked as selected from the incoming BitMask argument.
- Parameters:
-
pPoints A BitMask containing additional points to mark as unselected. The AoiElement does not take ownership over the mask.
- Subject Notifications:
- This method will notify Subject::signalModified and AoiElement::signalPointsChanged.
| virtual GraphicObject* AoiElement::removePoint | ( | LocationType | point | ) | [pure virtual] |
Removes a point from the collection of those currently marked as selected.
- Parameters:
-
point A point to mark as unselected in the AOI.
- Subject Notifications:
- This method will notify Subject::signalModified and AoiElement::signalPointsChanged.
| virtual GraphicObject* AoiElement::togglePoints | ( | const std::vector< LocationType > & | points | ) | [pure virtual] |
Toggles a set of points in the collection.
Any point currently selected is changed to unselected. If it is currently unselected, then it changes to selected.
- Parameters:
-
points A vector of points to toggle the selected status in the AOI.
- Subject Notifications:
- This method will notify Subject::signalModified and AoiElement::signalPointsChanged.
| virtual GraphicObject* AoiElement::togglePoints | ( | const BitMask * | pPoints | ) | [pure virtual] |
Toggles a set of points in the collection.
Any point currently selected is changed to unselected. If it is currently unselected, then it changes to selected.
- Parameters:
-
pPoints A BitMask containing selected pixels indicating those that should be toggled. The AoiElement does not take ownership over the mask.
- Subject Notifications:
- This method will notify Subject::signalModified and AoiElement::signalPointsChanged.
| virtual GraphicObject* AoiElement::togglePoint | ( | LocationType | point | ) | [pure virtual] |
Toggles a point from in the collection.
If the point is currently selected, change it to unselected. If it is currently unselected, then change it to selected.
- Parameters:
-
point A point to toggle the selected status in the AOI.
- Subject Notifications:
- This method will notify Subject::signalModified and AoiElement::signalPointsChanged.