Struct gdnative::api::Physics2DShapeQueryParameters

pub struct Physics2DShapeQueryParameters { /* fields omitted */ }

core class Physics2DShapeQueryParameters 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

Physics2DShapeQueryParameters 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 Physics2DShapeQueryParameters

pub fn new() -> Ref<Physics2DShapeQueryParameters, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn collision_layer(&self) -> i64

The physics layer(s) the query will take into account (as a bitmask). See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.

pub fn exclude(&self) -> VariantArray<Shared>

The list of objects or object [RID]s that will be excluded from collisions.

pub fn margin(&self) -> f64

The collision margin for the shape.

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

The motion of the shape being queried for.

pub fn shape_rid(&self) -> Rid

The queried shape's [RID]. See also [method set_shape].

pub fn transform(&self) -> Transform2D<f32, UnknownUnit, UnknownUnit>

The queried shape's transform matrix.

pub fn is_collide_with_areas_enabled(&self) -> bool

If [code]true[/code], the query will take [Area2D]s into account.

pub fn is_collide_with_bodies_enabled(&self) -> bool

If [code]true[/code], the query will take [PhysicsBody2D]s into account.

pub fn set_collide_with_areas(&self, enable: bool)

If [code]true[/code], the query will take [Area2D]s into account.

pub fn set_collide_with_bodies(&self, enable: bool)

If [code]true[/code], the query will take [PhysicsBody2D]s into account.

pub fn set_collision_layer(&self, collision_layer: i64)

The physics layer(s) the query will take into account (as a bitmask). See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.

pub fn set_exclude(&self, exclude: VariantArray<Shared>)

The list of objects or object [RID]s that will be excluded from collisions.

pub fn set_margin(&self, margin: f64)

The collision margin for the shape.

pub fn set_motion(&self, motion: Vector2D<f32, UnknownUnit>)

The motion of the shape being queried for.

pub fn set_shape(&self, shape: impl AsArg<Resource>)

Sets the [Shape2D] that will be used for collision/intersection queries.

pub fn set_shape_rid(&self, shape: Rid)

The queried shape's [RID]. See also [method set_shape].

pub fn set_transform(
    &self,
    transform: Transform2D<f32, UnknownUnit, UnknownUnit>
)

The queried shape's transform matrix.

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 Physics2DShapeQueryParameters

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

Formats the value using the given formatter.

impl Deref for Physics2DShapeQueryParameters

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for Physics2DShapeQueryParameters

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

Mutably dereferences the value.

impl GodotObject for Physics2DShapeQueryParameters

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 Instanciable for Physics2DShapeQueryParameters

fn construct() -> Ref<Physics2DShapeQueryParameters, Unique>

impl SubClass<Object> for Physics2DShapeQueryParameters

impl SubClass<Reference> for Physics2DShapeQueryParameters