Plane

Plane in hessian form.

Description

Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing.

Properties

float d 0.0
Vector3 normal Vector3( 0, 0, 0 )
float x 0.0
float y 0.0
float z 0.0

Constants

  • PLANE_YZ = Plane( 1, 0, 0, 0 ) --- A plane that extends in the Y and Z axes (normal vector points +X).
  • PLANE_XZ = Plane( 0, 1, 0, 0 ) --- A plane that extends in the X and Z axes (normal vector points +Y).
  • PLANE_XY = Plane( 0, 0, 1, 0 ) --- A plane that extends in the X and Y axes (normal vector points +Z).

Property Descriptions

Default 0.0

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.


Default Vector3( 0, 0, 0 )

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.


Default 0.0

The X component of the plane's normal vector.


Default 0.0

The Y component of the plane's normal vector.


Default 0.0

The Z component of the plane's normal vector.

Method Descriptions

Creates a plane from the four parameters. The three components of the resulting plane's normal are a, b and c, and the plane has a distance of d from the origin.


Creates a plane from the three points, given in clockwise order.


Creates a plane from the normal and the plane's distance to the origin.


Returns the center of the plane.


Returns the shortest distance from the plane to the position point.


Returns the center of the plane.

This method is deprecated, please use center instead.


Returns true if point is inside the plane. Comparison uses a custom minimum epsilon threshold.


Returns the intersection point of the three planes b, c and this plane. If no intersection is found, null is returned.


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.


Returns the intersection point of a segment from position begin to position end with this plane. If no intersection is found, null is returned.


Returns true if this plane and plane are approximately equal, by running @GDScript.is_equal_approx on each component.


Returns true if point is located above the plane.


Returns a copy of the plane, normalized.


Returns the orthogonal projection of point into a point in the plane.