Struct gdnative_bindings::Navigation2D

pub struct Navigation2D { /* fields omitted */ }

core class Navigation2D inherits Node2D (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.

Navigation2D 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 Navigation2D::free.

Class hierarchy

Navigation2D inherits methods from:

• Node2D
• CanvasItem
• Node
• Object

Methods

impl Navigation2D

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 Navigation2D::free.

pub unsafe fn free(self)

Manually deallocate the object.

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

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

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

pub unsafe fn navpoly_add(
    &mut self,
    mesh: Option<NavigationPolygon>,
    xform: Transform2D,
    owner: Option<Object>
) -> i64

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

pub unsafe fn navpoly_set_transform(&mut self, id: i64, xform: Transform2D)

pub unsafe fn to_node_2d(&self) -> Node2D

Up-cast.

pub unsafe fn to_canvas_item(&self) -> CanvasItem

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 = Node2D>

pub unsafe fn apply_scale(&mut self, ratio: Vector2)

pub unsafe fn get_angle_to(&self, point: Vector2) -> f64

pub unsafe fn get_global_position(&self) -> Vector2

pub unsafe fn get_global_rotation(&self) -> f64

pub unsafe fn get_global_rotation_degrees(&self) -> f64

pub unsafe fn get_global_scale(&self) -> Vector2

pub unsafe fn get_position(&self) -> Vector2

pub unsafe fn get_relative_transform_to_parent(
    &self,
    parent: Option<Node>
) -> Transform2D

pub unsafe fn get_rotation(&self) -> f64

pub unsafe fn get_rotation_degrees(&self) -> f64

pub unsafe fn get_scale(&self) -> Vector2

pub unsafe fn get_z_index(&self) -> i64

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

pub unsafe fn is_z_relative(&self) -> bool

pub unsafe fn look_at(&mut self, point: Vector2)

pub unsafe fn move_local_x(&mut self, delta: f64, scaled: bool)

pub unsafe fn move_local_y(&mut self, delta: f64, scaled: bool)

pub unsafe fn rotate(&mut self, radians: f64)

pub unsafe fn set_global_position(&mut self, position: Vector2)

pub unsafe fn set_global_rotation(&mut self, radians: f64)

pub unsafe fn set_global_rotation_degrees(&mut self, degrees: f64)

pub unsafe fn set_global_scale(&mut self, scale: Vector2)

pub unsafe fn set_global_transform(&mut self, xform: Transform2D)

pub unsafe fn set_position(&mut self, position: Vector2)

pub unsafe fn set_rotation(&mut self, radians: f64)

pub unsafe fn set_rotation_degrees(&mut self, degrees: f64)

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

pub unsafe fn set_transform(&mut self, xform: Transform2D)

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

pub unsafe fn set_z_index(&mut self, z_index: i64)

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

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

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

pub unsafe fn to_canvas_item(&self) -> CanvasItem

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.

Trait Implementations

impl Clone for Navigation2D

fn clone(&self) -> Navigation2D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Navigation2D

impl Debug for Navigation2D

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

Formats the value using the given formatter.

impl Deref for Navigation2D

type Target = Node2D

The resulting type after dereferencing.

fn deref(&self) -> &Node2D

Dereferences the value.

impl DerefMut for Navigation2D

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

Mutably dereferences the value.

impl Free for Navigation2D

unsafe fn godot_free(self)

impl FromVariant for Navigation2D

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

impl GodotObject for Navigation2D

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 Navigation2D

fn construct() -> Self

impl QueueFree for Navigation2D

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Navigation2D

fn to_variant(&self) -> Variant