Version: 2017.1 (switch to 2017.2b)
LanguageEnglish
  • C#
  • JS

Script language

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

GeometryUtility.TestPlanesAABB

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 static function TestPlanesAABB(planes: Plane[], bounds: Bounds): bool;
public static bool TestPlanesAABB(Plane[] planes, Bounds bounds);

Description

Returns true if bounds are inside the plane array.

Will return true if the bounding box is inside the planes or intersects any of the planes.

The TestPlanesAABB function uses the Plane array to test whether a bounding box is in the frustum or not.
You can use this function with CalculateFrustrumPlanes to test whether a camera's view contains an object regardless of whether it is rendered or not.

See Also: GeometryUtility.CalculateFrustumPlanes.

// Detects manually if anObject is being seen by the main camera

var anObject : GameObject; var anObjCollider: Collider;

private var cam : Camera; private var planes : Plane[];

function Start() { cam = Camera.main; planes = GeometryUtility.CalculateFrustumPlanes(cam); anObjCollider = GetComponent.<Collider>(); }

function Update() { if(GeometryUtility.TestPlanesAABB(planes,anObjCollider.bounds)) Debug.Log(anObject.name + " has been detected!"); else Debug.Log("Nothing has been detected"); }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public GameObject anObject; public Collider anObjCollider; private Camera cam; private Plane[] planes; void Start() { cam = Camera.main; planes = GeometryUtility.CalculateFrustumPlanes(cam); anObjCollider = GetComponent<Collider>(); } void Update() { if (GeometryUtility.TestPlanesAABB(planes, anObjCollider.bounds)) Debug.Log(anObject.name + " has been detected!"); else Debug.Log("Nothing has been detected"); } }