CHWRMHaptics::THWRMHapticsMagSweepEffect Struct Reference

#include <hwrmhaptics.h>

struct CHWRMHaptics::THWRMHapticsMagSweepEffect

Detailed Description

Defines the paramaters used in a magsweep effect.

Used by PlayMagSweepEffect(), ModifyPlayingMagSweepEffect(), GetMagSweepEffectDefinition().

Member Attribute Documentation

iAttackLevel

TInt iAttackLevel

Attack level of the effect.

The attack level is clamped to a value from KHWRMHapticsMinMagnitude to KHWRMHapticsMaxMagnitude.

iAttackTime

TInt iAttackTime

Attack time of the effect. Unit is milliseconds.

The attack time is clamped to a value from 0 to the value returned by GetDeviceCapability() for the EHWRMHapticsMaxEnvelopeTime capability type.

iDuration

TInt iDuration

Duration of the effect. Unit is milliseconds.

To specify an infinite duration, the effect duration should be set to a value returned by InfiniteDuration(). For a finite duration, the effect duration is clamped to a value from 0 to the value returned by GetDeviceCapability() for the EHWRMHapticsMaxEffectDuration capability type.

iFadeLevel

TInt iFadeLevel

Fade level of the effect.

The fade level is clamped to a value from KHWRMHapticsMinMagnitude to KHWRMHapticsMaxMagnitude inclusive.

iFadeTime

TInt iFadeTime

Fade time of the effect. Unit is milliseconds.

The fade time is clamped to a value from 0 to the value returned by GetDeviceCapability() for the EHWRMHapticsMaxEnvelopeTime capability type.

iMagnitude

TInt iMagnitude

Magnitude of the effect.

The effect magnitude is clamped to a value from KHWRMHapticsMinMagnitude to KHWRMHapticsMaxMagnitude.

iStyle

TInt iStyle

Style of the effect.

Can be one of THWRMHapticsEffectStyles.