SceneNavigation#

PlushEngine · Type index

Namespace: PlushEngine.Navigation (using PlushEngine.Navigation;)

A scene's static 3D navigation queries. Use on the scene thread; queries never move objects or bake data.

public sealed class SceneNavigation

Members: FindPath · IsAvailable · Profile · QueryCount · TrySamplePosition

FindPath#

public NavigationPath FindPath(Vector3 start, Vector3 destination, float projectionDistance = .5f);

Finds a complete walking route, projecting endpoints within projectionDistance metres on each axis (0.5 by default). Disconnected or exhausted searches return an explicit failure and no followable points.

IsAvailable#

public bool IsAvailable { get; }

Whether the scene has baked data whose static collision sources have not changed.

Profile#

public NavigationProfile? Profile { get; }

The baked capsule profile, or null when this scene has no navigation.

QueryCount#

public int QueryCount { get; }

Number of path searches made in this scene, for diagnostics.

TrySamplePosition#

public bool TrySamplePosition(Vector3 point, Vector3 halfExtents, out Vector3 position);

Finds the nearest surface inside world-space halfExtents around point. False when no surface is in those bounds.

Related types#

NavigationPath · NavigationProfile

Source#

• SceneNavigation.cs