Edit

Share via


InertiaTranslationBehavior2D.DesiredDeceleration Property

Definition

Gets or sets the desired deceleration, in coordinate units per millisecond squared.

public:
 property float DesiredDeceleration { float get(); void set(float value); };
public float DesiredDeceleration { get; set; }
member this.DesiredDeceleration : single with get, set
Public Property DesiredDeceleration As Single

Property Value

The desired deceleration, in coordinate units per millisecond squared.

Remarks

This property value is mutually exclusive with the DesiredDisplacement property; setting this property will set DesiredDisplacement to NaN. The default value for both this property and DesiredDisplacement is NaN. You must set one or the other property before inertia processing starts.

DesiredDeceleration must be a finite, non-negative number.

This property cannot be set while the inertia processor is running; otherwise, an exception is thrown.

Applies to