Struct oxygengine_navigation::resource::NavMeshes

pub struct NavMeshes(_);

ECS resource that holds and manages nav meshes.

Implementations

impl NavMeshes

pub fn register(&mut self, mesh: NavMesh) -> NavMeshID

Register new nav mesh.

Arguments

• mesh - nav mesh object.

Returns

Identifier of registered nav mesh.

pub fn unregister(&mut self, id: NavMeshID) -> Option<NavMesh>

Unregister nav mesh.

Arguments

• id - nav mesh identifier.

Returns

Some with nav mesh object if nav mesh with given identifier was found, None otherwise.

pub fn unregister_all(&mut self)

Unregister all nav meshes.

pub fn meshes_iter(&self) -> impl Iterator<Item = &NavMesh>

Get nav meshes iterator.

pub fn find_mesh(&self, id: NavMeshID) -> Option<&NavMesh>

Find nav mesh by its identifier.

Arguments

• id - nav mesh identifier.

Returns

Some with nav mesh if exists or None otherwise.

pub fn find_mesh_mut(&mut self, id: NavMeshID) -> Option<&mut NavMesh>

Find nav mesh by its identifier.

Arguments

• id - nav mesh identifier.

Returns

Some with mutable nav mesh if exists or None otherwise.

pub fn closest_point(
    &self,
    point: NavVec3,
    query: NavQuery
) -> Option<(NavMeshID, NavVec3)>

Find closest point on nav meshes.

Arguments

• point - query point.
• query - query quality.

Returns

Some with nav mesh identifier and point on nav mesh if found or None otherwise.

Trait Implementations

impl Debug for NavMeshes

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for NavMeshes

fn default() -> NavMeshes

Returns the “default value” for a type.