Version: Unity 6.6 Alpha (6000.6)
LanguageEnglish
  • C#

PhysicsPlane

struct in Unity.U2D.Physics

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Represents a 2D plane.

Properties

Property Description
isValid Check if the plane is valid. To be valid, the PhysicsPlane.normal must be normalized.
normal The plane normal. This must be normalized for the plane be valid.
offset The plane offset.

Public 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 PhysicsBody.BuoyancyInput.surfacePosition and PhysicsBody.BuoyancyInput.surfaceNormal.