VR-Forces 4.0.4 Class Documentation
Public Member Functions | Public Attributes | Protected Attributes
makVrf::DtTerrainProfileDataProvider Class Reference

Contains the makVrf::DtTerrainProfileDataProvider class. More...

Inheritance diagram for makVrf::DtTerrainProfileDataProvider:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtTerrainProfileDataProvider (makVrv::DtDe &de)
 CTOR.
virtual ~DtTerrainProfileDataProvider ()
 DTOR.
virtual makVrv::DtUnicode name () const =0
 Override to provide the name of the object to display in the graph title bar.
virtual std::vector< DtVectorpoints ()=0
 Override to provide the list of points to be used to plot for the profile line in the graph.
virtual int color () const
 Returns the rgba value color of the line. Default is green.
virtual bool allowsTracking () const
 For some providers it does not make sense to allow symbol tracking (i.e.
virtual bool allowsVertices () const
 For some providers it does not make sense to allow vertices to be displayed on the graph due to the fact there could be many of them (i.e.

Public Attributes

boost::signal< void()> signal_dataUpdated
 Signal emitted when there is updated data to provide to the graph.
boost::signal< void()> signal_dataRemoved
 Signal emitted when the source data has been removed.

Protected Attributes

makVrv::DtDemyDe

Detailed Description

Contains the makVrf::DtTerrainProfileDataProvider class.

This class is a common base class for all objects that wish to provide data to a terrain profile widget. Implement the pure virtual methods lists below, and, be sure to provide support for the provided boost signals in order to assure that your data will be shown correctly in the terrain profile graph.

The following classes use this as a base:

DtTerrainProfileDataStateView DtTerrainProfileDataEnvironmentalListener DtTerrainProfileDataIntervisibilityListener DtTerrainProfileDataTrackHistory -- Note that the track history is only valid for the time this object is being used. Once the graph that represents this track history is removed the track history will be deleted. The next time the graph is opened the track history will start again


Constructor & Destructor Documentation

CTOR.

DTOR.


Member Function Documentation

virtual std::vector<DtVector> makVrf::DtTerrainProfileDataProvider::points ( ) [pure virtual]
virtual int makVrf::DtTerrainProfileDataProvider::color ( ) const [inline, virtual]
virtual bool makVrf::DtTerrainProfileDataProvider::allowsTracking ( ) const [inline, virtual]

For some providers it does not make sense to allow symbol tracking (i.e.

when you are creating a line), so, this method will return whether or not the provider has support for tracking

Reimplemented in makVrf::DtTerrainProfileDataEnvironmentalListener.

virtual bool makVrf::DtTerrainProfileDataProvider::allowsVertices ( ) const [inline, virtual]

For some providers it does not make sense to allow vertices to be displayed on the graph due to the fact there could be many of them (i.e.

track history profile). By default data providers will show vertices if enabled

Reimplemented in makVrf::DtTerrainProfileDataTrackHistory.


Member Data Documentation

Signal emitted when there is updated data to provide to the graph.

Signal emitted when the source data has been removed.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)