Arak::Coloring::Listener Class Reference

#include <coloring.hpp>

Inheritance diagram for Arak::Coloring::Listener:

[legend]List of all members.

---

Detailed Description

This interface is implemented by objects that must be notified when the coloring is updated.

When an update is requested, notifications occur in the following order:

1. Listeners are first notified of edges that will be removed as a result of the update. 2. Listeners are then notified of vertices that will be removed as a result of the update. 3. The update is performed. 4. Listeners are next notified of vertices that have been created by the update. 5. Listeners are next notified of edges that have been created by the update. 6. Listeners are finally notified of the region that has been recolored (either a triangle or a quadrilateral).

This ordering ensures that the listeners are notified while the coloring is in a consistent state (and so its methods can be safely invoked) and that they can refer to the specific structural elements that are changed by updates.

Definition at line 832 of file coloring.hpp.

Public Member Functions
virtual void	vertexHasBeenAdded (Coloring::VertexHandle vh)
	This method is invoked to inform the listener that a new vertex has been added to the coloring.
virtual void	vertexWillBeRemoved (Coloring::VertexHandle vh)
	This method is invoked to inform the listener that an existing vertex is about to be removed from the coloring.
virtual void	edgeHasBeenAdded (Coloring::IntEdgeHandle eh)
	This method is invoked to inform the listener that a new (interior) edge has been added to the coloring.
virtual void	edgeWillBeRemoved (Coloring::IntEdgeHandle eh)
	This method is invoked to inform the listener that an existing (interior) edge will be removed from the coloring.
virtual void	recolored (const Geometry::Point &a, const Geometry::Point &b, const Geometry::Point &c)
	This method is invoked to inform the listener that the triangle with the supplied vertices has been recolored.
virtual void	recolored (const Geometry::Point &a, const Geometry::Point &b, const Geometry::Point &c, const Geometry::Point &d)
	This method is invoked to inform the listener that the quadrilateral with the supplied vertices has been recolored.

---

Member Function Documentation

virtual void Arak::Coloring::Listener::edgeHasBeenAdded (  Coloring::IntEdgeHandle  eh  )  [inline, virtual]

This method is invoked to inform the listener that a new (interior) edge has been added to the coloring. Parameters: eh  a handle to the new edge Reimplemented in Arak::ArakPrior. Definition at line 858 of file coloring.hpp. References Arak::Coloring::IntEdgeHandle.

virtual void Arak::Coloring::Listener::edgeWillBeRemoved (  Coloring::IntEdgeHandle  eh  )  [inline, virtual]

This method is invoked to inform the listener that an existing (interior) edge will be removed from the coloring. Parameters: eh  a handle to the edge that will be removed Reimplemented in Arak::ArakPrior. Definition at line 866 of file coloring.hpp. References Arak::Coloring::IntEdgeHandle.

virtual void Arak::Coloring::Listener::recolored (  const Geometry::Point &  a, const Geometry::Point &  b, const Geometry::Point &  c, const Geometry::Point &  d )  [inline, virtual]

This method is invoked to inform the listener that the quadrilateral with the supplied vertices has been recolored. The vertices are supplied in either clockwise or counter-clockwise order. Note that this quadrilateral is simple, but not necessarily convex. Parameters: a  the first vertex of the quadrilateral b  the second vertex of the quadrilateral c  the third vertex of the quadrilateral d  the fourth vertex of the quadrilateral Reimplemented in Arak::ArakPrior, Arak::GridColorEstimator, Arak::ArakPosteriorRangeObs, and Arak::ArakPosteriorSonarObs. Definition at line 892 of file coloring.hpp. References Arak::Geometry::Point.

virtual void Arak::Coloring::Listener::recolored (  const Geometry::Point &  a, const Geometry::Point &  b, const Geometry::Point &  c )  [inline, virtual]

This method is invoked to inform the listener that the triangle with the supplied vertices has been recolored. Parameters: a  the first vertex of the triangle b  the second vertex of the triangle c  the third vertex of the triangle Reimplemented in Arak::ArakPrior, Arak::GridColorEstimator, Arak::ArakPosteriorRangeObs, and Arak::ArakPosteriorSonarObs. Definition at line 876 of file coloring.hpp. References Arak::Geometry::Point. Referenced by Arak::Coloring::recolored().

virtual void Arak::Coloring::Listener::vertexHasBeenAdded (  Coloring::VertexHandle  vh  )  [inline, virtual]

This method is invoked to inform the listener that a new vertex has been added to the coloring. Parameters: vh  a handle to the new vertex Reimplemented in Arak::ArakPrior. Definition at line 842 of file coloring.hpp. References Arak::Coloring::VertexHandle.

virtual void Arak::Coloring::Listener::vertexWillBeRemoved (  Coloring::VertexHandle  vh  )  [inline, virtual]

This method is invoked to inform the listener that an existing vertex is about to be removed from the coloring. Parameters: vh  a handle to the vertex that will be removed Reimplemented in Arak::ArakPrior. Definition at line 850 of file coloring.hpp. References Arak::Coloring::VertexHandle.

---

The documentation for this class was generated from the following file:

• coloring.hpp

---