Struct oxygengine_navigation::resource::NavMeshesRes[−][src]

pub struct NavMeshesRes(_);

ECS resource that holds and manages nav meshes.

Implementations

impl NavMeshesRes[src]

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

Register new nav mesh.

Arguments

  • mesh - nav mesh object.

Returns

Identifier of registered nav mesh.

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

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)[src]

Unregister all nav meshes.

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

Get nav meshes iterator.

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

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>[src]

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)>[src]

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 NavMeshesRes[src]

impl Default for NavMeshesRes[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Any for T where
    T: Any, 

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> Event for T where
    T: Send + Sync + 'static, 

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T> Resource for T where
    T: Any, 

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 

impl<T> TryDefault for T where
    T: Default, 

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.