QFeedbackHapticsInterface Class
The QFeedbackHapticsInterface class is the base class for plugins providing custom haptics effects. More...
| Header: | #include <QFeedbackHapticsInterface> |
| Inherits: | QFeedbackInterface |
Public Types
| enum | ActuatorProperty { Name, State, Enabled } |
| enum | EffectProperty { Duration, Intensity, AttackTime, AttackIntensity, ..., Period } |
Public Functions
| virtual | ~QFeedbackHapticsInterface() |
| virtual QVariant | actuatorProperty(const QFeedbackActuator &, QFeedbackHapticsInterface::ActuatorProperty) = 0 |
| virtual QList<QFeedbackActuator *> | actuators() = 0 |
| virtual QFeedbackEffect::State | effectState(const QFeedbackHapticsEffect *) = 0 |
| virtual bool | isActuatorCapabilitySupported(const QFeedbackActuator &, QFeedbackActuator::Capability) = 0 |
| virtual QFeedbackInterface::PluginPriority | pluginPriority() = 0 |
| virtual void | setActuatorProperty(const QFeedbackActuator &, QFeedbackHapticsInterface::ActuatorProperty, const QVariant &) = 0 |
| virtual void | setEffectState(const QFeedbackHapticsEffect *, QFeedbackEffect::State) = 0 |
| virtual void | updateEffectProperty(const QFeedbackHapticsEffect *, QFeedbackHapticsInterface::EffectProperty) = 0 |
Static Public Members
| QFeedbackHapticsInterface * | instance() |
Protected Functions
| QFeedbackActuator * | createFeedbackActuator(QObject *parent, int id) |
Additional Inherited Members
- 1 static protected member inherited from QFeedbackInterface
Detailed Description
The QFeedbackHapticsInterface class is the base class for plugins providing custom haptics effects.
This interface will be used to try to play custom effects with specific duration, intensity, envelope and period. An effect is always played on a specified actuator.
Member Type Documentation
enum QFeedbackHapticsInterface::ActuatorProperty
This enum describes all actuator properties.
| Constant | Value | Description |
|---|---|---|
QFeedbackHapticsInterface::Name | 0 | The actuator name. |
QFeedbackHapticsInterface::State | 1 | The actuator state. |
QFeedbackHapticsInterface::Enabled | 2 | The actuator enabled state. |
enum QFeedbackHapticsInterface::EffectProperty
This enum describes all effect properties for haptics effects.
| Constant | Value | Description |
|---|---|---|
QFeedbackHapticsInterface::Duration | 0 | The effect duration (in milliseconds) |
QFeedbackHapticsInterface::Intensity | 1 | The effect intensity |
QFeedbackHapticsInterface::AttackTime | 2 | The effect attack time (in milliseconds) |
QFeedbackHapticsInterface::AttackIntensity | 3 | The effect attack intensity |
QFeedbackHapticsInterface::FadeTime | 4 | The effect fade time (in milliseconds) |
QFeedbackHapticsInterface::FadeIntensity | 5 | The effect fade intensity |
QFeedbackHapticsInterface::Period | 6 | The effect period, this is an optional effect property. |
Member Function Documentation
[virtual] QFeedbackHapticsInterface::~QFeedbackHapticsInterface()
Destroys the instance of QFeedbackHapticsInterface. The destructor is virtual.
[pure virtual] QVariant QFeedbackHapticsInterface::actuatorProperty(const QFeedbackActuator &, QFeedbackHapticsInterface::ActuatorProperty)
See also setActuatorProperty().
[pure virtual] QList<QFeedbackActuator *> QFeedbackHapticsInterface::actuators()
[protected] QFeedbackActuator *QFeedbackHapticsInterface::createFeedbackActuator(QObject *parent, int id)
[pure virtual] QFeedbackEffect::State QFeedbackHapticsInterface::effectState(const QFeedbackHapticsEffect *)
See also setEffectState().
[static] QFeedbackHapticsInterface *QFeedbackHapticsInterface::instance()
[pure virtual] bool QFeedbackHapticsInterface::isActuatorCapabilitySupported(const QFeedbackActuator &, QFeedbackActuator::Capability)
[pure virtual] QFeedbackInterface::PluginPriority QFeedbackHapticsInterface::pluginPriority()
[pure virtual] void QFeedbackHapticsInterface::setActuatorProperty(const QFeedbackActuator &, QFeedbackHapticsInterface::ActuatorProperty, const QVariant &)
See also actuatorProperty().
[pure virtual] void QFeedbackHapticsInterface::setEffectState(const QFeedbackHapticsEffect *, QFeedbackEffect::State)
See also effectState().