VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
makVrv::DtDisplayUnitsSettingsSignaler Class Reference

The Widget signaler class is used to connect Widget generated events in the main thread to the WidgetAgent owners that are running it separate threads. More...

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

List of all members.

Public Member Functions

virtual ~DtDisplayUnitsSettingsSignaler ()
 DTOR.

Static Public Member Functions

static
DtDisplayUnitsSettingsSignaler
instance (const DtSharedSettingsManager &)
 Get the instance of the signaler using the shared settings manager.
static
DtDisplayUnitsSettingsSignaler
instance (DtEventQueueInterface &)
 Get the instance of the signaler using the event queue interface.
static
DtDisplayUnitsSettingsSignaler
findInstance (DtEventQueueInterface *)
 Find the instance of the signaler using the event queue interface.

Public Attributes

Signals
event_signal< void(DtUnitConverterCollection::DisplayUnitType,
int, int)> 
signal_displayUnitChanged
 Signals that the active display unit for the given type has changed.
event_signal< void(DtUnitConverterCollection::DisplayUnitType,
int, int, int)> 
signal_displayUnitDecimalsChanged
 Signals that the precision for a given display unit has changed.
event_signal< void(DtSharedDisplayUnitsSettings::CoordSys,
DtSharedDisplayUnitsSettings::CoordSys)> 
signal_displayCoordinateSystemChanged
 Signals that the display coordinate system has changed.
event_signal< void(DtSharedDisplayUnitsSettings::CoordSys,
int, int)> 
signal_displayCoordinateSystemDecimalsChanged
 Signals that the decimal precision for a display coordinate system has changed.

Protected Member Functions

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

Private Member Functions

 DtDisplayUnitsSettingsSignaler (const DtDisplayUnitsSettingsSignaler &)
DtDisplayUnitsSettingsSignaleroperator= (const DtDisplayUnitsSettingsSignaler &)

Detailed Description

The Widget signaler class is used to connect Widget generated events in the main thread to the WidgetAgent owners that are running it separate threads.

Typically this call is only used by WidgetInstanceSignaler and


Constructor & Destructor Documentation

DTOR.

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


Member Function Documentation

Get the instance of the signaler using the shared settings manager.

Get the instance of the signaler using the event queue interface.

Find the instance of the signaler using the event queue interface.

Return values:
NULLif the instance does not exist.
DtDisplayUnitsSettingsSignaler& makVrv::DtDisplayUnitsSettingsSignaler::operator= ( const DtDisplayUnitsSettingsSignaler ) [private]

Member Data Documentation

Signals that the active display unit for the given type has changed.

The first parameter indicates what unit type enumeration the second parameter indicates the units using. For example, if the first param is DtSharedDisplayUnitsSettings::Distance, the second param should be cast to makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits in order to interpret the value correctly.

Parameters:
_1Indicates what type of display unit changed.
_2Indicates the new active display unit for the type.
_3Indicates the old display unit for the type

Signals that the precision for a given display unit has changed.

The first parameter indicates the type of display unit, the second parameter indicates the specific unit (of that type), whose precision changed, and the third parameter indicates the new decimal count.

Parameters:
_1Indicates what type of display unit changed.
_2Indicates the specific display unit that changed.
_3Indicates the new decimal precision for the display unit.
_4Indicates the old decimal precision for the Display Unit.

Signals that the display coordinate system has changed.

Parameters:
_1Indicates the new display coordinate system.
_2Indicates the old display coordinate system.

Signals that the decimal precision for a display coordinate system has changed.

Parameters:
_1Indicates the display coordinate system.
_2Indicates the new decimal value
_3Indicates the old decimal value

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)