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

pub struct NavMeshesRes(_);

Expand description

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]

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

Formats the value using the given formatter. Read more

impl Default for NavMeshesRes[src]

fn default() -> NavMeshesRes[src]

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

Auto Trait Implementations

impl RefUnwindSafe for NavMeshesRes

impl Send for NavMeshesRes

impl Sync for NavMeshesRes

impl Unpin for NavMeshesRes

impl UnwindSafe for NavMeshesRes

Blanket Implementations

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

[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

pub fn get_type_id(&self) -> TypeId

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

[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

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

pub fn from(t: T) -> T[src]

Performs the conversion.

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

[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

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

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

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

pub fn is_in_subset(&self) -> bool

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

pub unsafe fn to_subset_unchecked(&self) -> SS

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

pub fn from_subset(element: &SS) -> SP

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

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

pub fn try_default() -> Result<T, String>

Tries to create the default.

fn unwrap_default() -> Self

Calls try_default and panics on an error case.

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.

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

Performs the conversion.

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.

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

Performs the conversion.

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

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