Struct gdnative::Node2D

pub struct Node2D { /* fields omitted */ }

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

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

Class hierarchy

Node2D inherits methods from:

• CanvasItem
• Node
• Object

Methods

impl Node2D

pub fn new() -> Node2D

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

pub unsafe fn free(self)

Manually deallocate the object.

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.

Methods from Deref<Target = CanvasItem>

pub const BLEND_MODE_ADD: i64

pub const BLEND_MODE_MUL: i64

pub const BLEND_MODE_MIX: i64

pub const BLEND_MODE_DISABLED: i64

pub const NOTIFICATION_ENTER_CANVAS: i64

pub const NOTIFICATION_TRANSFORM_CHANGED: i64

pub const BLEND_MODE_SUB: i64

pub const BLEND_MODE_PREMULT_ALPHA: i64

pub const NOTIFICATION_EXIT_CANVAS: i64

pub const NOTIFICATION_VISIBILITY_CHANGED: i64

pub const NOTIFICATION_DRAW: i64

pub unsafe fn _draw(&mut self)

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

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

pub unsafe fn _edit_get_rect(&self) -> Rect<f32, UnknownUnit>

pub unsafe fn _edit_get_rotation(&self) -> f64

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

pub unsafe fn _edit_get_state(&self) -> Dictionary

pub unsafe fn _edit_get_transform(
    &self
) -> Transform2D<f32, UnknownUnit, UnknownUnit>

pub unsafe fn _edit_set_pivot(&mut self, pivot: Vector2D<f32, UnknownUnit>)

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

pub unsafe fn _edit_set_rect(&mut self, rect: Rect<f32, UnknownUnit>)

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

pub unsafe fn _edit_set_scale(&mut self, scale: Vector2D<f32, UnknownUnit>)

pub unsafe fn _edit_set_state(&mut self, state: Dictionary)

pub unsafe fn _edit_use_pivot(&self) -> bool

pub unsafe fn _edit_use_rect(&self) -> bool

pub unsafe fn _edit_use_rotation(&self) -> bool

pub unsafe fn _is_on_top(&self) -> bool

pub unsafe fn _set_on_top(&mut self, on_top: bool)

pub unsafe fn _toplevel_raise_self(&mut self)

pub unsafe fn _update_callback(&mut self)

pub unsafe fn draw_arc(
    &mut self,
    center: Vector2D<f32, UnknownUnit>,
    radius: f64,
    start_angle: f64,
    end_angle: f64,
    point_count: i64,
    color: Color,
    width: f64,
    antialiased: bool
)

pub unsafe fn draw_char(
    &mut self,
    font: Option<Font>,
    position: Vector2D<f32, UnknownUnit>,
    char: GodotString,
    next: GodotString,
    modulate: Color
) -> f64

pub unsafe fn draw_circle(
    &mut self,
    position: Vector2D<f32, UnknownUnit>,
    radius: f64,
    color: Color
)

pub unsafe fn draw_colored_polygon(
    &mut self,
    points: Vector2Array,
    color: Color,
    uvs: Vector2Array,
    texture: Option<Texture>,
    normal_map: Option<Texture>,
    antialiased: bool
)

pub unsafe fn draw_line(
    &mut self,
    from: Vector2D<f32, UnknownUnit>,
    to: Vector2D<f32, UnknownUnit>,
    color: Color,
    width: f64,
    antialiased: bool
)

pub unsafe fn draw_mesh(
    &mut self,
    mesh: Option<Mesh>,
    texture: Option<Texture>,
    normal_map: Option<Texture>,
    transform: Transform2D<f32, UnknownUnit, UnknownUnit>,
    modulate: Color
)

pub unsafe fn draw_multiline(
    &mut self,
    points: Vector2Array,
    color: Color,
    width: f64,
    antialiased: bool
)

pub unsafe fn draw_multiline_colors(
    &mut self,
    points: Vector2Array,
    colors: ColorArray,
    width: f64,
    antialiased: bool
)

pub unsafe fn draw_multimesh(
    &mut self,
    multimesh: Option<MultiMesh>,
    texture: Option<Texture>,
    normal_map: Option<Texture>
)

pub unsafe fn draw_polygon(
    &mut self,
    points: Vector2Array,
    colors: ColorArray,
    uvs: Vector2Array,
    texture: Option<Texture>,
    normal_map: Option<Texture>,
    antialiased: bool
)

pub unsafe fn draw_polyline(
    &mut self,
    points: Vector2Array,
    color: Color,
    width: f64,
    antialiased: bool
)

pub unsafe fn draw_polyline_colors(
    &mut self,
    points: Vector2Array,
    colors: ColorArray,
    width: f64,
    antialiased: bool
)

pub unsafe fn draw_primitive(
    &mut self,
    points: Vector2Array,
    colors: ColorArray,
    uvs: Vector2Array,
    texture: Option<Texture>,
    width: f64,
    normal_map: Option<Texture>
)

pub unsafe fn draw_rect(
    &mut self,
    rect: Rect<f32, UnknownUnit>,
    color: Color,
    filled: bool,
    width: f64,
    antialiased: bool
)

pub unsafe fn draw_set_transform(
    &mut self,
    position: Vector2D<f32, UnknownUnit>,
    rotation: f64,
    scale: Vector2D<f32, UnknownUnit>
)

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

pub unsafe fn draw_string(
    &mut self,
    font: Option<Font>,
    position: Vector2D<f32, UnknownUnit>,
    text: GodotString,
    modulate: Color,
    clip_w: i64
)

pub unsafe fn draw_style_box(
    &mut self,
    style_box: Option<StyleBox>,
    rect: Rect<f32, UnknownUnit>
)

pub unsafe fn draw_texture(
    &mut self,
    texture: Option<Texture>,
    position: Vector2D<f32, UnknownUnit>,
    modulate: Color,
    normal_map: Option<Texture>
)

pub unsafe fn draw_texture_rect(
    &mut self,
    texture: Option<Texture>,
    rect: Rect<f32, UnknownUnit>,
    tile: bool,
    modulate: Color,
    transpose: bool,
    normal_map: Option<Texture>
)

pub unsafe fn draw_texture_rect_region(
    &mut self,
    texture: Option<Texture>,
    rect: Rect<f32, UnknownUnit>,
    src_rect: Rect<f32, UnknownUnit>,
    modulate: Color,
    transpose: bool,
    normal_map: Option<Texture>,
    clip_uv: bool
)

pub unsafe fn force_update_transform(&mut self)

pub unsafe fn get_canvas(&self) -> Rid

pub unsafe fn get_canvas_item(&self) -> Rid

pub unsafe fn get_canvas_transform(
    &self
) -> Transform2D<f32, UnknownUnit, UnknownUnit>

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

pub unsafe fn get_global_transform(
    &self
) -> Transform2D<f32, UnknownUnit, UnknownUnit>

pub unsafe fn get_global_transform_with_canvas(
    &self
) -> Transform2D<f32, UnknownUnit, UnknownUnit>

pub unsafe fn get_light_mask(&self) -> i64

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

pub unsafe fn get_material(&self) -> Option<Material>

pub unsafe fn get_modulate(&self) -> Color

pub unsafe fn get_self_modulate(&self) -> Color

pub unsafe fn get_transform(&self) -> Transform2D<f32, UnknownUnit, UnknownUnit>

pub unsafe fn get_use_parent_material(&self) -> bool

pub unsafe fn get_viewport_rect(&self) -> Rect<f32, UnknownUnit>

pub unsafe fn get_viewport_transform(
    &self
) -> Transform2D<f32, UnknownUnit, UnknownUnit>

pub unsafe fn get_world_2d(&self) -> Option<World2D>

pub unsafe fn hide(&mut self)

pub unsafe fn is_draw_behind_parent_enabled(&self) -> bool

pub unsafe fn is_local_transform_notification_enabled(&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 make_canvas_position_local(
    &self,
    screen_point: Vector2D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

pub unsafe fn make_input_local(
    &self,
    event: Option<InputEvent>
) -> Option<InputEvent>

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

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

pub unsafe fn set_light_mask(&mut self, light_mask: i64)

pub unsafe fn set_material(&mut self, material: Option<Material>)

pub unsafe fn set_modulate(&mut self, modulate: Color)

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_self_modulate(&mut self, self_modulate: Color)

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

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

pub unsafe fn show(&mut self)

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

Generic dynamic cast.

Trait Implementations

impl Clone for Node2D

fn clone(&self) -> Node2D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Node2D

impl Debug for Node2D

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

Formats the value using the given formatter.

impl Deref for Node2D

type Target = CanvasItem

The resulting type after dereferencing.

fn deref(&self) -> &CanvasItem

Dereferences the value.

impl DerefMut for Node2D

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

Mutably dereferences the value.

impl Free for Node2D

unsafe fn godot_free(self)

impl FromVariant for Node2D

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

impl GodotObject for Node2D

fn class_name() -> &'static str

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

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

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

impl Instanciable for Node2D

fn construct() -> Node2D

impl QueueFree for Node2D

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Node2D

fn to_variant(&self) -> Variant