Class Octree<T>

constructor

• new Octree<T>(
      creationFunc: (entry: T, block: OctreeBlock<T>) => void,
      maxBlockCapacity?: number,
      maxDepth?: number,
  ): Octree<T>

  Creates a octree

  Type Parameters

  • T

  Parameters

  • creationFunc: (entry: T, block: OctreeBlock<T>) => void

    function to be used to instantiate the octree

  • OptionalmaxBlockCapacity: number

    defines the maximum number of meshes you want on your octree's leaves (default: 64)

  • maxDepth: number = 2

    defines the maximum depth (sub-levels) for your octree. Default value is 2, which means 8 8 8 = 512 blocks :) (This parameter takes precedence over capacity.)

  Returns Octree<T>

  See

  https://doc.babylonjs.com/features/featuresDeepDive/scene/optimizeOctrees

blocks

dynamicContent

maxDepth

addMesh

• addMesh(entry: T): void

  Adds a mesh to the octree

  Parameters

  • entry: T

    Mesh to add to the octree

  Returns void

intersects

• intersects(
      sphereCenter: Vector3,
      sphereRadius: number,
      allowDuplicate?: boolean,
  ): SmartArray<T>

  Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array

  Parameters

  • sphereCenter: Vector3

    defines the bounding sphere center

  • sphereRadius: number

    defines the bounding sphere radius

  • OptionalallowDuplicate: boolean

    defines if the selection array can contains duplicated entries

  Returns SmartArray<T>

  an array of objects that intersect the sphere

intersectsRay

• intersectsRay(ray: Ray): SmartArray<T>

  Test if the octree intersect with the given ray and if yes, then add its content to resulting array

  Parameters

  • ray: Ray

    defines the ray to test with

  Returns SmartArray<T>

  array of intersected objects

removeMesh

• removeMesh(entry: T): void

  Remove an element from the octree

  Parameters

  • entry: T

    defines the element to remove

  Returns void

select

• select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>

  Selects an array of meshes within the frustum

  Parameters

  • frustumPlanes: Plane[]

    The frustum planes to use which will select all meshes within it

  • OptionalallowDuplicate: boolean

    If duplicate objects are allowed in the resulting object array

  Returns SmartArray<T>

  array of meshes within the frustum

update

• update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void

  Updates the octree by adding blocks for the passed in meshes within the min and max world parameters

  Parameters

  • worldMin: Vector3

    worldMin for the octree blocks var blockSize = new Vector3((worldMax.x - worldMin.x) / 2, (worldMax.y - worldMin.y) / 2, (worldMax.z - worldMin.z) / 2);

  • worldMax: Vector3

    worldMax for the octree blocks var blockSize = new Vector3((worldMax.x - worldMin.x) / 2, (worldMax.y - worldMin.y) / 2, (worldMax.z - worldMin.z) / 2);

  • entries: T[]

    meshes to be added to the octree blocks

  Returns void

StaticCreationFuncForMeshes

• CreationFuncForMeshes(
      entry: AbstractMesh,
      block: OctreeBlock<AbstractMesh>,
  ): void

  Adds a mesh into the octree block if it intersects the block

  Parameters

  • entry: AbstractMesh

    defines the mesh to try to add to the block

  • block: OctreeBlock<AbstractMesh>

    defines the block where the mesh should be added

  Returns void

StaticCreationFuncForSubMeshes

• CreationFuncForSubMeshes(entry: SubMesh, block: OctreeBlock<SubMesh>): void

  Adds a submesh into the octree block if it intersects the block

  Parameters

  • entry: SubMesh

    defines the submesh to try to add to the block

  • block: OctreeBlock<SubMesh>

    defines the block where the submesh should be added

  Returns void