Struct gdnative_common::Spatial

pub struct Spatial { /* fields omitted */ }

core class Spatial inherits Node (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.

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

Feature flag

This type is behind the gdnative crate's common feature flag.

Class hierarchy

Spatial inherits methods from:

• Node
• Object

Methods

impl Spatial

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn set_transform(&mut self, local: Transform)

pub unsafe fn get_transform(&self) -> Transform

pub unsafe fn set_translation(&mut self, translation: Vector3)

pub unsafe fn get_translation(&self) -> Vector3

pub unsafe fn set_rotation(&mut self, euler: Vector3)

pub unsafe fn get_rotation(&self) -> Vector3

pub unsafe fn set_rotation_degrees(&mut self, euler_degrees: Vector3)

pub unsafe fn get_rotation_degrees(&self) -> Vector3

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

pub unsafe fn get_scale(&self) -> Vector3

pub unsafe fn set_global_transform(&mut self, global: Transform)

pub unsafe fn get_global_transform(&self) -> Transform

pub unsafe fn get_parent_spatial(&self) -> Option<Spatial>

pub unsafe fn set_ignore_transform_notification(&mut self, enabled: bool)

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

pub unsafe fn is_set_as_toplevel(&self) -> bool

pub unsafe fn set_disable_scale(&mut self, disable: bool)

pub unsafe fn is_scale_disabled(&self) -> bool

pub unsafe fn get_world(&self) -> Option<World>

pub unsafe fn _update_gizmo(&mut self)

pub unsafe fn update_gizmo(&mut self)

pub unsafe fn set_gizmo(&mut self, gizmo: Option<SpatialGizmo>)

pub unsafe fn get_gizmo(&self) -> Option<SpatialGizmo>

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

pub unsafe fn is_visible(&self) -> bool

pub unsafe fn is_visible_in_tree(&self) -> bool

pub unsafe fn show(&mut self)

pub unsafe fn hide(&mut self)

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

pub unsafe fn is_local_transform_notification_enabled(&self) -> bool

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

pub unsafe fn is_transform_notification_enabled(&self) -> bool

pub unsafe fn rotate(&mut self, axis: Vector3, angle: f64)

pub unsafe fn global_rotate(&mut self, axis: Vector3, angle: f64)

pub unsafe fn global_scale(&mut self, scale: Vector3)

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

pub unsafe fn rotate_object_local(&mut self, axis: Vector3, angle: f64)

pub unsafe fn scale_object_local(&mut self, scale: Vector3)

pub unsafe fn translate_object_local(&mut self, offset: Vector3)

pub unsafe fn rotate_x(&mut self, angle: f64)

pub unsafe fn rotate_y(&mut self, angle: f64)

pub unsafe fn rotate_z(&mut self, angle: f64)

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

pub unsafe fn orthonormalize(&mut self)

pub unsafe fn set_identity(&mut self)

pub unsafe fn look_at(&mut self, target: Vector3, up: Vector3)

pub unsafe fn look_at_from_position(
    &mut self,
    position: Vector3,
    target: Vector3,
    up: Vector3
)

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

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

pub unsafe fn _process(&mut self, delta: f64)

Inherited from Node.

pub unsafe fn _physics_process(&mut self, delta: f64)

Inherited from Node.

pub unsafe fn _enter_tree(&mut self)

Inherited from Node.

pub unsafe fn _exit_tree(&mut self)

Inherited from Node.

pub unsafe fn _ready(&mut self)

Inherited from Node.

pub unsafe fn _input(&mut self, event: Option<InputEvent>)

Inherited from Node.

pub unsafe fn _unhandled_input(&mut self, event: Option<InputEvent>)

Inherited from Node.

pub unsafe fn _unhandled_key_input(&mut self, event: Option<InputEventKey>)

Inherited from Node.

pub unsafe fn add_child_below_node(
    &mut self,
    node: Option<Object>,
    child_node: Option<Object>,
    legible_unique_name: bool
)

Inherited from Node.

pub unsafe fn set_name(&mut self, name: GodotString)

Inherited from Node.

pub unsafe fn get_name(&self) -> GodotString

Inherited from Node.

pub unsafe fn add_child(
    &mut self,
    node: Option<Object>,
    legible_unique_name: bool
)

Inherited from Node.

pub unsafe fn remove_child(&mut self, node: Option<Object>)

Inherited from Node.

pub unsafe fn get_child_count(&self) -> i64

Inherited from Node.

pub unsafe fn get_children(&self) -> VariantArray

Inherited from Node.

pub unsafe fn get_child(&self, idx: i64) -> Option<Node>

Inherited from Node.

pub unsafe fn has_node(&self, path: NodePath) -> bool

Inherited from Node.

pub unsafe fn get_node(&self, path: NodePath) -> Option<Node>

Inherited from Node.

pub unsafe fn get_parent(&self) -> Option<Node>

Inherited from Node.

pub unsafe fn find_node(
    &self,
    mask: GodotString,
    recursive: bool,
    owned: bool
) -> Option<Node>

Inherited from Node.

pub unsafe fn has_node_and_resource(&self, path: NodePath) -> bool

Inherited from Node.

pub unsafe fn get_node_and_resource(&mut self, path: NodePath) -> VariantArray

Inherited from Node.

pub unsafe fn is_inside_tree(&self) -> bool

Inherited from Node.

pub unsafe fn is_a_parent_of(&self, node: Option<Object>) -> bool

Inherited from Node.

pub unsafe fn is_greater_than(&self, node: Option<Object>) -> bool

Inherited from Node.

pub unsafe fn get_path(&self) -> NodePath

Inherited from Node.

pub unsafe fn get_path_to(&self, node: Option<Object>) -> NodePath

Inherited from Node.

pub unsafe fn add_to_group(&mut self, group: GodotString, persistent: bool)

Inherited from Node.

pub unsafe fn remove_from_group(&mut self, group: GodotString)

Inherited from Node.

pub unsafe fn is_in_group(&self, group: GodotString) -> bool

Inherited from Node.

pub unsafe fn move_child(
    &mut self,
    child_node: Option<Object>,
    to_position: i64
)

Inherited from Node.

pub unsafe fn get_groups(&self) -> VariantArray

Inherited from Node.

pub unsafe fn raise(&mut self)

Inherited from Node.

pub unsafe fn set_owner(&mut self, owner: Option<Object>)

Inherited from Node.

pub unsafe fn get_owner(&self) -> Option<Node>

Inherited from Node.

pub unsafe fn remove_and_skip(&mut self)

Inherited from Node.

pub unsafe fn get_index(&self) -> i64

Inherited from Node.

pub unsafe fn print_tree(&mut self)

Inherited from Node.

pub unsafe fn print_tree_pretty(&mut self)

Inherited from Node.

pub unsafe fn set_filename(&mut self, filename: GodotString)

Inherited from Node.

pub unsafe fn get_filename(&self) -> GodotString

Inherited from Node.

pub unsafe fn propagate_notification(&mut self, what: i64)

Inherited from Node.

pub unsafe fn propagate_call(
    &mut self,
    method: GodotString,
    args: VariantArray,
    parent_first: bool
)

Inherited from Node.

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

Inherited from Node.

pub unsafe fn get_physics_process_delta_time(&self) -> f64

Inherited from Node.

pub unsafe fn is_physics_processing(&self) -> bool

Inherited from Node.

pub unsafe fn get_process_delta_time(&self) -> f64

Inherited from Node.

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

Inherited from Node.

pub unsafe fn set_process_priority(&mut self, priority: i64)

Inherited from Node.

pub unsafe fn is_processing(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_processing_input(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_processing_unhandled_input(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_processing_unhandled_key_input(&self) -> bool

Inherited from Node.

pub unsafe fn set_pause_mode(&mut self, mode: i64)

Inherited from Node.

pub unsafe fn get_pause_mode(&self) -> NodePauseMode

Inherited from Node.

pub unsafe fn can_process(&self) -> bool

Inherited from Node.

pub unsafe fn print_stray_nodes(&mut self)

Inherited from Node.

pub unsafe fn get_position_in_parent(&self) -> i64

Inherited from Node.

pub unsafe fn set_display_folded(&mut self, fold: bool)

Inherited from Node.

pub unsafe fn is_displayed_folded(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_processing_internal(&self) -> bool

Inherited from Node.

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

Inherited from Node.

pub unsafe fn is_physics_processing_internal(&self) -> bool

Inherited from Node.

pub unsafe fn get_tree(&self) -> Option<SceneTree>

Inherited from Node.

pub unsafe fn duplicate(&self, flags: i64) -> Option<Node>

Inherited from Node.

pub unsafe fn replace_by(&mut self, node: Option<Object>, keep_data: bool)

Inherited from Node.

pub unsafe fn set_scene_instance_load_placeholder(
    &mut self,
    load_placeholder: bool
)

Inherited from Node.

pub unsafe fn get_scene_instance_load_placeholder(&self) -> bool

Inherited from Node.

pub unsafe fn get_viewport(&self) -> Option<Viewport>

Inherited from Node.

pub unsafe fn queue_free(&mut self)

Inherited from Node.

pub unsafe fn request_ready(&mut self)

Inherited from Node.

pub unsafe fn set_network_master(&mut self, id: i64, recursive: bool)

Inherited from Node.

pub unsafe fn get_network_master(&self) -> i64

Inherited from Node.

pub unsafe fn is_network_master(&self) -> bool

Inherited from Node.

pub unsafe fn get_multiplayer(&self) -> Option<MultiplayerAPI>

Inherited from Node.

pub unsafe fn get_custom_multiplayer(&self) -> Option<MultiplayerAPI>

Inherited from Node.

pub unsafe fn set_custom_multiplayer(&mut self, api: Option<MultiplayerAPI>)

Inherited from Node.

pub unsafe fn rpc_config(&mut self, method: GodotString, mode: i64)

Inherited from Node.

pub unsafe fn rset_config(&mut self, property: GodotString, mode: i64)

Inherited from Node.

pub unsafe fn _set_import_path(&mut self, import_path: NodePath)

Inherited from Node.

pub unsafe fn _get_import_path(&self) -> NodePath

Inherited from Node.

pub unsafe fn rpc(
    &mut self,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

Inherited from Node.

pub unsafe fn rpc_unreliable(
    &mut self,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

Inherited from Node.

pub unsafe fn rpc_id(
    &mut self,
    peer_id: i64,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

Inherited from Node.

pub unsafe fn rpc_unreliable_id(
    &mut self,
    peer_id: i64,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

Inherited from Node.

pub unsafe fn rset(&mut self, property: GodotString, value: Variant)

Inherited from Node.

pub unsafe fn rset_id(
    &mut self,
    peer_id: i64,
    property: GodotString,
    value: Variant
)

Inherited from Node.

pub unsafe fn rset_unreliable(&mut self, property: GodotString, value: Variant)

Inherited from Node.

pub unsafe fn rset_unreliable_id(
    &mut self,
    peer_id: i64,
    property: GodotString,
    value: Variant
)

Inherited from Node.

pub unsafe fn _notification(&mut self, what: i64)

Inherited from Object.

pub unsafe fn _set(&mut self, property: GodotString, value: Variant) -> bool

Inherited from Object.

pub unsafe fn _get(&mut self, property: GodotString) -> Variant

Inherited from Object.

pub unsafe fn _get_property_list(&mut self) -> VariantArray

Inherited from Object.

pub unsafe fn _init(&mut self)

Inherited from Object.

pub unsafe fn get_class(&self) -> GodotString

Inherited from Object.

pub unsafe fn is_class(&self, _type: GodotString) -> bool

Inherited from Object.

pub unsafe fn set(&mut self, property: GodotString, value: Variant)

Inherited from Object.

pub unsafe fn get(&self, property: GodotString) -> Variant

Inherited from Object.

pub unsafe fn set_indexed(&mut self, property: NodePath, value: Variant)

Inherited from Object.

pub unsafe fn get_indexed(&self, property: NodePath) -> Variant

Inherited from Object.

pub unsafe fn get_property_list(&self) -> VariantArray

Inherited from Object.

pub unsafe fn get_method_list(&self) -> VariantArray

Inherited from Object.

pub unsafe fn notification(&mut self, what: i64, reversed: bool)

Inherited from Object.

pub unsafe fn get_instance_id(&self) -> i64

Inherited from Object.

pub unsafe fn set_script(&mut self, script: Option<Reference>)

Inherited from Object.

pub unsafe fn get_script(&self) -> Option<Reference>

Inherited from Object.

pub unsafe fn set_meta(&mut self, name: GodotString, value: Variant)

Inherited from Object.

pub unsafe fn get_meta(&self, name: GodotString) -> Variant

Inherited from Object.

pub unsafe fn has_meta(&self, name: GodotString) -> bool

Inherited from Object.

pub unsafe fn get_meta_list(&self) -> StringArray

Inherited from Object.

pub unsafe fn add_user_signal(
    &mut self,
    signal: GodotString,
    arguments: VariantArray
)

Inherited from Object.

pub unsafe fn has_user_signal(&self, signal: GodotString) -> bool

Inherited from Object.

pub unsafe fn emit_signal(
    &mut self,
    signal: GodotString,
    varargs: &[Variant]
) -> Variant

Inherited from Object.

pub unsafe fn call(
    &mut self,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

Inherited from Object.

pub unsafe fn call_deferred(
    &mut self,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

Inherited from Object.

pub unsafe fn callv(
    &mut self,
    method: GodotString,
    arg_array: VariantArray
) -> Variant

Inherited from Object.

pub unsafe fn has_method(&self, method: GodotString) -> bool

Inherited from Object.

pub unsafe fn get_signal_list(&self) -> VariantArray

Inherited from Object.

pub unsafe fn get_signal_connection_list(
    &self,
    signal: GodotString
) -> VariantArray

Inherited from Object.

pub unsafe fn get_incoming_connections(&self) -> VariantArray

Inherited from Object.

pub unsafe fn connect(
    &mut self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString,
    binds: VariantArray,
    flags: i64
) -> GodotResult

Inherited from Object.

pub unsafe fn disconnect(
    &mut self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString
)

Inherited from Object.

pub unsafe fn is_connected(
    &self,
    signal: GodotString,
    target: Option<Object>,
    method: GodotString
) -> bool

Inherited from Object.

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

Inherited from Object.

pub unsafe fn is_blocking_signals(&self) -> bool

Inherited from Object.

pub unsafe fn property_list_changed_notify(&mut self)

Inherited from Object.

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

Inherited from Object.

pub unsafe fn can_translate_messages(&self) -> bool

Inherited from Object.

pub unsafe fn tr(&self, message: GodotString) -> GodotString

Inherited from Object.

pub unsafe fn is_queued_for_deletion(&self) -> bool

Inherited from Object.

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 Spatial

fn clone(&self) -> Spatial

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Spatial

impl Debug for Spatial

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

Formats the value using the given formatter.

impl Free for Spatial

unsafe fn godot_free(self)

impl GodotObject for Spatial

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

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

impl QueueFree for Spatial

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Spatial

fn to_variant(&self) -> Variant

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