Struct gdnative::api::PhysicsShapeQueryResult

pub struct PhysicsShapeQueryResult { /* fields omitted */ }

core class PhysicsShapeQueryResult inherits Reference (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

PhysicsShapeQueryResult inherits methods from:

• Reference
• 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 PhysicsShapeQueryResult

pub fn get_result_count(&self) -> i64

Returns the number of objects that intersected with the shape.

pub fn get_result_object(&self, idx: i64) -> Option<Ref<Object, Shared>>

Returns the [Object] that intersected with the shape at index [code]idx[/code].

pub fn get_result_object_id(&self, idx: i64) -> i64

Returns the instance ID of the [Object] that intersected with the shape at index [code]idx[/code].

pub fn get_result_object_shape(&self, idx: i64) -> i64

Returns the child index of the object's [Shape] that intersected with the shape at index [code]idx[/code].

pub fn get_result_rid(&self, idx: i64) -> Rid

Returns the [RID] of the object that intersected with the shape at index [code]idx[/code].

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing.
				Returns whether the initialization was successful.

Trait Implementations

impl Debug for PhysicsShapeQueryResult

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

Formats the value using the given formatter.

impl Deref for PhysicsShapeQueryResult

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for PhysicsShapeQueryResult

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

Mutably dereferences the value.

impl GodotObject for PhysicsShapeQueryResult

type RefKind = RefCounted

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 SubClass<Object> for PhysicsShapeQueryResult

impl SubClass<Reference> for PhysicsShapeQueryResult