struct in UnityEngine
/
Implemented in:UnityEngine.PhysicsModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseUse this struct to set up a sphere cast command that is performed asynchronously during a job.
When you use this struct to schedule a batch of sphere casts, the sphere casts are performed asynchronously and in parallel. The results of each sphere casts are written to the results buffer. Since the results are written asynchronously, you cannot access the results buffer until the job is completed.
The results for a command at index N in the command buffer are stored at index N * maxHits in the results buffer.
Spherecast command also allows you to control whether or not Trigger colliders and back-face triangles generate a hit. Use QueryParameters to control hit flags.
Note: Only BatchQuery.ExecuteSpherecastJob is logged into the profiler. Query count information is not logged.
Additional resources: Physics.Spherecast.
using Unity.Collections; using Unity.Jobs; using UnityEngine;
public class SpherecastExample : MonoBehaviour { void Start() { // Perform a single sphere cast using SpherecastCommand and wait for it to complete // Set up the command and result buffers var results = new NativeArray<RaycastHit>(2, Allocator.TempJob); var commands = new NativeArray<SpherecastCommand>(1, Allocator.TempJob);
// Set the data of the first command Vector3 origin = Vector3.forward * -10; Vector3 direction = Vector3.forward; float radius = 0.5f;
commands[0] = new SpherecastCommand(origin, radius, direction, QueryParameters.Default);
// Schedule the batch of sphere casts var handle = SpherecastCommand.ScheduleBatch(commands, results, 1, 2, default(JobHandle));
// Wait for the batch processing job to complete handle.Complete();
// If batchedHit.collider is not null there was a hit foreach (var hit in results) { if (hit.collider != null) { // Do something with results } }
// Dispose the buffers results.Dispose(); commands.Dispose(); } }
direction | The direction of the sphere cast. |
distance | The maximum distance the sphere should check for collisions. |
origin | The starting point of the sphere cast in world coordinates. |
physicsScene | The physics scene this command is run in. |
queryParameters | Structure for specifying additional parameters for a batch query such as layer mask, hit triggers and hit backfaces. |
radius | The radius of the casting sphere. |
SpherecastCommand | Creates a SpherecastCommand. |
ScheduleBatch | Schedules a batch of sphere casts to perform in a job. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.