Struct gdnative::RayCast2D

pub struct RayCast2D { /* fields omitted */ }

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

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

Class hierarchy

RayCast2D inherits methods from:

• Node2D
• CanvasItem
• Node
• Object

Methods

impl RayCast2D

pub fn new() -> RayCast2D

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

pub unsafe fn free(self)

Manually deallocate the object.

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

pub unsafe fn add_exception_rid(&mut self, rid: Rid)

pub unsafe fn clear_exceptions(&mut self)

pub unsafe fn force_raycast_update(&mut self)

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

pub unsafe fn get_collider(&self) -> Option<Object>

pub unsafe fn get_collider_shape(&self) -> i64

pub unsafe fn get_collision_mask(&self) -> i64

pub unsafe fn get_collision_mask_bit(&self, bit: i64) -> bool

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

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

pub unsafe fn get_exclude_parent_body(&self) -> bool

pub unsafe fn is_collide_with_areas_enabled(&self) -> bool

pub unsafe fn is_collide_with_bodies_enabled(&self) -> bool

pub unsafe fn is_colliding(&self) -> bool

pub unsafe fn is_enabled(&self) -> bool

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

pub unsafe fn remove_exception_rid(&mut self, rid: Rid)

pub unsafe fn set_cast_to(&mut self, local_point: Vector2D<f32, UnknownUnit>)

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

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

pub unsafe fn set_collision_mask(&mut self, mask: i64)

pub unsafe fn set_collision_mask_bit(&mut self, bit: i64, value: bool)

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

pub unsafe fn set_exclude_parent_body(&mut self, mask: bool)

pub unsafe fn to_node_2d(&self) -> Node2D

Up-cast.

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 = Node2D>

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.

Trait Implementations

impl Clone for RayCast2D

fn clone(&self) -> RayCast2D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for RayCast2D

impl Debug for RayCast2D

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

Formats the value using the given formatter.

impl Deref for RayCast2D

type Target = Node2D

The resulting type after dereferencing.

fn deref(&self) -> &Node2D

Dereferences the value.

impl DerefMut for RayCast2D

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

Mutably dereferences the value.

impl Free for RayCast2D

unsafe fn godot_free(self)

impl FromVariant for RayCast2D

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

impl GodotObject for RayCast2D

fn class_name() -> &'static str

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

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

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

impl Instanciable for RayCast2D

fn construct() -> RayCast2D

impl QueueFree for RayCast2D

unsafe fn godot_queue_free(&mut self)

impl ToVariant for RayCast2D

fn to_variant(&self) -> Variant