InertiaExpansionBehavior2D.DesiredExpansionY Property

Definition

Gets or sets the desired expansion along the y-axis, in coordinate units.

C#
public float DesiredExpansionY { get; set; }

Property Value

The desired expansion along the y-axis, in coordinate units.

Remarks

Expansion must be proportional. The value of this property must equal the value of the DesiredExpansionX property when the inertia processor starts; otherwise an exception is thrown.

This property value is mutually exclusive with the DesiredDeceleration property; setting this property will set DesiredDeceleration to NaN.

The default value for this property is NaN.

DesiredExpansionY must be a finite, non-negative number. The rate of expansion is determined by the InitialVelocityY property.

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

Applies to

Product Versions
.NET Framework 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9