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.

Tutorials¶

• Math

Properties¶

Methods¶

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¶

• floatd

The distance from the origin to the plane, in the direction ofnormal. This value is typically non-negative.

In the scalar equation of the planeax+by+cz=d, this isd, while the(a,b,c) coordinates are represented by thenormal property.

• Vector3normal

The normal of the plane, which must be normalized.

In the scalar equation of the planeax+by+cz=d, this is the vector(a,b,c), whered is thed property.

• floatx

The X component of the plane'snormal vector.

• floaty

The Y component of the plane'snormal vector.

• floatz

The Z component of the plane'snormal vector.

Method Descriptions¶

• PlanePlane(float a,float b,float c,float d)

Creates a plane from the four parameters. The three components of the resulting plane'snormal area,b andc, and the plane has a distance ofd from the origin.

• PlanePlane(Vector3 v1,Vector3 v2,Vector3 v3)

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

• PlanePlane(Vector3 normal,float d)

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

• Vector3center()

Returns the center of the plane.

• floatdistance_to(Vector3 point)

Returns the shortest distance from the plane to the positionpoint.

• Vector3get_any_point()

Returns the center of the plane.

This method is deprecated, please usecenter instead.

• boolhas_point(Vector3 point,float epsilon=1e-05)

Returnstrue ifpoint is inside the plane. Comparison uses a custom minimumepsilon threshold.

• Vector3intersect_3(Plane b,Plane c)

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

• Vector3intersects_ray(Vector3 from,Vector3 dir)

Returns the intersection point of a ray consisting of the positionfrom and the direction normaldir with this plane. If no intersection is found,null is returned.

• Vector3intersects_segment(Vector3 begin,Vector3 end)

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

• boolis_equal_approx(Plane plane)

Returnstrue if this plane andplane are approximately equal, by running@GDScript.is_equal_approx on each component.

• boolis_point_over(Vector3 point)

Returnstrue ifpoint is located above the plane.

• Planenormalized()

Returns a copy of the plane, normalized.

• Vector3project(Vector3 point)

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