<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>ICullable | Babylon.js API documentation</title><meta name="description" content="Documentation for Babylon.js API documentation"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="stylesheet" href="../assets/style.css"><link rel="stylesheet" href="../assets/highlight.css"></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Babylon.js API documentation</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">Babylon.js API documentation</a></li><li><a href="../modules/BABYLON.html">BABYLON</a></li><li><a href="BABYLON.ICullable.html">ICullable</a></li></ul><h1>Interface ICullable </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Interface for cullable objects</p>
</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://doc.babylonjs.com/features/featuresDeepDive/materials/using/materials_introduction#back-face-culling">https://doc.babylonjs.com/features/featuresDeepDive/materials/using/materials_introduction#back-face-culling</a></p>
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ICullable</span></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/BABYLON.AbstractMesh.html" class="tsd-signature-type" data-tsd-kind="Class">AbstractMesh</a></li><li><a href="../classes/BABYLON.BoundingBox.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingBox</a></li><li><a href="../classes/BABYLON.BoundingInfo.html" class="tsd-signature-type" data-tsd-kind="Class">BoundingInfo</a></li><li><a href="../classes/BABYLON.SubMesh.html" class="tsd-signature-type" data-tsd-kind="Class">SubMesh</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="BABYLON.ICullable.html#isCompletelyInFrustum" class="tsd-kind-icon">is<wbr>Completely<wbr>In<wbr>Frustum</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="BABYLON.ICullable.html#isInFrustum" class="tsd-kind-icon">is<wbr>In<wbr>Frustum</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="isCompletelyInFrustum" class="tsd-anchor"></a><h3 class="tsd-anchor-link">is<wbr>Completely<wbr>In<wbr>Frustum<a href="#isCompletelyInFrustum" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">is<wbr>Completely<wbr>In<wbr>Frustum<span class="tsd-signature-symbol">(</span>frustumPlanes<span class="tsd-signature-symbol">: </span><a href="../classes/BABYLON.Plane.html" class="tsd-signature-type" data-tsd-kind="Class">Plane</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:14267</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Checks if a cullable object (mesh...) is in the camera frustum
Unlike isInFrustum this checks the full bounding box</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>frustumPlanes: <a href="../classes/BABYLON.Plane.html" class="tsd-signature-type" data-tsd-kind="Class">Plane</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Camera near/planes</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>true if the object is in frustum otherwise false</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="isInFrustum" class="tsd-anchor"></a><h3 class="tsd-anchor-link">is<wbr>In<wbr>Frustum<a href="#isInFrustum" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">is<wbr>In<wbr>Frustum<span class="tsd-signature-symbol">(</span>frustumPlanes<span class="tsd-signature-symbol">: </span><a href="../classes/BABYLON.Plane.html" class="tsd-signature-type" data-tsd-kind="Class">Plane</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in .temp/docdirectory/doc.d.ts:14260</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Checks if the object or part of the object is in the frustum</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>frustumPlanes: <a href="../classes/BABYLON.Plane.html" class="tsd-signature-type" data-tsd-kind="Class">Plane</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Camera near/planes</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>true if the object is in frustum otherwise false</p>
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/BABYLON.html">BABYLON</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/BABYLON.Debug.html">Debug</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/BABYLON.GLTF1.html">GLTF1</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/BABYLON.GLTF2.html">GLTF2</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/BABYLON.GUI.html">GUI</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/BABYLON.nativeOverride.html">native<wbr>Override</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="BABYLON.ICullable.html" class="tsd-kind-icon">ICullable</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="BABYLON.ICullable.html#isCompletelyInFrustum" class="tsd-kind-icon">is<wbr>Completely<wbr>In<wbr>Frustum</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="BABYLON.ICullable.html#isInFrustum" class="tsd-kind-icon">is<wbr>In<wbr>Frustum</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div></body></html>

Interface ICullable

Hierarchy

Implemented by

Index

Methods

Methods

isCompletelyInFrustum Search playground for isCompletelyInFrustum

Parameters

frustumPlanes: Plane[]

Returns boolean

isInFrustum Search playground for isInFrustum

Parameters

frustumPlanes: Plane[]

Returns boolean

Hierarchy

Implemented by

Index

Methods

Methods

isCompletelyInFrustumSearch playground for isCompletelyInFrustum

Parameters

frustumPlanes: Plane[]

Returns boolean

isInFrustumSearch playground for isInFrustum

Parameters

frustumPlanes: Plane[]

Returns boolean

isCompletelyInFrustum Search playground for isCompletelyInFrustum

isInFrustum Search playground for isInFrustum