- Qt 5.0
- QFeedbackHapticsInterface
- Qt 5.0.0 Reference Documentation

# QFeedbackHapticsInterface Class

The QFeedbackHapticsInterface class is the base class for plugins providing custom haptics effects. More...

Header: | #include <QFeedbackHapticsInterface>
Inherits: | QFeedbackInterface

- List of all members, including inherited members

## Public Types

enum | ActuatorProperty { Name, State, Enabled }
enum | EffectProperty { Duration, Intensity, AttackTime, AttackIntensity, FadeTime, …, Period }

## Public Functions

virtual QVariant | actuatorProperty(const QFeedbackActuator &actuator, ActuatorProperty property) = 0
virtual QList<QFeedbackActuator *> | actuators() = 0
virtual QFeedbackEffect::State | effectState(const QFeedbackHapticsEffect *effect) = 0
virtual bool | isActuatorCapabilitySupported(const QFeedbackActuator &actuator, QFeedbackActuator::Capability capability) = 0
virtual PluginPriority | pluginPriority() = 0
virtual void | setActuatorProperty(const QFeedbackActuator &actuator, ActuatorProperty property, const QVariant &value) = 0
virtual void | setEffectState(const QFeedbackHapticsEffect *effect, QFeedbackEffect::State state) = 0
virtual void | updateEffectProperty(const QFeedbackHapticsEffect *effect, EffectProperty property) = 0

## Protected Functions

QFeedbackActuator * | createFeedbackActuator(QObject *parent, int id)

## Detailed Description

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

### `[pure virtual]` QVariant QFeedbackHapticsInterface::actuatorProperty(const QFeedbackActuator &actuator, ActuatorProperty property)

Returns the value for the property for an actuator.

See also setActuatorProperty() and ActuatorProperty.

### `[pure virtual]` QList<QFeedbackActuator *> QFeedbackHapticsInterface::actuators()

Return the available actuators provided by this plugin. The ownership of the actuator objects stays with the plugin.

### `[protected]` QFeedbackActuator *QFeedbackHapticsInterface::createFeedbackActuator(QObject *parent, int id)

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.

### `[pure virtual]` QFeedbackEffect::State QFeedbackHapticsInterface::effectState(const QFeedbackHapticsEffect *effect)

Get the current state for the effect effect.

See also setEffectState().

### `[pure virtual]` bool QFeedbackHapticsInterface::isActuatorCapabilitySupported(const QFeedbackActuator &actuator, QFeedbackActuator::Capability capability)

Returns true if the actuator supports the capability.

### `[pure virtual]` PluginPriority QFeedbackHapticsInterface::pluginPriority()

Returns the priority for the plugin.

See also QFeedbackInterface::PluginPriority.

### `[pure virtual]` void QFeedbackHapticsInterface::setActuatorProperty(const QFeedbackActuator &actuator, ActuatorProperty property, const QVariant &value)

Sets a value for property on the actuator.

See also actuatorProperty() and ActuatorProperty.

### `[pure virtual]` void QFeedbackHapticsInterface::setEffectState(const QFeedbackHapticsEffect *effect, QFeedbackEffect::State state)

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().

### `[pure virtual]` void QFeedbackHapticsInterface::updateEffectProperty(const QFeedbackHapticsEffect *effect, EffectProperty property)

Tells the backend that the property has been updated for the supplied effect.