Struct gdnative::PathFollow2D

pub struct PathFollow2D { /* fields omitted */ }

core class PathFollow2D 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.

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

Class hierarchy

PathFollow2D inherits methods from:

• Node2D
• CanvasItem
• Node
• Object

Methods

impl PathFollow2D

pub fn new() -> PathFollow2D

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn get_cubic_interpolation(&self) -> bool

pub unsafe fn get_h_offset(&self) -> f64

pub unsafe fn get_lookahead(&self) -> f64

pub unsafe fn get_offset(&self) -> f64

pub unsafe fn get_unit_offset(&self) -> f64

pub unsafe fn get_v_offset(&self) -> f64

pub unsafe fn has_loop(&self) -> bool

pub unsafe fn is_rotating(&self) -> bool

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

pub unsafe fn set_h_offset(&mut self, h_offset: f64)

pub unsafe fn set_lookahead(&mut self, lookahead: f64)

pub unsafe fn set_loop(&mut self, _loop: bool)

pub unsafe fn set_offset(&mut self, offset: f64)

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

pub unsafe fn set_unit_offset(&mut self, unit_offset: f64)

pub unsafe fn set_v_offset(&mut self, v_offset: f64)

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>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Methods from Deref<Target = Node2D>

pub unsafe fn apply_scale(&mut self, ratio: Vector2D<f32, UnknownUnit>)

pub unsafe fn get_angle_to(&self, point: Vector2D<f32, UnknownUnit>) -> f64

pub unsafe fn get_global_position(&self) -> Vector2D<f32, UnknownUnit>

pub unsafe fn get_global_rotation(&self) -> f64

pub unsafe fn get_global_rotation_degrees(&self) -> f64

pub unsafe fn get_global_scale(&self) -> Vector2D<f32, UnknownUnit>

pub unsafe fn get_position(&self) -> Vector2D<f32, UnknownUnit>

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

pub unsafe fn get_rotation(&self) -> f64

pub unsafe fn get_rotation_degrees(&self) -> f64

pub unsafe fn get_scale(&self) -> Vector2D<f32, UnknownUnit>

pub unsafe fn get_z_index(&self) -> i64

pub unsafe fn global_translate(&mut self, offset: Vector2D<f32, UnknownUnit>)

pub unsafe fn is_z_relative(&self) -> bool

pub unsafe fn look_at(&mut self, point: Vector2D<f32, UnknownUnit>)

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: Vector2D<f32, UnknownUnit>
)

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: Vector2D<f32, UnknownUnit>)

pub unsafe fn set_global_transform(
    &mut self,
    xform: Transform2D<f32, UnknownUnit, UnknownUnit>
)

pub unsafe fn set_position(&mut self, position: Vector2D<f32, UnknownUnit>)

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: Vector2D<f32, UnknownUnit>)

pub unsafe fn set_transform(
    &mut self,
    xform: Transform2D<f32, UnknownUnit, UnknownUnit>
)

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: Vector2D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

pub unsafe fn to_local(
    &self,
    global_point: Vector2D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

pub unsafe fn translate(&mut self, offset: Vector2D<f32, UnknownUnit>)

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>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for PathFollow2D

fn clone(&self) -> PathFollow2D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PathFollow2D

impl Debug for PathFollow2D

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

Formats the value using the given formatter.

impl Deref for PathFollow2D

type Target = Node2D

The resulting type after dereferencing.

fn deref(&self) -> &Node2D

Dereferences the value.

impl DerefMut for PathFollow2D

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

Mutably dereferences the value.

impl Free for PathFollow2D

unsafe fn godot_free(self)

impl FromVariant for PathFollow2D

fn from_variant(variant: &Variant) -> Result<PathFollow2D, FromVariantError>

impl GodotObject for PathFollow2D

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> PathFollow2D

unsafe fn from_return_position_sys(obj: *mut c_void) -> PathFollow2D

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

impl Instanciable for PathFollow2D

fn construct() -> PathFollow2D

impl QueueFree for PathFollow2D

unsafe fn godot_queue_free(&mut self)

impl ToVariant for PathFollow2D

fn to_variant(&self) -> Variant