Struct ark_api::world::SpatialQueryRequestBuilder

pub struct SpatialQueryRequestBuilder { /* private fields */ }

Use to build a SpatialQueryRequest using an ergonomic interface with sensible defaults.

Implementations

impl SpatialQueryRequestBuilder

pub fn raycast(ray: Ray3, range: Range<f32>) -> Self

Builds a world space raycast request with the minimum and maximum distance along the ray.

By default only the first hit is returned (can be changed with Self::with_max_hits).

pub fn spherecast(ray: Ray3, range: Range<f32>, radius: f32) -> Self

Sweep a sphere along a ray. Like a “thick” raycast.

Spherecasts can currently only be performed on the physical world.

pub fn with_max_hits(&mut self, max_hits: usize) -> &mut Self

Max number of hits that we want to receive.

pub fn with_layer_mask(&mut self, layer_mask: EntityLayerMask) -> &mut Self

Which layers we can hit.

pub fn with_ignore_entity(&mut self, entity: Entity) -> &mut Self

Ignore hits with this entity. If you want to ignore several entities you ewill have to use a layer mask instead.

pub fn with_options(&mut self, options: SpatialQueryOptions) -> &mut Self

Add options to the spatial query.

pub fn build(&self) -> SpatialQueryRequest

Builds a SpatialQueryRequest.

Methods from Deref<Target = SpatialQueryRequest>

pub fn as_message(&self, request_id: u64, hits_data_ptr: u32) -> Message

Converts this SpatialQueryRequest to the corresponding ffi message struct.

Trait Implementations

impl Clone for SpatialQueryRequestBuilder

fn clone(&self) -> SpatialQueryRequestBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for SpatialQueryRequestBuilder

type Target = SpatialQueryRequest

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Copy for SpatialQueryRequestBuilder