Struct gdnative::api::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 a reference-only type. Persistent references can only exist in the unsafe Ref<Node2D> form.

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 Ptr::free, or Ptr::queue_free if it is a Node.

Class hierarchy

Node2D inherits methods from:

• CanvasItem
• Node
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl Node2D

pub fn new() -> Ref<Node2D, Unique>

Creates a new instance of this object.

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 Ptr::free, or preferably Ptr::queue_free if it is a Node.

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

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

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

pub fn global_rotation(&self) -> f64

pub fn global_rotation_degrees(&self) -> f64

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

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

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

pub fn rotation(&self) -> f64

pub fn rotation_degrees(&self) -> f64

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

pub fn z_index(&self) -> i64

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

pub fn is_z_relative(&self) -> bool

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

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

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

pub fn rotate(&self, radians: f64)

pub fn set_global_position(&self, position: Vector2D<f32, UnknownUnit>)

pub fn set_global_rotation(&self, radians: f64)

pub fn set_global_rotation_degrees(&self, degrees: f64)

pub fn set_global_scale(&self, scale: Vector2D<f32, UnknownUnit>)

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

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

pub fn set_rotation(&self, radians: f64)

pub fn set_rotation_degrees(&self, degrees: f64)

pub fn set_scale(&self, scale: Vector2D<f32, UnknownUnit>)

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

pub fn set_z_as_relative(&self, enable: bool)

pub fn set_z_index(&self, z_index: i64)

pub fn to_global(
    &self,
    local_point: Vector2D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

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

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

Methods from Deref<Target = CanvasItem>

pub const BLEND_MODE_ADD: i64

pub const BLEND_MODE_DISABLED: i64

pub const BLEND_MODE_MIX: i64

pub const BLEND_MODE_MUL: i64

pub const BLEND_MODE_PREMULT_ALPHA: i64

pub const BLEND_MODE_SUB: i64

pub const NOTIFICATION_DRAW: i64

pub const NOTIFICATION_ENTER_CANVAS: i64

pub const NOTIFICATION_EXIT_CANVAS: i64

pub const NOTIFICATION_TRANSFORM_CHANGED: i64

pub const NOTIFICATION_VISIBILITY_CHANGED: i64

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

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

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

pub fn draw_colored_polygon(
    &self,
    points: TypedArray<Vector2D<f32, UnknownUnit>>,
    color: Color,
    uvs: TypedArray<Vector2D<f32, UnknownUnit>>,
    texture: impl AsArg<Texture>,
    normal_map: impl AsArg<Texture>,
    antialiased: bool
)

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

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

pub fn draw_multiline(
    &self,
    points: TypedArray<Vector2D<f32, UnknownUnit>>,
    color: Color,
    width: f64,
    antialiased: bool
)

pub fn draw_multiline_colors(
    &self,
    points: TypedArray<Vector2D<f32, UnknownUnit>>,
    colors: TypedArray<Color>,
    width: f64,
    antialiased: bool
)

pub fn draw_multimesh(
    &self,
    multimesh: impl AsArg<MultiMesh>,
    texture: impl AsArg<Texture>,
    normal_map: impl AsArg<Texture>
)

pub fn draw_polygon(
    &self,
    points: TypedArray<Vector2D<f32, UnknownUnit>>,
    colors: TypedArray<Color>,
    uvs: TypedArray<Vector2D<f32, UnknownUnit>>,
    texture: impl AsArg<Texture>,
    normal_map: impl AsArg<Texture>,
    antialiased: bool
)

pub fn draw_polyline(
    &self,
    points: TypedArray<Vector2D<f32, UnknownUnit>>,
    color: Color,
    width: f64,
    antialiased: bool
)

pub fn draw_polyline_colors(
    &self,
    points: TypedArray<Vector2D<f32, UnknownUnit>>,
    colors: TypedArray<Color>,
    width: f64,
    antialiased: bool
)

pub fn draw_primitive(
    &self,
    points: TypedArray<Vector2D<f32, UnknownUnit>>,
    colors: TypedArray<Color>,
    uvs: TypedArray<Vector2D<f32, UnknownUnit>>,
    texture: impl AsArg<Texture>,
    width: f64,
    normal_map: impl AsArg<Texture>
)

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

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

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

pub fn draw_string(
    &self,
    font: impl AsArg<Font>,
    position: Vector2D<f32, UnknownUnit>,
    text: impl Into<GodotString>,
    modulate: Color,
    clip_w: i64
)

pub fn draw_style_box(
    &self,
    style_box: impl AsArg<StyleBox>,
    rect: Rect<f32, UnknownUnit>
)

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

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

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

pub fn force_update_transform(&self)

pub fn get_canvas(&self) -> Rid

pub fn get_canvas_item(&self) -> Rid

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

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

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

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

pub fn light_mask(&self) -> i64

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

pub fn material(&self) -> Option<Ref<Material, Shared>>

pub fn modulate(&self) -> Color

pub fn self_modulate(&self) -> Color

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

pub fn use_parent_material(&self) -> bool

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

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

pub fn get_world_2d(&self) -> Option<Ref<World2D, Shared>>

pub fn hide(&self)

pub fn is_draw_behind_parent_enabled(&self) -> bool

pub fn is_local_transform_notification_enabled(&self) -> bool

pub fn is_set_as_toplevel(&self) -> bool

pub fn is_transform_notification_enabled(&self) -> bool

pub fn is_visible(&self) -> bool

pub fn is_visible_in_tree(&self) -> bool

pub fn make_canvas_position_local(
    &self,
    screen_point: Vector2D<f32, UnknownUnit>
) -> Vector2D<f32, UnknownUnit>

pub fn make_input_local(
    &self,
    event: impl AsArg<InputEvent>
) -> Option<Ref<InputEvent, Shared>>

pub fn set_as_toplevel(&self, enable: bool)

pub fn set_draw_behind_parent(&self, enable: bool)

pub fn set_light_mask(&self, light_mask: i64)

pub fn set_material(&self, material: impl AsArg<Material>)

pub fn set_modulate(&self, modulate: Color)

pub fn set_notify_local_transform(&self, enable: bool)

pub fn set_notify_transform(&self, enable: bool)

pub fn set_self_modulate(&self, self_modulate: Color)

pub fn set_use_parent_material(&self, enable: bool)

pub fn set_visible(&self, visible: bool)

pub fn show(&self)

pub fn update(&self)

Trait Implementations

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 GodotObject for Node2D

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for Node2D

fn construct() -> Ref<Node2D, Unique>

impl QueueFree for Node2D

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for Node2D

impl SubClass<Node> for Node2D

impl SubClass<Node2D> for DampedSpringJoint2D

impl SubClass<Node2D> for TouchScreenButton

impl SubClass<Node2D> for NavigationPolygonInstance

impl SubClass<Node2D> for Line2D

impl SubClass<Node2D> for PinJoint2D

impl SubClass<Node2D> for Bone2D

impl SubClass<Node2D> for CPUParticles2D

impl SubClass<Node2D> for CollisionShape2D

impl SubClass<Node2D> for AudioStreamPlayer2D

impl SubClass<Node2D> for BackBufferCopy

impl SubClass<Node2D> for RemoteTransform2D

impl SubClass<Node2D> for ParallaxLayer

impl SubClass<Node2D> for AnimatedSprite

impl SubClass<Node2D> for Camera2D

impl SubClass<Node2D> for Skeleton2D

impl SubClass<Node2D> for TileMap

impl SubClass<Node2D> for CollisionObject2D

impl SubClass<Node2D> for Joint2D

impl SubClass<Node2D> for PhysicsBody2D

impl SubClass<Node2D> for GrooveJoint2D

impl SubClass<Node2D> for Path2D

impl SubClass<Node2D> for RayCast2D

impl SubClass<Node2D> for CollisionPolygon2D

impl SubClass<Node2D> for YSort

impl SubClass<Node2D> for KinematicBody2D

impl SubClass<Node2D> for Particles2D

impl SubClass<Node2D> for Sprite

impl SubClass<Node2D> for VisibilityNotifier2D

impl SubClass<Node2D> for Light2D

impl SubClass<Node2D> for LightOccluder2D

impl SubClass<Node2D> for Navigation2D

impl SubClass<Node2D> for CanvasModulate

impl SubClass<Node2D> for Position2D

impl SubClass<Node2D> for VisibilityEnabler2D

impl SubClass<Node2D> for StaticBody2D

impl SubClass<Node2D> for Polygon2D

impl SubClass<Node2D> for RigidBody2D

impl SubClass<Node2D> for PathFollow2D

impl SubClass<Node2D> for MeshInstance2D

impl SubClass<Node2D> for MultiMeshInstance2D

impl SubClass<Node2D> for Area2D

impl SubClass<Object> for Node2D