Method Planar
Planar(int, FloatRange, float, float)
Constrains linear motion about one axis within the specified range. Movement about the other two is unrestricted.
Declaration
public static Constraint Planar(int limitedAxis, Math.FloatRange distanceRange, float springFrequency = 74341.31, float dampingRatio = 2530.126)Parameters
| Type | Name | Description |
|---|---|---|
| int | limitedAxis | The axis along which the bodies' translation is restricted. |
| Math.FloatRange | distanceRange | The minimum required distance and maximum possible distance between the constrained bodies about the constrained axis. Identical minimum and maximum values result in a plane, while different values constrain the bodies between two parallel planes. |
| float | springFrequency | The spring frequency used to relax this constraint. |
| float | dampingRatio | The damping ratio used to relax this constraint. |
Returns
| Type | Description |
|---|---|
| Constraint | A Constraint. |
Planar(int, FloatRange, float3, float, float)
Constrains linear motion about one axis within the specified range. Movement about the other two is unrestricted.
Declaration
public static Constraint Planar(int limitedAxis, Math.FloatRange distanceRange, float3 impulseEventThreshold, float springFrequency = 74341.31, float dampingRatio = 2530.126)Parameters
| Type | Name | Description |
|---|---|---|
| int | limitedAxis | The axis along which the bodies' translation is restricted. |
| Math.FloatRange | distanceRange | The minimum required distance and maximum possible distance between the constrained bodies about the constrained axis. Identical minimum and maximum values result in a plane, while different values constrain the bodies between two parallel planes. |
| float3 | impulseEventThreshold | The minimum impulse needed to receive an impulse event for this constraint. |
| float | springFrequency | The spring frequency used to relax this constraint. |
| float | dampingRatio | The damping ratio used to relax this constraint. |
Returns
| Type | Description |
|---|---|
| Constraint | A Constraint. |