Struct gdnative_bindings_lily::node_2d::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. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

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

pub fn apply_scale(&self, ratio: Vector2)

Multiplies the current scale by the ratio vector.

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

Returns the angle between the node and the point in radians.

pub fn global_position(&self) -> Vector2

Global position.

pub fn global_rotation(&self) -> f64

Global rotation in radians.

pub fn global_rotation_degrees(&self) -> f64

Global rotation in degrees.

pub fn global_scale(&self) -> Vector2

Global scale.

pub fn position(&self) -> Vector2

Position, relative to the node’s parent.

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

Returns the Transform2D relative to this node’s parent.

pub fn rotation(&self) -> f64

Rotation in radians, relative to the node’s parent.

pub fn rotation_degrees(&self) -> f64

Rotation in degrees, relative to the node’s parent.

pub fn scale(&self) -> Vector2

The node’s scale. Unscaled value: (1, 1).

pub fn z_index(&self) -> i64

Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others.

pub fn global_translate(&self, offset: Vector2)

Adds the offset vector to the node’s global position.

pub fn is_z_relative(&self) -> bool

If true, the node’s Z index is relative to its parent’s Z index. If this node’s Z index is 2 and its parent’s effective Z index is 3, then this node’s effective Z index will be 2 + 3 = 5.

pub fn look_at(&self, point: Vector2)

Rotates the node so it points towards the point, which is expected to use global coordinates.

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

Applies a local translation on the node’s X axis based on the [method Node._process]’s delta. If scaled is false, normalizes the movement.

Default Arguments

• scaled - false

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

Applies a local translation on the node’s Y axis based on the [method Node._process]’s delta. If scaled is false, normalizes the movement.

Default Arguments

• scaled - false

pub fn rotate(&self, radians: f64)

Applies a rotation to the node, in radians, starting from its current rotation.

pub fn set_global_position(&self, position: Vector2)

Global position.

pub fn set_global_rotation(&self, radians: f64)

Global rotation in radians.

pub fn set_global_rotation_degrees(&self, degrees: f64)

Global rotation in degrees.

pub fn set_global_scale(&self, scale: Vector2)

Global scale.

pub fn set_global_transform(&self, xform: Transform2D)

Global Transform2D.

pub fn set_position(&self, position: Vector2)

Position, relative to the node’s parent.

pub fn set_rotation(&self, radians: f64)

Rotation in radians, relative to the node’s parent.

pub fn set_rotation_degrees(&self, degrees: f64)

Rotation in degrees, relative to the node’s parent.

pub fn set_scale(&self, scale: Vector2)

The node’s scale. Unscaled value: (1, 1).

pub fn set_transform(&self, xform: Transform2D)

Local Transform2D.

pub fn set_z_as_relative(&self, enable: bool)

If true, the node’s Z index is relative to its parent’s Z index. If this node’s Z index is 2 and its parent’s effective Z index is 3, then this node’s effective Z index will be 2 + 3 = 5.

pub fn set_z_index(&self, z_index: i64)

Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others.

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

Transforms the provided local position into a position in global coordinate space. The input is expected to be local relative to the Node2D it is called on. e.g. Applying this method to the positions of child nodes will correctly transform their positions into the global coordinate space, but applying it to a node’s own position will give an incorrect result, as it will incorporate the node’s own transformation into its global position.

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

Transforms the provided global position into a position in local coordinate space. The output will be local relative to the Node2D it is called on. e.g. It is appropriate for determining the positions of child nodes, but it is not appropriate for determining its own position relative to its parent.

pub fn translate(&self, offset: Vector2)

Translates the node by the given offset in local coordinates.

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: Vector2,
    radius: f64,
    start_angle: f64,
    end_angle: f64,
    point_count: i64,
    color: Color,
    width: f64,
    antialiased: bool
)

Draws an arc between the given angles. The larger the value of point_count, the smoother the curve.

Default Arguments

• width - 1.0
• antialiased - false

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

Draws a string character using a custom font. Returns the advance, depending on the character width and kerning with an optional next character.

Default Arguments

• modulate - Color( 1, 1, 1, 1 )

pub fn draw_circle(&self, position: Vector2, radius: f64, color: Color)

Draws a colored circle.

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

Draws a colored polygon of any amount of points, convex or concave.

Default Arguments

• uvs - PoolVector2Array( )
• texture - null
• normal_map - null
• antialiased - false

pub fn draw_line(
    &self,
    from: Vector2,
    to: Vector2,
    color: Color,
    width: f64,
    antialiased: bool
)

Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased.

Default Arguments

• width - 1.0
• antialiased - false

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

Draws a Mesh in 2D, using the provided texture. See MeshInstance2D for related documentation.

Default Arguments

• normal_map - null
• transform - Transform2D( 1, 0, 0, 1, 0, 0 )
• modulate - Color( 1, 1, 1, 1 )

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

Draws multiple, parallel lines with a uniform color. Note: width and antialiased are currently not implemented and have no effect.

Default Arguments

• width - 1.0
• antialiased - false

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

Draws multiple, parallel lines with a uniform width and segment-by-segment coloring. Colors assigned to line segments match by index between points and colors. Note: width and antialiased are currently not implemented and have no effect.

Default Arguments

• width - 1.0
• antialiased - false

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

Draws a MultiMesh in 2D with the provided texture. See MultiMeshInstance2D for related documentation.

Default Arguments

• normal_map - null

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

Draws a polygon of any amount of points, convex or concave.

Default Arguments

• uvs - PoolVector2Array( )
• texture - null
• normal_map - null
• antialiased - false

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

Draws interconnected line segments with a uniform color and width and optional antialiasing.

Default Arguments

• width - 1.0
• antialiased - false

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

Draws interconnected line segments with a uniform width, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between points and colors.

Default Arguments

• width - 1.0
• antialiased - false

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

Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.

Default Arguments

• texture - null
• width - 1.0
• normal_map - null

pub fn draw_rect(
    &self,
    rect: Rect2,
    color: Color,
    filled: bool,
    width: f64,
    antialiased: bool
)

Draws a rectangle. If filled is true, the rectangle will be filled with the color specified. If filled is false, the rectangle will be drawn as a stroke with the color and width specified. If antialiased is true, the lines will be antialiased. Note: width and antialiased are only effective if filled is false.

Default Arguments

• filled - true
• width - 1.0
• antialiased - false

pub fn draw_set_transform(
    &self,
    position: Vector2,
    rotation: f64,
    scale: Vector2
)

Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this.

pub fn draw_set_transform_matrix(&self, xform: Transform2D)

Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this.

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

Sample code is GDScript unless otherwise noted.

Draws text using the specified font at the position (top-left corner). The text will have its color multiplied by modulate. If clip_w is greater than or equal to 0, the text will be clipped if it exceeds the specified width. Example using the default project font:

# If using this method in a script that redraws constantly, move the
# `default_font` declaration to a member variable assigned in `_ready()`
# so the Control is only created once.
var default_font = Control.new().get_font("font")
draw_string(default_font, Vector2(64, 64), "Hello world")

See also [method Font.draw].

Default Arguments

• modulate - Color( 1, 1, 1, 1 )
• clip_w - -1

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

Draws a styled rectangle.

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

Draws a texture at a given position.

Default Arguments

• modulate - Color( 1, 1, 1, 1 )
• normal_map - null

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

Draws a textured rectangle at a given position, optionally modulated by a color. If transpose is true, the texture will have its X and Y coordinates swapped.

Default Arguments

• modulate - Color( 1, 1, 1, 1 )
• transpose - false
• normal_map - null

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

Draws a textured rectangle region at a given position, optionally modulated by a color. If transpose is true, the texture will have its X and Y coordinates swapped.

Default Arguments

• modulate - Color( 1, 1, 1, 1 )
• transpose - false
• normal_map - null
• clip_uv - true

pub fn force_update_transform(&self)

Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations.

pub fn get_canvas(&self) -> Rid

Returns the [RID] of the World2D canvas where this item is in.

pub fn get_canvas_item(&self) -> Rid

Returns the canvas item RID used by VisualServer for this item.

pub fn get_canvas_transform(&self) -> Transform2D

Returns the transform matrix of this item’s canvas.

pub fn get_global_mouse_position(&self) -> Vector2

Returns the global position of the mouse.

pub fn get_global_transform(&self) -> Transform2D

Returns the global transform matrix of this item.

pub fn get_global_transform_with_canvas(&self) -> Transform2D

Returns the global transform matrix of this item in relation to the canvas.

pub fn light_mask(&self) -> i64

The rendering layers in which this CanvasItem responds to Light2D nodes.

pub fn get_local_mouse_position(&self) -> Vector2

Returns the mouse position relative to this item’s position.

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

The material applied to textures on this CanvasItem.

pub fn modulate(&self) -> Color

The color applied to textures on this CanvasItem.

pub fn self_modulate(&self) -> Color

The color applied to textures on this CanvasItem. This is not inherited by children CanvasItems.

pub fn get_transform(&self) -> Transform2D

Returns the transform matrix of this item.

pub fn use_parent_material(&self) -> bool

If true, the parent CanvasItem’s [member material] property is used as this one’s material.

pub fn get_viewport_rect(&self) -> Rect2

Returns the viewport’s boundaries as a Rect2.

pub fn get_viewport_transform(&self) -> Transform2D

Returns this item’s transform in relation to the viewport.

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

Returns the World2D where this item is in.

pub fn hide(&self)

Hide the CanvasItem if it’s currently visible.

pub fn is_draw_behind_parent_enabled(&self) -> bool

If true, the object draws behind its parent.

pub fn is_local_transform_notification_enabled(&self) -> bool

Returns true if local transform notifications are communicated to children.

pub fn is_set_as_toplevel(&self) -> bool

Returns true if the node is set as top-level. See [method set_as_toplevel].

pub fn is_transform_notification_enabled(&self) -> bool

Returns true if global transform notifications are communicated to children.

pub fn is_visible(&self) -> bool

If true, this CanvasItem is drawn. The node is only visible if all of its antecedents are visible as well (in other words, [method is_visible_in_tree] must return true). Note: For controls that inherit Popup, the correct way to make them visible is to call one of the multiple popup*() functions instead.

pub fn is_visible_in_tree(&self) -> bool

Returns true if the node is present in the SceneTree, its [member visible] property is true and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree.

pub fn make_canvas_position_local(&self, screen_point: Vector2) -> Vector2

Assigns screen_point as this node’s new local transform.

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

Transformations issued by event’s inputs are applied in local space instead of global space.

pub fn set_as_toplevel(&self, enable: bool)

If enable is true, the node won’t inherit its transform from parent canvas items.

pub fn set_draw_behind_parent(&self, enable: bool)

If true, the object draws behind its parent.

pub fn set_light_mask(&self, light_mask: i64)

The rendering layers in which this CanvasItem responds to Light2D nodes.

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

The material applied to textures on this CanvasItem.

pub fn set_modulate(&self, modulate: Color)

The color applied to textures on this CanvasItem.

pub fn set_notify_local_transform(&self, enable: bool)

If enable is true, children will be updated with local transform data.

pub fn set_notify_transform(&self, enable: bool)

If enable is true, children will be updated with global transform data.

pub fn set_self_modulate(&self, self_modulate: Color)

The color applied to textures on this CanvasItem. This is not inherited by children CanvasItems.

pub fn set_use_parent_material(&self, enable: bool)

If true, the parent CanvasItem’s [member material] property is used as this one’s material.

pub fn set_visible(&self, visible: bool)

If true, this CanvasItem is drawn. The node is only visible if all of its antecedents are visible as well (in other words, [method is_visible_in_tree] must return true). Note: For controls that inherit Popup, the correct way to make them visible is to call one of the multiple popup*() functions instead.

pub fn show(&self)

Show the CanvasItem if it’s currently hidden. For controls that inherit Popup, the correct way to make them visible is to call one of the multiple popup*() functions instead.

pub fn update(&self)

Queue the CanvasItem for update. [constant NOTIFICATION_DRAW] will be called on idle time to request redraw.

Trait Implementations

impl Debug for Node2D

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

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.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl Instanciable for Node2D

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

impl QueueFree for Node2D

unsafe fn godot_queue_free(obj: *mut godot_object)

impl Sealed for Node2D

impl SubClass<CanvasItem> for Node2D

impl SubClass<Node> for Node2D

impl SubClass<Node2D> for VisibilityNotifier2D

impl SubClass<Node2D> for ParallaxLayer

impl SubClass<Node2D> for Camera2D

impl SubClass<Node2D> for VisibilityEnabler2D

impl SubClass<Node2D> for GrooveJoint2D

impl SubClass<Node2D> for Particles2D

impl SubClass<Node2D> for PhysicsBody2D

impl SubClass<Node2D> for NavigationPolygonInstance

impl SubClass<Node2D> for DampedSpringJoint2D

impl SubClass<Node2D> for CPUParticles2D

impl SubClass<Node2D> for Navigation2D

impl SubClass<Node2D> for Line2D

impl SubClass<Node2D> for KinematicBody2D

impl SubClass<Node2D> for TouchScreenButton

impl SubClass<Node2D> for PinJoint2D

impl SubClass<Node2D> for RemoteTransform2D

impl SubClass<Node2D> for Path2D

impl SubClass<Node2D> for Sprite

impl SubClass<Node2D> for Skeleton2D

impl SubClass<Node2D> for RayCast2D

impl SubClass<Node2D> for PathFollow2D

impl SubClass<Node2D> for LightOccluder2D

impl SubClass<Node2D> for AnimatedSprite

impl SubClass<Node2D> for CanvasModulate

impl SubClass<Node2D> for RigidBody2D

impl SubClass<Node2D> for Joint2D

impl SubClass<Node2D> for Polygon2D

impl SubClass<Node2D> for Position2D

impl SubClass<Node2D> for CollisionShape2D

impl SubClass<Node2D> for Bone2D

impl SubClass<Node2D> for CollisionPolygon2D

impl SubClass<Node2D> for MultiMeshInstance2D

impl SubClass<Node2D> for CollisionObject2D

impl SubClass<Node2D> for BackBufferCopy

impl SubClass<Node2D> for StaticBody2D

impl SubClass<Node2D> for MeshInstance2D

impl SubClass<Node2D> for YSort

impl SubClass<Node2D> for Light2D

impl SubClass<Node2D> for Area2D

impl SubClass<Node2D> for TileMap

impl SubClass<Node2D> for AudioStreamPlayer2D

impl SubClass<Object> for Node2D