|
|
              
QFeedbackHapticsInterface Class ReferenceThe QFeedbackHapticsInterface class is the base class for plugins providing custom haptics effects. More... #include <QFeedbackHapticsInterface> Inherits QFeedbackInterface. Public Types
Public Functions
Protected Functions
Additional Inherited Members
Detailed DescriptionThe 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
|
| 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
QVariant QFeedbackHapticsInterface::actuatorProperty ( const QFeedbackActuator & actuator, ActuatorProperty property ) [pure virtual]
Returns the value for the property for an actuator.
See also setActuatorProperty() and ActuatorProperty.
QList<QFeedbackActuator *> QFeedbackHapticsInterface::actuators () [pure virtual]
Return the available actuators provided by this plugin. The ownership of the actuator objects stays with the plugin.
QFeedbackActuator * QFeedbackHapticsInterface::createFeedbackActuator ( QObject * parent, int id ) [protected]
Creates an instance of QFeedbackActuator with the identifier id and parent parent. This allows backends to create instances of actuators. It is then up to the each backend to manage the identifiers according to its needs.
QFeedbackEffect::State QFeedbackHapticsInterface::effectState ( const QFeedbackHapticsEffect * effect ) [pure virtual]
Get the current state for the effect effect.
See also setEffectState().
bool QFeedbackHapticsInterface::isActuatorCapabilitySupported ( const QFeedbackActuator & actuator, QFeedbackActuator::Capability capability ) [pure virtual]
Returns true if the actuator supports the capability.
PluginPriority QFeedbackHapticsInterface::pluginPriority () [pure virtual]
Returns the priority for the plugin.
See also QFeedbackInterface::PluginPriority.
void QFeedbackHapticsInterface::setActuatorProperty ( const QFeedbackActuator & actuator, ActuatorProperty property, const QVariant & value ) [pure virtual]
Sets a value for property on the actuator.
See also actuatorProperty() and ActuatorProperty.
void QFeedbackHapticsInterface::setEffectState ( const QFeedbackHapticsEffect * effect, QFeedbackEffect::State state ) [pure virtual]
Sets the state to state for the effect effect. If that fails the backend should report an error by calling reportError and effect will in turn emit an error signal.
See also effectState().
void QFeedbackHapticsInterface::updateEffectProperty ( const QFeedbackHapticsEffect * effect, EffectProperty property ) [pure virtual]
Tells the backend that the property has been updated for the supplied effect.