[−][src]Struct gdnative::api::Physics2DShapeQueryResult
core class Physics2DShapeQueryResult
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
Physics2DShapeQueryResult inherits methods from:
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 Physics2DShapeQueryResult
[src]
pub fn get_result_count(&self) -> i64
[src]
Returns the number of objects that intersected with the shape.
pub fn get_result_object(&self, idx: i64) -> Option<Ref<Object, Shared>>
[src]
Returns the [Object] that intersected with the shape at index [code]idx[/code].
pub fn get_result_object_id(&self, idx: i64) -> i64
[src]
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
[src]
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
[src]
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
[src]
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 Physics2DShapeQueryResult
[src]
impl Deref for Physics2DShapeQueryResult
[src]
impl DerefMut for Physics2DShapeQueryResult
[src]
impl GodotObject for Physics2DShapeQueryResult
[src]
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. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl SubClass<Object> for Physics2DShapeQueryResult
[src]
impl SubClass<Reference> for Physics2DShapeQueryResult
[src]
Auto Trait Implementations
impl RefUnwindSafe for Physics2DShapeQueryResult
impl !Send for Physics2DShapeQueryResult
impl !Sync for Physics2DShapeQueryResult
impl Unpin for Physics2DShapeQueryResult
impl UnwindSafe for Physics2DShapeQueryResult
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> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
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>,