Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

Plane¶

A plane in Hessian normal form.

Description¶

Represents a normalized plane equation. 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 documentation index

Properties¶

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

Constructors¶

Plane	Plane ( )
Plane	Plane ( Plane from )
Plane	Plane ( float a, float b, float c, float d )
Plane	Plane ( Vector3 normal )
Plane	Plane ( Vector3 normal, float d )
Plane	Plane ( Vector3 normal, Vector3 point )
Plane	Plane ( Vector3 point1, Vector3 point2, Vector3 point3 )

Methods¶

float	distance_to ( Vector3 point ) const
Vector3	get_center ( ) const
bool	has_point ( Vector3 point, float tolerance=1e-05 ) const
Variant	intersect_3 ( Plane b, Plane c ) const
Variant	intersects_ray ( Vector3 from, Vector3 dir ) const
Variant	intersects_segment ( Vector3 from, Vector3 to ) const
bool	is_equal_approx ( Plane to_plane ) const
bool	is_finite ( ) const
bool	is_point_over ( Vector3 point ) const
Plane	normalized ( ) const
Vector3	project ( Vector3 point ) const

Operators¶

bool	operator != ( Plane right )
Plane	operator * ( Transform3D right )
bool	operator == ( Plane right )
Plane	operator unary+ ( )
Plane	operator unary- ( )

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).