pub struct NavMeshes(/* private fields */);
Expand description

ECS resource that holds and manages nav meshes.

Implementations§

source§

impl NavMeshes

source

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

Register new nav mesh.

Arguments
  • mesh - nav mesh object.
Returns

Identifier of registered nav mesh.

source

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.

source

pub fn unregister_all(&mut self)

Unregister all nav meshes.

source

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

Get nav meshes iterator.

source

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.

source

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.

source

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§

source§

impl Debug for NavMeshes

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for NavMeshes

source§

fn default() -> NavMeshes

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Finalize for T

§

unsafe fn finalize_raw(data: *mut ())

Safety Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Initialize for Twhere T: Default,

§

fn initialize(&mut self)

§

unsafe fn initialize_raw(data: *mut ())

Safety Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
§

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

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Component for Twhere T: Send + Sync + 'static,