InertiaExpansionBehavior2D.DesiredExpansionY Property

Definition

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

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

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