API reference

PlaneSurface Class

Extends MonoBehaviour, ISurface, IBounds

Member Enumerations

Enumeration NormalFacing

Used for interaction with flat surfaces, and acts in much the same way as Unity’s Plane.
Backward
Normal faces along the transform's negative Z axis.
Forward
Normal faces along the transform's positive Z axis.

Properties

NormalFacing Facing[Get]
bool DoubleSided[Get]
Vector3 Normal[Get]
Transform Transform[Get]
A transform for the surface.
Bounds Bounds[Get]
The world space axis-aligned bounding box (AABB)

Member Functions

bool ClosestSurfacePoint
( in Vector3 point,
out SurfaceHit hit,
float maxDistance )
Find nearest point to surface.
Parameters
ray
Point to check
hit
The returned hit data
maxDistance
If greater than zero, maximum distance of check
Returns
true if nearest point was found
bool Raycast
( in Ray ray,
out SurfaceHit hit,
float maxDistance )
Raycast to the surface with an optional maximum distance value.
Parameters
ray
The ray to cast
hit
The returned hit data
maxDistance
If greater than zero, maximum distance of raycast
Returns
true if surface was hit
Plane GetPlane ( )
void InjectAllPlaneSurface
( NormalFacing facing,
bool doubleSided )
void InjectNormalFacing
( NormalFacing facing )
void InjectDoubleSided
( bool doubleSided )
Nav Logo
English (US)
© 2026 Meta