ImFusion C++ SDK 4.5.0
ImFusion::US::InstrumentButtonListener Class Reference

#include <ImFusion/LiveUS/InstrumentButtonListener.h>

Utility class for managing button events from hardware. More...

Inheritance diagram for ImFusion::US::InstrumentButtonListener:

Detailed Description

Utility class for managing button events from hardware.

This class encapsulates detection of a button push/click event from tracking systems which have physical buttons and emits a signal once detected.

The provided TrackingStream must set the TrackingInstrument.statusFlag of the main instrument to a non-zero value to indicate a button press.

A minimum time interval can be configured to prevent multiple signal emissions from a single press event.

Public Member Functions

 InstrumentButtonListener (const TrackingStream &stream)
int minimumClickDuration ()
 Returns the minimum time interval (in milliseconds) between two consecutive clicks.
void setMinimumClickDuration (int millis)
 Sets the minimum time interval (in milliseconds) between two consecutive clicks.
Public Member Functions inherited from ImFusion::SignalReceiver
 SignalReceiver ()=default
 Default constructor.
 SignalReceiver (const SignalReceiver &other)
 Copy constructor, does not copy any existing signal connections from other.
SignalReceiveroperator= (SignalReceiver rhs)
 Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs.
virtual ~SignalReceiver ()
 Virtual destructor disconnects from all connected signals.

Public Attributes

Signal signalButtonPressed
 Signal emitted when the TrackingInstrument.statusFlag is set for the main instrument.

Additional Inherited Members

Protected Member Functions inherited from ImFusion::SignalReceiver
void disconnectAll ()
 Disconnects all existing connections.

The documentation for this class was generated from the following file:
  • ImFusion/LiveUS/InstrumentButtonListener.h
Search Tab / S to search, Esc to close