Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

SurfaceObserver.SetVolumeAsOrientedBox

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 SetVolumeAsOrientedBox(origin: Vector3, extents: Vector3, orientation: Quaternion): void;
public void SetVolumeAsOrientedBox(Vector3 origin, Vector3 extents, Quaternion orientation);

Parameters

origin The origin of the requested observation volume.
extents The extents in meters of the requested observation volume.
orientation The orientation of the requested observation volume.

Description

This method sets the observation volume as an oriented box at the requested location. Successive calls can be used to reshape the observation volume and/or to move it in the scene as needed. Extents are the distance from the center of the box to its edges along each axis.

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