PhysicsPlane
Represents a 2D plane.
Read time 1 minuteLast updated 10 days ago
Definition
- Type: Struct
- Namespace: Unity.U2D.Physics
- Assembly: UnityEngine.PhysicsCore2DModule
public struct PhysicsPlane
Fields
Value | Description |
|---|---|
| normal | The plane normal. This must be normalized for the plane be valid. |
| offset | The plane offset. |
Properties
Methods
Method | Description |
|---|---|
| GetSeparation | Get the signed separation of a point from a plane. |
| ToPositionAndNormal | Decompose the plane into a point lying on the plane and the plane's normal direction. The returned position is the foot of the perpendicular from the world origin to the plane, computed as normal * offset. This is the unique closest-to-origin point on the plane; any other point on the plane would describe the same plane equation but be non-deterministic. Useful for feeding a plane into APIs that take a (position, normal) pair such as _surfacePosition and _surfaceNormal. |