ConditionForceEffect Class

Reference

Definition

Namespace:: Windows.Gaming.Input.ForceFeedback

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Conditional force effects are forces applied in response to current sensor values within the device. In other words, conditional force effects require information about device motion, such as position or velocity of a joystick handle. In general, conditional force effects are not associated with individual events during a game or other application. They represent ambient phenomena, such as the stiffness or looseness of a flight stick, or the tendency of a steering wheel to return to a straight-ahead position. A conditional force effect does not have a predefined magnitude. The magnitude is scaled in proportion to the movement or position of the input object.

public ref class ConditionForceEffect sealed

/// [Windows.Foundation.Metadata.Activatable(Windows.Gaming.Input.ForceFeedback.IConditionForceEffectFactory, 196608, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ConditionForceEffect final

[Windows.Foundation.Metadata.Activatable(typeof(Windows.Gaming.Input.ForceFeedback.IConditionForceEffectFactory), 196608, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ConditionForceEffect

function ConditionForceEffect(effectKind)

Public NotInheritable Class ConditionForceEffect

Inheritance: Object Platform::Object IInspectable ConditionForceEffect

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements: IForceFeedbackEffect

Windows requirements

Device family	Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v3.0)

Constructors

ConditionForceEffect(ConditionForceEffectKind)

Creates an instance of ConditionForceEffect.

Properties

Gain	Specifies the percentage by which to reduce the force of the effect.
Kind	The type of force feedback effect.
State	The current state of the effect.

Methods

SetParameters(Vector3, Single, Single, Single, Single, Single, Single)	Sets the parameters for the conditional force feedback effect.
Start()	Starts the force feedback effect.
Stop()	Stops the force feedback effect.

Applies to

Share via