Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

SurfaceObserver.SetVolumeAsSphere

Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

public function SetVolumeAsSphere(origin: Vector3, radiusMeters: float): void;
public void SetVolumeAsSphere(Vector3 origin, float radiusMeters);

Parameters

origin The origin of the requested observation volume.
radiusMeters The radius in meters of the requested observation volume.

Description

This method sets the observation volume as a sphere at the requested location. Successive calls can be used to reshape the observation volume and/or to move it in the scene as needed.

Very large observation volumes will increase overhead of calling SurfaceObserver.Update as the number of observable Surfaces grows.