SweepTest(Vector3, out RaycastHit, float, QueryTriggerInteraction)
Tests if a rigidbody would collide with anything, if it was moved through the Scene.
Read time 1 minuteLast updated 7 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.PhysicsModule
SweepTest(Vector3, RaycastHit, float, QueryTriggerInteraction)
public bool SweepTest(Vector3 direction, out RaycastHit hitInfo, float maxDistance, QueryTriggerInteraction queryTriggerInteraction)
Parameters
The direction into which to sweep the rigidbody.
If true is returned, will contain more information about where the collider was hit (Additional Resources: RaycastHit).
hitInfoThe length of the sweep.
Specifies whether this query should hit Triggers.
Returns
Type | Description |
|---|---|
| bool | True when the rigidbody sweep intersects any collider, otherwise false. |
Remarks
Tests if a rigidbody would collide with anything, if it was moved through the Scene. This is similar to doing a Physics.Raycast for all points contained in any of a Rigidbody's colliders and returning the closest of all hits (if any) reported. This is useful for AI code, say if you need to know that an object would fit through a gap without colliding with anything.
Note that this function only works when a primitive collider type (sphere, cube or capsule) or a convex mesh is attached to the rigidbody object - concave mesh colliders will not work, although they can be detected in the Scene by the sweep.
Examples
using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ public float collisionCheckDistance; public bool aboutToCollide; public float distanceToCollision; public Rigidbody rb; void Start() { rb = GetComponent<Rigidbody>(); } void Update() { RaycastHit hit; if (rb.SweepTest(transform.forward, out hit, collisionCheckDistance)) { aboutToCollide = true; distanceToCollision = hit.distance; } }}