API reference

CircleSurface Class

Extends MonoBehaviour, ISurfacePatch
Used for interaction with circular surfaces.
Computes the closest world point on a coordinate plane defined by the X and Y axes of the transform, within a provided radius from the transform’s origin.

Properties

Transform Transform[Get]
A transform for the surface.
ISurface BackingSurface[Get]
A surface patch is defined as an portion of this underlying surface.

Protected Functions

virtual void Start ( )

Member Functions

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
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
void InjectAllCircleProximityField
( PlaneSurface planeSurface )
void InjectPlaneSurface
( PlaneSurface planeSurface )
void InjectOptionalRadius
( float radius )
Nav Logo
English (US)
© 2026 Meta