Plane Structure

Plane represents a normalized plane equation. "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing.

Namespace: Godot
Assembly: GodotSharp (in GodotSharp.dll) Version: 1.0.0

Syntax

[SerializableAttribute]
public struct Plane : IEquatable<Plane>

The Plane type exposes the following members.

Constructors

	Name	Description
	Plane(Vector3, Single)	Constructs a plane from a normal vector and the plane's distance to the origin.
	Plane(Vector3, Vector3, Vector3)	Constructs a plane from the three points, given in clockwise order.
	Plane(Single, Single, Single, Single)	Constructs a plane from four values. `a`, `b` and `c` become the components of the resulting plane's Normal vector. `d` becomes the plane's distance from the origin.

Properties

	Name	Description
	Center	The center of the plane, the point where the normal line intersects the plane.
	D	The distance from the origin to the plane (in the direction of Normal). This value is typically non-negative. In the scalar equation of the plane `ax + by + cz = d`, this is `d`, while the `(a, b, c)` coordinates are represented by the Normal property.
	Normal	The normal of the plane, which must be normalized. In the scalar equation of the plane `ax + by + cz = d`, this is the vector `(a, b, c)`, where `d` is the D property.
	PlaneXY	A plane that extends in the X and Y axes (normal vector points +Z).
	PlaneXZ	A plane that extends in the X and Z axes (normal vector points +Y).
	PlaneYZ	A plane that extends in the Y and Z axes (normal vector points +X).
	x	The X component of the plane's normal vector.
	y	The Y component of the plane's normal vector.
	z	The Z component of the plane's normal vector.

Methods

	Name	Description
	DistanceTo	Returns the shortest distance from this plane to the position `point`.
	Equals(Object)	(Overrides ValueTypeEquals(Object).)
	Equals(Plane)
	GetAnyPoint	Obsolete. The center of the plane, the point where the normal line intersects the plane. Deprecated, use the Center property instead.
	GetHashCode	(Overrides ValueTypeGetHashCode.)
	GetType	(Inherited from Object.)
	HasPoint	Returns true if point is inside the plane. Comparison uses a custom minimum epsilon threshold.
	Intersect3	Returns the intersection point of the three planes: `b`, `c`, and this plane. If no intersection is found, `null` is returned.
	IntersectRay	Returns the intersection point of a ray consisting of the position `from` and the direction normal `dir` with this plane. If no intersection is found, `null` is returned.
	IntersectSegment	Returns the intersection point of a line segment from position `begin` to position `end` with this plane. If no intersection is found, `null` is returned.
	IsEqualApprox	Returns true if this plane and `other` are approximately equal, by running IsEqualApprox(Single, Single) on each component.
	IsPointOver	Returns true if `point` is located above the plane.
	Normalized	Returns the plane scaled to unit length.
	Project	Returns the orthogonal projection of `point` into the plane.
	ToString	(Overrides ValueTypeToString.)
	ToString(String)

Operators