[−][src]Struct gdnative_bindings::Spatial
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
.
Class hierarchy
Spatial inherits methods from:
Methods
impl Spatial
[src]
Constants
pub const NOTIFICATION_ENTER_WORLD: i64
[src]
pub const NOTIFICATION_VISIBILITY_CHANGED: i64
[src]
pub const NOTIFICATION_TRANSFORM_CHANGED: i64
[src]
pub const NOTIFICATION_EXIT_WORLD: i64
[src]
impl Spatial
[src]
pub fn new() -> Self
[src]
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)
[src]
Manually deallocate the object.
pub unsafe fn _update_gizmo(&mut self)
[src]
pub unsafe fn force_update_transform(&mut self)
[src]
pub unsafe fn get_gizmo(&self) -> Option<SpatialGizmo>
[src]
pub unsafe fn get_global_transform(&self) -> Transform
[src]
pub unsafe fn get_parent_spatial(&self) -> Option<Spatial>
[src]
pub unsafe fn get_rotation(&self) -> Vector3
[src]
pub unsafe fn get_rotation_degrees(&self) -> Vector3
[src]
pub unsafe fn get_scale(&self) -> Vector3
[src]
pub unsafe fn get_transform(&self) -> Transform
[src]
pub unsafe fn get_translation(&self) -> Vector3
[src]
pub unsafe fn get_world(&self) -> Option<World>
[src]
pub unsafe fn global_rotate(&mut self, axis: Vector3, angle: f64)
[src]
pub unsafe fn global_scale(&mut self, scale: Vector3)
[src]
pub unsafe fn global_translate(&mut self, offset: Vector3)
[src]
pub unsafe fn hide(&mut self)
[src]
pub unsafe fn is_local_transform_notification_enabled(&self) -> bool
[src]
pub unsafe fn is_scale_disabled(&self) -> bool
[src]
pub unsafe fn is_set_as_toplevel(&self) -> bool
[src]
pub unsafe fn is_transform_notification_enabled(&self) -> bool
[src]
pub unsafe fn is_visible(&self) -> bool
[src]
pub unsafe fn is_visible_in_tree(&self) -> bool
[src]
pub unsafe fn look_at(&mut self, target: Vector3, up: Vector3)
[src]
pub unsafe fn look_at_from_position(
&mut self,
position: Vector3,
target: Vector3,
up: Vector3
)
[src]
&mut self,
position: Vector3,
target: Vector3,
up: Vector3
)
pub unsafe fn orthonormalize(&mut self)
[src]
pub unsafe fn rotate(&mut self, axis: Vector3, angle: f64)
[src]
pub unsafe fn rotate_object_local(&mut self, axis: Vector3, angle: f64)
[src]
pub unsafe fn rotate_x(&mut self, angle: f64)
[src]
pub unsafe fn rotate_y(&mut self, angle: f64)
[src]
pub unsafe fn rotate_z(&mut self, angle: f64)
[src]
pub unsafe fn scale_object_local(&mut self, scale: Vector3)
[src]
pub unsafe fn set_as_toplevel(&mut self, enable: bool)
[src]
pub unsafe fn set_disable_scale(&mut self, disable: bool)
[src]
pub unsafe fn set_gizmo(&mut self, gizmo: Option<SpatialGizmo>)
[src]
pub unsafe fn set_global_transform(&mut self, global: Transform)
[src]
pub unsafe fn set_identity(&mut self)
[src]
pub unsafe fn set_ignore_transform_notification(&mut self, enabled: bool)
[src]
pub unsafe fn set_notify_local_transform(&mut self, enable: bool)
[src]
pub unsafe fn set_notify_transform(&mut self, enable: bool)
[src]
pub unsafe fn set_rotation(&mut self, euler: Vector3)
[src]
pub unsafe fn set_rotation_degrees(&mut self, euler_degrees: Vector3)
[src]
pub unsafe fn set_scale(&mut self, scale: Vector3)
[src]
pub unsafe fn set_transform(&mut self, local: Transform)
[src]
pub unsafe fn set_translation(&mut self, translation: Vector3)
[src]
pub unsafe fn set_visible(&mut self, visible: bool)
[src]
pub unsafe fn show(&mut self)
[src]
pub unsafe fn to_global(&self, local_point: Vector3) -> Vector3
[src]
pub unsafe fn to_local(&self, global_point: Vector3) -> Vector3
[src]
pub unsafe fn translate(&mut self, offset: Vector3)
[src]
pub unsafe fn translate_object_local(&mut self, offset: Vector3)
[src]
pub unsafe fn update_gizmo(&mut self)
[src]
pub unsafe fn to_node(&self) -> Node
[src]
Up-cast.
pub unsafe fn to_object(&self) -> Object
[src]
Up-cast.
pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>
[src]
Generic dynamic cast.
Methods from Deref<Target = Node>
pub const NOTIFICATION_READY: i64
[src]
pub const NOTIFICATION_PROCESS: i64
[src]
pub const PAUSE_MODE_INHERIT: i64
[src]
pub const NOTIFICATION_TRANSLATION_CHANGED: i64
[src]
pub const NOTIFICATION_DRAG_END: i64
[src]
pub const NOTIFICATION_PATH_CHANGED: i64
[src]
pub const NOTIFICATION_ENTER_TREE: i64
[src]
pub const NOTIFICATION_INTERNAL_PROCESS: i64
[src]
pub const NOTIFICATION_DRAG_BEGIN: i64
[src]
pub const PAUSE_MODE_STOP: i64
[src]
pub const NOTIFICATION_INSTANCED: i64
[src]
pub const PAUSE_MODE_PROCESS: i64
[src]
pub const DUPLICATE_SCRIPTS: i64
[src]
pub const NOTIFICATION_EXIT_TREE: i64
[src]
pub const NOTIFICATION_UNPAUSED: i64
[src]
pub const NOTIFICATION_MOVED_IN_PARENT: i64
[src]
pub const DUPLICATE_GROUPS: i64
[src]
pub const DUPLICATE_SIGNALS: i64
[src]
pub const NOTIFICATION_PARENTED: i64
[src]
pub const NOTIFICATION_INTERNAL_PHYSICS_PROCESS: i64
[src]
pub const NOTIFICATION_PAUSED: i64
[src]
pub const NOTIFICATION_PHYSICS_PROCESS: i64
[src]
pub const NOTIFICATION_UNPARENTED: i64
[src]
pub const DUPLICATE_USE_INSTANCING: i64
[src]
pub unsafe fn _enter_tree(&mut self)
[src]
pub unsafe fn _exit_tree(&mut self)
[src]
pub unsafe fn _get_configuration_warning(&mut self) -> GodotString
[src]
pub unsafe fn _get_import_path(&self) -> NodePath
[src]
pub unsafe fn _input(&mut self, event: Option<InputEvent>)
[src]
pub unsafe fn _physics_process(&mut self, delta: f64)
[src]
pub unsafe fn _process(&mut self, delta: f64)
[src]
pub unsafe fn _ready(&mut self)
[src]
pub unsafe fn _set_import_path(&mut self, import_path: NodePath)
[src]
pub unsafe fn _unhandled_input(&mut self, event: Option<InputEvent>)
[src]
pub unsafe fn _unhandled_key_input(&mut self, event: Option<InputEventKey>)
[src]
pub unsafe fn add_child(
&mut self,
node: Option<Node>,
legible_unique_name: bool
)
[src]
&mut self,
node: Option<Node>,
legible_unique_name: bool
)
pub unsafe fn add_child_below_node(
&mut self,
node: Option<Node>,
child_node: Option<Node>,
legible_unique_name: bool
)
[src]
&mut self,
node: Option<Node>,
child_node: Option<Node>,
legible_unique_name: bool
)
pub unsafe fn add_to_group(&mut self, group: GodotString, persistent: bool)
[src]
pub unsafe fn can_process(&self) -> bool
[src]
pub unsafe fn duplicate(&self, flags: i64) -> Option<Node>
[src]
pub unsafe fn find_node(
&self,
mask: GodotString,
recursive: bool,
owned: bool
) -> Option<Node>
[src]
&self,
mask: GodotString,
recursive: bool,
owned: bool
) -> Option<Node>
pub unsafe fn find_parent(&self, mask: GodotString) -> Option<Node>
[src]
pub unsafe fn get_child(&self, idx: i64) -> Option<Node>
[src]
pub unsafe fn get_child_count(&self) -> i64
[src]
pub unsafe fn get_children(&self) -> VariantArray
[src]
pub unsafe fn get_custom_multiplayer(&self) -> Option<MultiplayerAPI>
[src]
pub unsafe fn get_filename(&self) -> GodotString
[src]
pub unsafe fn get_groups(&self) -> VariantArray
[src]
pub unsafe fn get_index(&self) -> i64
[src]
pub unsafe fn get_multiplayer(&self) -> Option<MultiplayerAPI>
[src]
pub unsafe fn get_name(&self) -> GodotString
[src]
pub unsafe fn get_network_master(&self) -> i64
[src]
pub unsafe fn get_node(&self, path: NodePath) -> Option<Node>
[src]
pub unsafe fn get_node_and_resource(&mut self, path: NodePath) -> VariantArray
[src]
pub unsafe fn get_node_or_null(&self, path: NodePath) -> Option<Node>
[src]
pub unsafe fn get_owner(&self) -> Option<Node>
[src]
pub unsafe fn get_parent(&self) -> Option<Node>
[src]
pub unsafe fn get_path(&self) -> NodePath
[src]
pub unsafe fn get_path_to(&self, node: Option<Node>) -> NodePath
[src]
pub unsafe fn get_pause_mode(&self) -> NodePauseMode
[src]
pub unsafe fn get_physics_process_delta_time(&self) -> f64
[src]
pub unsafe fn get_position_in_parent(&self) -> i64
[src]
pub unsafe fn get_process_delta_time(&self) -> f64
[src]
pub unsafe fn get_scene_instance_load_placeholder(&self) -> bool
[src]
pub unsafe fn get_tree(&self) -> Option<SceneTree>
[src]
pub unsafe fn get_viewport(&self) -> Option<Viewport>
[src]
pub unsafe fn has_node(&self, path: NodePath) -> bool
[src]
pub unsafe fn has_node_and_resource(&self, path: NodePath) -> bool
[src]
pub unsafe fn is_a_parent_of(&self, node: Option<Node>) -> bool
[src]
pub unsafe fn is_displayed_folded(&self) -> bool
[src]
pub unsafe fn is_greater_than(&self, node: Option<Node>) -> bool
[src]
pub unsafe fn is_in_group(&self, group: GodotString) -> bool
[src]
pub unsafe fn is_inside_tree(&self) -> bool
[src]
pub unsafe fn is_network_master(&self) -> bool
[src]
pub unsafe fn is_physics_processing(&self) -> bool
[src]
pub unsafe fn is_physics_processing_internal(&self) -> bool
[src]
pub unsafe fn is_processing(&self) -> bool
[src]
pub unsafe fn is_processing_input(&self) -> bool
[src]
pub unsafe fn is_processing_internal(&self) -> bool
[src]
pub unsafe fn is_processing_unhandled_input(&self) -> bool
[src]
pub unsafe fn is_processing_unhandled_key_input(&self) -> bool
[src]
pub unsafe fn move_child(&mut self, child_node: Option<Node>, to_position: i64)
[src]
pub unsafe fn print_stray_nodes(&mut self)
[src]
pub unsafe fn print_tree(&mut self)
[src]
pub unsafe fn print_tree_pretty(&mut self)
[src]
pub unsafe fn propagate_call(
&mut self,
method: GodotString,
args: VariantArray,
parent_first: bool
)
[src]
&mut self,
method: GodotString,
args: VariantArray,
parent_first: bool
)
pub unsafe fn propagate_notification(&mut self, what: i64)
[src]
pub unsafe fn queue_free(&mut self)
[src]
pub unsafe fn raise(&mut self)
[src]
pub unsafe fn remove_and_skip(&mut self)
[src]
pub unsafe fn remove_child(&mut self, node: Option<Node>)
[src]
pub unsafe fn remove_from_group(&mut self, group: GodotString)
[src]
pub unsafe fn replace_by(&mut self, node: Option<Node>, keep_data: bool)
[src]
pub unsafe fn request_ready(&mut self)
[src]
pub unsafe fn rpc(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
[src]
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
pub unsafe fn rpc_config(&mut self, method: GodotString, mode: i64)
[src]
pub unsafe fn rpc_id(
&mut self,
peer_id: i64,
method: GodotString,
varargs: &[Variant]
) -> Variant
[src]
&mut self,
peer_id: i64,
method: GodotString,
varargs: &[Variant]
) -> Variant
pub unsafe fn rpc_unreliable(
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
[src]
&mut self,
method: GodotString,
varargs: &[Variant]
) -> Variant
pub unsafe fn rpc_unreliable_id(
&mut self,
peer_id: i64,
method: GodotString,
varargs: &[Variant]
) -> Variant
[src]
&mut self,
peer_id: i64,
method: GodotString,
varargs: &[Variant]
) -> Variant
pub unsafe fn rset(&mut self, property: GodotString, value: Variant)
[src]
pub unsafe fn rset_config(&mut self, property: GodotString, mode: i64)
[src]
pub unsafe fn rset_id(
&mut self,
peer_id: i64,
property: GodotString,
value: Variant
)
[src]
&mut self,
peer_id: i64,
property: GodotString,
value: Variant
)
pub unsafe fn rset_unreliable(&mut self, property: GodotString, value: Variant)
[src]
pub unsafe fn rset_unreliable_id(
&mut self,
peer_id: i64,
property: GodotString,
value: Variant
)
[src]
&mut self,
peer_id: i64,
property: GodotString,
value: Variant
)
pub unsafe fn set_custom_multiplayer(&mut self, api: Option<MultiplayerAPI>)
[src]
pub unsafe fn set_display_folded(&mut self, fold: bool)
[src]
pub unsafe fn set_filename(&mut self, filename: GodotString)
[src]
pub unsafe fn set_name(&mut self, name: GodotString)
[src]
pub unsafe fn set_network_master(&mut self, id: i64, recursive: bool)
[src]
pub unsafe fn set_owner(&mut self, owner: Option<Node>)
[src]
pub unsafe fn set_pause_mode(&mut self, mode: i64)
[src]
pub unsafe fn set_physics_process(&mut self, enable: bool)
[src]
pub unsafe fn set_physics_process_internal(&mut self, enable: bool)
[src]
pub unsafe fn set_process(&mut self, enable: bool)
[src]
pub unsafe fn set_process_input(&mut self, enable: bool)
[src]
pub unsafe fn set_process_internal(&mut self, enable: bool)
[src]
pub unsafe fn set_process_priority(&mut self, priority: i64)
[src]
pub unsafe fn set_process_unhandled_input(&mut self, enable: bool)
[src]
pub unsafe fn set_process_unhandled_key_input(&mut self, enable: bool)
[src]
pub unsafe fn set_scene_instance_load_placeholder(
&mut self,
load_placeholder: bool
)
[src]
&mut self,
load_placeholder: bool
)
pub unsafe fn to_object(&self) -> Object
[src]
Up-cast.
pub unsafe fn cast<T: GodotObject>(&self) -> Option<T>
[src]
Generic dynamic cast.
Trait Implementations
impl Clone for Spatial
[src]
impl Copy for Spatial
[src]
impl Debug for Spatial
[src]
impl Deref for Spatial
[src]
impl DerefMut for Spatial
[src]
impl Free for Spatial
[src]
unsafe fn godot_free(self)
[src]
impl FromVariant for Spatial
[src]
fn from_variant(variant: &Variant) -> Option<Self>
[src]
impl GodotObject for Spatial
[src]
fn class_name() -> &'static str
[src]
unsafe fn from_sys(obj: *mut godot_object) -> Self
[src]
unsafe fn to_sys(&self) -> *mut godot_object
[src]
impl Instanciable for Spatial
[src]
impl QueueFree for Spatial
[src]
unsafe fn godot_queue_free(&mut self)
[src]
impl ToVariant for Spatial
[src]
fn to_variant(&self) -> Variant
[src]
Auto Trait Implementations
impl RefUnwindSafe for Spatial
impl !Send for Spatial
impl !Sync for Spatial
impl Unpin for Spatial
impl UnwindSafe for Spatial
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,