makVrv::DtOsgSensorViewOverlay Class Reference

DtOsgSensorViewOverlay is responsible for creating and updating the overlay information on a sensor view. This is achieved by managing a list of sensor view overlay sections. Each overlay section is responsible for a piece of the overall overlay. When a sensor view is created a DtOsgSensorViewOverlay is created to manage its overlay drawing. The creator provides a list of overlay section creators. These are used to create the sections that will do the overlay drawing.

Inheritance diagram for makVrv::DtOsgSensorViewOverlay:

Public Types
typedef std::map< std::string, DtOsgSensorViewOverlaySection * >	DtOverlaySectionMap

Public Member Functions
virtual	~DtOsgSensorViewOverlay ()
virtual void	initialize (const std::string &windowName, const std::string &channelName)
virtual void	update (const std::string &observerName, const DtSensorFieldOfViewData &state)
virtual DtOverlaySectionMap &	overlaySections ()
virtual const DtOverlaySectionMap &	overlaySections () const
virtual DtOsgSensorViewOverlaySection *	findOverlaySection (const std::string &name)
Public Member Functions inherited from makVrv::DtSensorViewOverlay
virtual	~DtSensorViewOverlay ()
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Protected Member Functions
	DtOsgSensorViewOverlay (DtDe &de, DtOsgSensorViewOverlaySectionCreators &sectionCreators)
Protected Member Functions inherited from makVrv::DtSensorViewOverlay
	DtSensorViewOverlay (DtDe &de)

Protected Attributes
std::string	myWindowName
std::string	myChannelName
int	myChannelWidth
int	myChannelHeight
int	myXOffset
int	myYOffset
DtOverlaySectionMap	myOverlaySections
Protected Attributes inherited from makVrv::DtSensorViewOverlay
makVrv::DtDe &	myDe

Friends
class	DtOsgSensorViewOverlayCreator

Member Typedef Documentation

typedef std::map<std::string, DtOsgSensorViewOverlaySection*> makVrv::DtOsgSensorViewOverlay::DtOverlaySectionMap

Constructor & Destructor Documentation

virtual makVrv::DtOsgSensorViewOverlay::~DtOsgSensorViewOverlay ( )

virtual

Destructor.

makVrv::DtOsgSensorViewOverlay::DtOsgSensorViewOverlay ( DtDe &  de, DtOsgSensorViewOverlaySectionCreators &  sectionCreators  )

protected

Constructor needs the DtDe to use. Protected because this is only called by the DtSensorViewOverlayCreator.

Member Function Documentation

virtual void makVrv::DtOsgSensorViewOverlay::initialize ( const std::string &  windowName, const std::string &  channelName  )

virtual

Initializes the overlay. Must be called prior to update.

Implements makVrv::DtSensorViewOverlay.

virtual void makVrv::DtOsgSensorViewOverlay::update ( const std::string &  observerName, const DtSensorFieldOfViewData &  state  )

virtual

Updates the overlay based on the given sensor field of view state.

Implements makVrv::DtSensorViewOverlay.

virtual DtOverlaySectionMap& makVrv::DtOsgSensorViewOverlay::overlaySections ( )

virtual

Get the map of pointers to the overlay drawing sections.

virtual const DtOverlaySectionMap& makVrv::DtOsgSensorViewOverlay::overlaySections ( ) const

virtual

Get a const reference to the map of pointers to the overlay drawing sections.

virtual DtOsgSensorViewOverlaySection* makVrv::DtOsgSensorViewOverlay::findOverlaySection ( const std::string &  name )

virtual

Find an overlay section by name (each section has a public 'SectionName' const string) If the overlay is not found nullptr is returned.

Friends And Related Function Documentation

friend class DtOsgSensorViewOverlayCreator

friend

Member Data Documentation

std::string makVrv::DtOsgSensorViewOverlay::myWindowName

protected

std::string makVrv::DtOsgSensorViewOverlay::myChannelName

protected

int makVrv::DtOsgSensorViewOverlay::myChannelWidth

protected

int makVrv::DtOsgSensorViewOverlay::myChannelHeight

protected

int makVrv::DtOsgSensorViewOverlay::myXOffset

protected

int makVrv::DtOsgSensorViewOverlay::myYOffset

protected

DtOverlaySectionMap makVrv::DtOsgSensorViewOverlay::myOverlaySections

protected

The map of overlay sections.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvOsg/DtOsgSensorViewOverlay.h