Struct gdnative_bindings::Navigation

pub struct Navigation { /* fields omitted */ }

core class Navigation inherits Spatial (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

Navigation is an unsafe pointer, and all of its methods are unsafe.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Navigation::free.

Class hierarchy

Navigation inherits methods from:

• Spatial
• Node
• Object

Methods

impl Navigation

pub fn new() -> Self

Constructor.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed. Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Navigation::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn get_closest_point(&mut self, to_point: Vector3) -> Vector3

pub unsafe fn get_closest_point_normal(&mut self, to_point: Vector3) -> Vector3

pub unsafe fn get_closest_point_owner(
    &mut self,
    to_point: Vector3
) -> Option<Object>

pub unsafe fn get_closest_point_to_segment(
    &mut self,
    start: Vector3,
    end: Vector3,
    use_collision: bool
) -> Vector3

pub unsafe fn get_simple_path(
    &mut self,
    start: Vector3,
    end: Vector3,
    optimize: bool
) -> Vector3Array

pub unsafe fn get_up_vector(&self) -> Vector3

pub unsafe fn navmesh_add(
    &mut self,
    mesh: Option<NavigationMesh>,
    xform: Transform,
    owner: Option<Object>
) -> i64

pub unsafe fn navmesh_remove(&mut self, id: i64)

pub unsafe fn navmesh_set_transform(&mut self, id: i64, xform: Transform)

pub unsafe fn set_up_vector(&mut self, up: Vector3)

pub unsafe fn to_spatial(&self) -> Spatial

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Methods from Deref<Target = Spatial>

pub const NOTIFICATION_ENTER_WORLD: i64

pub const NOTIFICATION_VISIBILITY_CHANGED: i64

pub const NOTIFICATION_TRANSFORM_CHANGED: i64

pub const NOTIFICATION_EXIT_WORLD: i64

pub unsafe fn _update_gizmo(&mut self)

pub unsafe fn force_update_transform(&mut self)

pub unsafe fn get_gizmo(&self) -> Option<SpatialGizmo>

pub unsafe fn get_global_transform(&self) -> Transform

pub unsafe fn get_parent_spatial(&self) -> Option<Spatial>

pub unsafe fn get_rotation(&self) -> Vector3

pub unsafe fn get_rotation_degrees(&self) -> Vector3

pub unsafe fn get_scale(&self) -> Vector3

pub unsafe fn get_transform(&self) -> Transform

pub unsafe fn get_translation(&self) -> Vector3

pub unsafe fn get_world(&self) -> Option<World>

pub unsafe fn global_rotate(&mut self, axis: Vector3, angle: f64)

pub unsafe fn global_scale(&mut self, scale: Vector3)

pub unsafe fn global_translate(&mut self, offset: Vector3)

pub unsafe fn hide(&mut self)

pub unsafe fn is_local_transform_notification_enabled(&self) -> bool

pub unsafe fn is_scale_disabled(&self) -> bool

pub unsafe fn is_set_as_toplevel(&self) -> bool

pub unsafe fn is_transform_notification_enabled(&self) -> bool

pub unsafe fn is_visible(&self) -> bool

pub unsafe fn is_visible_in_tree(&self) -> bool

pub unsafe fn look_at(&mut self, target: Vector3, up: Vector3)

pub unsafe fn look_at_from_position(
    &mut self,
    position: Vector3,
    target: Vector3,
    up: Vector3
)

pub unsafe fn orthonormalize(&mut self)

pub unsafe fn rotate(&mut self, axis: Vector3, angle: f64)

pub unsafe fn rotate_object_local(&mut self, axis: Vector3, angle: f64)

pub unsafe fn rotate_x(&mut self, angle: f64)

pub unsafe fn rotate_y(&mut self, angle: f64)

pub unsafe fn rotate_z(&mut self, angle: f64)

pub unsafe fn scale_object_local(&mut self, scale: Vector3)

pub unsafe fn set_as_toplevel(&mut self, enable: bool)

pub unsafe fn set_disable_scale(&mut self, disable: bool)

pub unsafe fn set_gizmo(&mut self, gizmo: Option<SpatialGizmo>)

pub unsafe fn set_global_transform(&mut self, global: Transform)

pub unsafe fn set_identity(&mut self)

pub unsafe fn set_ignore_transform_notification(&mut self, enabled: bool)

pub unsafe fn set_notify_local_transform(&mut self, enable: bool)

pub unsafe fn set_notify_transform(&mut self, enable: bool)

pub unsafe fn set_rotation(&mut self, euler: Vector3)

pub unsafe fn set_rotation_degrees(&mut self, euler_degrees: Vector3)

pub unsafe fn set_scale(&mut self, scale: Vector3)

pub unsafe fn set_transform(&mut self, local: Transform)

pub unsafe fn set_translation(&mut self, translation: Vector3)

pub unsafe fn set_visible(&mut self, visible: bool)

pub unsafe fn show(&mut self)

pub unsafe fn to_global(&self, local_point: Vector3) -> Vector3

pub unsafe fn to_local(&self, global_point: Vector3) -> Vector3

pub unsafe fn translate(&mut self, offset: Vector3)

pub unsafe fn translate_object_local(&mut self, offset: Vector3)

pub unsafe fn update_gizmo(&mut self)

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Clone for Navigation

fn clone(&self) -> Navigation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Navigation

impl Debug for Navigation

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

Formats the value using the given formatter.

impl Deref for Navigation

type Target = Spatial

The resulting type after dereferencing.

fn deref(&self) -> &Spatial

Dereferences the value.

impl DerefMut for Navigation

fn deref_mut(&mut self) -> &mut Spatial

Mutably dereferences the value.

impl Free for Navigation

unsafe fn godot_free(self)

impl FromVariant for Navigation

fn from_variant(variant: &Variant) -> Option<Self>

impl GodotObject for Navigation

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

unsafe fn to_sys(&self) -> *mut godot_object

impl Instanciable for Navigation

fn construct() -> Self

impl QueueFree for Navigation

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Navigation

fn to_variant(&self) -> Variant