Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


CastShape(PhysicsShape, Vector2, QueryFilter, WorldCastMode, Allocator)

Returns the shape(s) that intersect the specified shape as it is cast through the world. The selected shape is excluded from any results and must be in this world otherwise a warning will be produced. Neither PhysicsShape.ShapeType.Segment or PhysicsShape.ShapeType.ChainSegment shape types are supported. See PhysicsQuery.QueryFilter, PhysicsQuery.WorldCastMode, PhysicsQuery.WorldCastResult and Allocator.
Read time 2 minutesLast updated 12 days ago

Definition

public NativeArray<PhysicsQuery.WorldCastResult> CastShape(PhysicsShape shape, Vector2 translation, PhysicsQuery.QueryFilter filter, PhysicsQuery.WorldCastMode castMode = WorldCastMode.Closest, Allocator allocator = Allocator.Temp)

Parameters

The shape used to cast through the world.

translation

The translation relative to the shape pose defining the direction the shape geometry will move through the world.

The filter to control what results are returned.

Controls how many and in what order the results are returned.

allocator

The memory allocator to use for the results. This can only be Allocator.Temp, Allocator.TempJob or Allocator.Persistent.

Returns

Type

Description

NativeArray<WorldCastResult>The query cast results. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.