VR-Forces Development_Version Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
makVrv::DtSharedForceManagerSignaler Class Reference

Shared signaler for the force manager to signal when a force is added or removed. More...

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

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

Signals for the force manager.
event_signal< void(int)> signal_forceRemoved
 Emitted when a force is removed.
event_signal< void(int)> signal_forceAdded
 Emitted when a force is removed.

Protected Member Functions

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

Private Member Functions

 DtSharedForceManagerSignaler (const DtSharedForceManagerSignaler &sig)
 Copy CTOR (Not implemented).
DtSharedForceManagerSignaleroperator= (const DtSharedForceManagerSignaler &sig)
 Assignment Operator (Not implemented).

Detailed Description

Shared signaler for the force manager to signal when a force is added or removed.

Constructor & Destructor Documentation

virtual makVrv::DtSharedForceManagerSignaler::~DtSharedForceManagerSignaler ( )
virtual

DTOR.

makVrv::DtSharedForceManagerSignaler::DtSharedForceManagerSignaler ( DtEventQueueInterface eqi)
protected

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

makVrv::DtSharedForceManagerSignaler::DtSharedForceManagerSignaler ( const DtSharedForceManagerSignaler sig)
private

Copy CTOR (Not implemented).

Member Function Documentation

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

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

Returns
An instance of the settings signaler.
Note
This will return a different signaler depending on what thread this function is called from.
static DtSharedForceManagerSignaler& makVrv::DtSharedForceManagerSignaler::instance ( DtEventQueueInterface eqi)
static

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

Returns
An instance of the settings signaler.
Note
This will return the same signaler independent of the thread.
static DtSharedForceManagerSignaler* makVrv::DtSharedForceManagerSignaler::findInstance ( DtEventQueueInterface eqi)
static

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

Returns
An instance of the settings signaler or NULL of the instance does not exist.
Note
If a settings signaler is not registered with the event queue, this method will not create one.
DtSharedForceManagerSignaler& makVrv::DtSharedForceManagerSignaler::operator= ( const DtSharedForceManagerSignaler sig)
private

Assignment Operator (Not implemented).

Member Data Documentation

event_signal<void (int)> makVrv::DtSharedForceManagerSignaler::signal_forceRemoved

Emitted when a force is removed.

event_signal<void (int)> makVrv::DtSharedForceManagerSignaler::signal_forceAdded

Emitted when a force is removed.


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

Document ID: Generated on Mon Jul 4 01:00:18 EDT 2016 from SVN revision 166489
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)