VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
makVrv::DtSharedTrackHistorySettingsSignaler Class Reference

A signaler for the shared track history settings. More...

Inheritance diagram for makVrv::DtSharedTrackHistorySettingsSignaler:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtSharedTrackHistorySettingsSignaler ()
 DTOR.
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor.
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor.

Static Public Member Functions

static
DtSharedTrackHistorySettingsSignaler
instance (const DtSharedSettingsManager &mgr)
 Get the instance of the settings signaler from the settings manager.
static
DtSharedTrackHistorySettingsSignaler
instance (DtEventQueueInterface &eqi)
 Get the instance of the settings signaler from the event queue.
static
DtSharedTrackHistorySettingsSignaler
findInstance (DtEventQueueInterface *eqi)
 Find the instance of the settings signaler from the event queue.

Public Attributes

Setting Changed Signals
event_signal< void(int)> signal_trackHistoryRibbonLengthChanged
 Signals that the track history ribbon length changed.
event_signal< void(float)> signal_trackHistoryRibbonSpacingChanged
 Signals that the track history ribbon spacing changed.
event_signal< void(bool)> signal_trackHistoryRibbonInfiniteChanged
 Signals that infinite track history ribbons have been toggled on or off.

Protected Member Functions

 DtSharedTrackHistorySettingsSignaler (DtEventQueueInterface &eqi)
 Protected CTOR ( Use ::instance(..) ).

Private Member Functions

 DtSharedTrackHistorySettingsSignaler (const DtSharedTrackHistorySettingsSignaler &sig)
 Copy CTOR (Not implemented).
DtSharedTrackHistorySettingsSignaleroperator= (const DtSharedTrackHistorySettingsSignaler &sig)
 Assignment Operator (Not implemented).

Detailed Description

A signaler for the shared track history settings.

Constructor & Destructor Documentation

virtual makVrv::DtSharedTrackHistorySettingsSignaler::~DtSharedTrackHistorySettingsSignaler ( )
virtual

DTOR.

makVrv::DtSharedTrackHistorySettingsSignaler::DtSharedTrackHistorySettingsSignaler ( DtEventQueueInterface eqi)
protected

Protected CTOR ( Use ::instance(..) ).

makVrv::DtSharedTrackHistorySettingsSignaler::DtSharedTrackHistorySettingsSignaler ( const DtSharedTrackHistorySettingsSignaler sig)
private

Copy CTOR (Not implemented).

Member Function Documentation

static DtSharedTrackHistorySettingsSignaler& makVrv::DtSharedTrackHistorySettingsSignaler::instance ( const DtSharedSettingsManager mgr)
static

Get the instance of the settings signaler from the settings manager.

This will return a different signaler depending on what thread this function is called from.

static DtSharedTrackHistorySettingsSignaler& makVrv::DtSharedTrackHistorySettingsSignaler::instance ( DtEventQueueInterface eqi)
static

Get the instance of the settings signaler from the event queue.

This will return the same signaler independent of the thread.

static DtSharedTrackHistorySettingsSignaler* makVrv::DtSharedTrackHistorySettingsSignaler::findInstance ( DtEventQueueInterface eqi)
static

Find the instance of the settings signaler from the event queue.

If a settings signaler isn't registered with the event queue, this method will return NULL (one will not be created).

Returns
NULL if the instance does not exist.
DtSharedTrackHistorySettingsSignaler& makVrv::DtSharedTrackHistorySettingsSignaler::operator= ( const DtSharedTrackHistorySettingsSignaler sig)
private

Assignment Operator (Not implemented).

Member Data Documentation

event_signal<void (int)> makVrv::DtSharedTrackHistorySettingsSignaler::signal_trackHistoryRibbonLengthChanged

Signals that the track history ribbon length changed.

Parameters
_1the new track history length (in samples).
event_signal<void (float)> makVrv::DtSharedTrackHistorySettingsSignaler::signal_trackHistoryRibbonSpacingChanged

Signals that the track history ribbon spacing changed.

Parameters
_1the new spacing between samples in the ribbon (in meters).
event_signal<void (bool)> makVrv::DtSharedTrackHistorySettingsSignaler::signal_trackHistoryRibbonInfiniteChanged

Signals that infinite track history ribbons have been toggled on or off.

Parameters
_1whether track histories are now 'infinitely long' (250k samples).

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)