Class AbstractSpatialHashGrid

Represents an abstract spatial hash grid that extends THREE.Object3D and implements the SpatialHashGrid interface. This class is used to manage a spatial hash grid for efficient spatial queries and updates.

Remarks

This class uses THREE.js for 3D object management and visualization.

Example

const spatialHashGrid = new AbstractSpatialHashGrid();
spatialHashGrid.boundX = 20;
spatialHashGrid.boundY = 20;
spatialHashGrid.boundZ = 20;
spatialHashGrid.update();

Hierarchy

Object3D
- AbstractSpatialHashGrid

Implements

SpatialHashGrid

Index

Constructors

constructor

Constructors

constructor

new AbstractSpatialHashGrid(): AbstractSpatialHashGrid
Returns AbstractSpatialHashGrid
Overrides THREE.Object3D.constructor
- Defined in src/spatial/AbstractSpatialHashGrid.ts:76

Properties

`Protected` _bounds

_bounds: null | Bounds = null

The bounds of the spatial hash grid.

`Protected` _box

_box: Box3

The box that represents the bounds of the spatial hash grid.

`Protected` _boxGroup

_boxGroup: Group<Object3DEventMap>

The group that contains the box.

`Protected` _hashGridGroup

_hashGridGroup: Group<Object3DEventMap>

The group that contains the hash grid.

animations

animations: AnimationClip[]

Array with object's animation clips.

Default Value

[]

boundX

boundX: number

The bound in the x-axis.

boundY

boundY: number

The bound in the y-axis.

boundZ

boundZ: number

The bound in the z-axis.

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

Default Value

false

children

children: Object3D<Object3DEventMap>[]

Array with object's children.

See

THREE.Object3DGroup | Group for info on manually grouping objects.

Default Value

[]

`Optional` customDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

Remarks

Can only be used in context of meshes. When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight, if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

Default Value

undefined

`Optional` customDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

Default Value

undefined

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object. If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

Default Value

true

`Readonly` id

id: number

Unique number for this Object3D instance.

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object. Expects a Integer

`Readonly` isObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

Remarks

This is a constant value

Default Value

true

isSpatialHashGrid

isSpatialHashGrid: boolean

Determines if the current object is a spatial hash grid.

layers

layers: Layers

The layer membership of the object.

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use. This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

Default Value

new THREE.Layers()

matrix

matrix: Matrix4

The local transform matrix.

Default Value

new THREE.Matrix4()

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property.

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

Remarks

If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.

Default Value

new THREE.Matrix4()

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates. When it isn't, then you have to maintain all matrices in the object and its children yourself.

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

Default Value

false

`Readonly` modelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

name

name: string

Optional name of the object

Remarks

(doesn't need to be unique).

Default Value

""

`Readonly` normalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

parent

parent: null | Object3D<Object3DEventMap>

Object's parent in the scene graph.

Remarks

An object can have at most one parent.

Default Value

null

`Readonly` position

position: Vector3

Object's local position.

Default Value

new THREE.Vector3() - that is (0, 0, 0).

`Readonly` quaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

Default Value

false

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph objects to be overridden although opaque and transparent objects remain sorted independently.

Remarks

When this property is set for an instance of Group | Group, all descendants objects will be sorted and rendered together. Sorting is from lowest to highest renderOrder.

Default Value

0

`Readonly` rotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

`Readonly` scale

scale: Vector3

The object's local scale.

Default Value

new THREE.Vector3( 1, 1, 1 )

spatialHashGrid

spatialHashGrid: null | default = null

The spatial hash grid used for spatial partitioning.

`Readonly` type

type: string

A Read-only string to check this object type.

Remarks

This can be used to find a specific type of Object3D in a scene. Sub-classes will update this value.

Default Value

Object3D

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

Remarks

It should not hold references to functions as these will not be cloned.

Default

{}

uuid

uuid: string

UUID of this object instance.

Remarks

This gets automatically assigned and shouldn't be edited.

visible

visible: boolean

Object gets rendered if true.

Default Value

true

`Static` DEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

Default Value

true

`Static` DEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

Default Value

true

`Static` DEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight, THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

Default Value

new THREE.Vector3( 0, 1, 0)

Methods

`Protected` _updateBox

_updateBox(): void
Protected
Updates the bounding box and its visual representation.

This method clears the current box group, adds an axes helper for reference, and then creates and positions a new bounding box based on the current bounds. Finally, it adds a visual helper for the bounding box to the box group.

Returns void
- Defined in src/spatial/AbstractSpatialHashGrid.ts:133

`Protected` _updateHashGrid

_updateHashGrid(): void
Protected
Updates the spatial hash grid by clearing the current grid group, recalculating the bounds, and creating a new spatial hash grid.

Returns void

Remarks
This method recalculates the bounds based on the current boundX and boundZ values, and then creates a new instance of ThreeSpatialHashGrid with the updated bounds and divisions. The new spatial hash grid is then added to the _hashGridGroup.
- Defined in src/spatial/AbstractSpatialHashGrid.ts:159

add

add(...object): AbstractSpatialHashGrid
Adds another Object3D as child of this Object3D.
Parameters
- Rest ...object: Object3D<Object3DEventMap>[]
Returns AbstractSpatialHashGrid
Remarks
An arbitrary number of objects may be added Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.

See
- attach
- THREE.Group | Group for info on manually grouping objects.
Inherited from THREE.Object3D.add
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:515

addDebug

addDebug(gui): void
Adds debug controls to the provided GUI for adjusting the spatial hash grid bounds.
Parameters
- gui: GUI
  The GUI instance to which the debug controls will be added.
  
  The following controls are added:
  - Bound X: A slider to adjust the boundX property, ranging from 1 to 100.
  - Bound Y: A slider to adjust the boundY property, ranging from 1 to 100.
  - Bound Z: A slider to adjust the boundZ property, ranging from 1 to 100.
  Each control updates the corresponding property and calls the update method when changed.
Returns void
Implementation of SpatialHashGrid.addDebug
- Defined in src/spatial/AbstractSpatialHashGrid.ts:200

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends keyof Object3DEventMap
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Object3DEventMap[T], T, AbstractSpatialHashGrid>
  
  The function that gets called when the event is fired.
Returns void
Inherited from THREE.Object3D.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:52

applyMatrix4

applyMatrix4(matrix): void
Applies the matrix transform to the object and updates the object's position, rotation and scale.
Parameters
- matrix: Matrix4
Returns void
Inherited from THREE.Object3D.applyMatrix4
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:385

applyQuaternion

applyQuaternion(quaternion): AbstractSpatialHashGrid
Applies the rotation represented by the quaternion to the object.
Parameters
- quaternion: Quaternion
Returns AbstractSpatialHashGrid
Inherited from THREE.Object3D.applyQuaternion
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:391

attach

attach(object): AbstractSpatialHashGrid
Adds a Object3D as a child of this, while maintaining the object's world transform.
Parameters
- object: Object3D<Object3DEventMap>
Returns AbstractSpatialHashGrid

Remarks
Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

See
add
Inherited from THREE.Object3D.attach
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:541

clear

clear(): AbstractSpatialHashGrid
Removes all child objects.

Returns AbstractSpatialHashGrid
Inherited from THREE.Object3D.clear
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:533

clone

clone(recursive?): AbstractSpatialHashGrid
Returns a clone of this object and optionally all descendants.
Parameters
- Optional recursive: boolean
  
  If true, descendants of the object are also cloned. Default true
Returns AbstractSpatialHashGrid
Inherited from THREE.Object3D.clone
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:664

copy

copy(object, recursive?): AbstractSpatialHashGrid
Copies the given object into this object.
Parameters
- object: Object3D<Object3DEventMap>
- Optional recursive: boolean
  
  If set to true, descendants of the object are copied next to the existing ones. If set to false, descendants are left unchanged. Default is true.
Returns AbstractSpatialHashGrid

Remarks
Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.
Inherited from THREE.Object3D.copy
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:673

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends keyof Object3DEventMap
Parameters
- event: BaseEvent<T> & Object3DEventMap[T]
  
  The event that gets fired.
Returns void
Inherited from THREE.Object3D.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:81

getBox

getBox(): Box3
Retrieves the bounding box of the spatial hash grid.

Returns Box3
The bounding box of the spatial hash grid.
Implementation of SpatialHashGrid.getBox
- Defined in src/spatial/AbstractSpatialHashGrid.ts:184

getCellNear

getCellNear(x, y, mathOperation?): [number, number]
Returns the coordinates of the cell near the given (x, y) position.
Parameters
- x: number
  
  The x-coordinate of the position.
- y: number
  
  The y-coordinate of the position.
- mathOperation: MathOperation = 'round'
  
  The mathematical operation to use for rounding the coordinates. Defaults to 'round'.
Returns [number, number]
A tuple containing the x and y coordinates of the nearest cell.
Implementation of SpatialHashGrid.getCellNear
- Defined in src/spatial/AbstractSpatialHashGrid.ts:101

getObjectById

getObjectById(id): undefined | Object3D<Object3DEventMap>
Searches through an object and its children, starting with the object itself, and returns the first with a matching id.
Parameters
- id: number
  
  Unique number of the object instance. Expects a Integer
Returns undefined | Object3D<Object3DEventMap>

Remarks
Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

See
id
Inherited from THREE.Object3D.getObjectById
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:549

getObjectByName

getObjectByName(name): undefined | Object3D<Object3DEventMap>
Searches through an object and its children, starting with the object itself, and returns the first with a matching name.
Parameters
- name: string
  
  String to match to the children's Object3D.name property.
Returns undefined | Object3D<Object3DEventMap>

Remarks
Note that for most objects the name is an empty string by default You will have to set it manually to make use of this method.
Inherited from THREE.Object3D.getObjectByName
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:557

getObjectByProperty

getObjectByProperty(name, value): undefined | Object3D<Object3DEventMap>
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
Parameters
- name: string
  
  the property name to search for.
- value: any
  
  value of the given property.
Returns undefined | Object3D<Object3DEventMap>
Inherited from THREE.Object3D.getObjectByProperty
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:566

getObjectsByProperty

getObjectsByProperty(name, value, optionalTarget?): Object3D<Object3DEventMap>[]
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
Parameters
- name: string
  
  The property name to search for.
- value: any
  
  Value of the given property.
- Optional optionalTarget: Object3D<Object3DEventMap>[]
  
  target to set the result. Otherwise a new Array is instantiated. If set, you must clear this array prior to each call (i.e., array.length = 0;).
Returns Object3D<Object3DEventMap>[]
Inherited from THREE.Object3D.getObjectsByProperty
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:576

getWorldDirection

getWorldDirection(target): Vector3
Returns a vector representing the direction of object's positive z-axis in world space.
Parameters
- target: Vector3
  
  The result will be copied into this Vector3.
Returns Vector3
Inherited from THREE.Object3D.getWorldDirection
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:600

getWorldPosition

getWorldPosition(target): Vector3
Returns a vector representing the position of the object in world space.
Parameters
- target: Vector3
  
  The result will be copied into this Vector3.
Returns Vector3
Inherited from THREE.Object3D.getWorldPosition
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:582

getWorldQuaternion

getWorldQuaternion(target): Quaternion
Returns a quaternion representing the rotation of the object in world space.
Parameters
- target: Quaternion
  
  The result will be copied into this Quaternion.
Returns Quaternion
Inherited from THREE.Object3D.getWorldQuaternion
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:588

getWorldScale

getWorldScale(target): Vector3
Returns a vector of the scaling factors applied to the object for each axis in world space.
Parameters
- target: Vector3
  
  The result will be copied into this Vector3.
Returns Vector3
Inherited from THREE.Object3D.getWorldScale
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:594

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends keyof Object3DEventMap
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Object3DEventMap[T], T, AbstractSpatialHashGrid>
  
  The function that gets called when the event is fired.
Returns boolean
Inherited from THREE.Object3D.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:62

localToWorld

localToWorld(vector): Vector3
Converts the vector from this object's local space to world space.
Parameters
- vector: Vector3
  
  A vector representing a position in this object's local space.
Returns Vector3
Inherited from THREE.Object3D.localToWorld
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:484

lookAt

lookAt(vector): void
Rotates the object to face a point in world space.
Parameters
- vector: Vector3
  
  A vector representing a position in world space to look at.
Returns void

Remarks
This method does not support objects having non-uniformly-scaled parent(s).
Inherited from THREE.Object3D.lookAt
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:497
lookAt(x, y, z): void
Rotates the object to face a point in world space.
Parameters
- x: number
  
  Expects a Float
- y: number
  
  Expects a Float
- z: number
  
  Expects a Float
Returns void

Remarks
This method does not support objects having non-uniformly-scaled parent(s).
Inherited from THREE.Object3D.lookAt
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:505

onAfterRender

onAfterRender(renderer, scene, camera, geometry, material, group): void
An optional callback that is executed immediately after a 3D object is rendered.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- material: Material
- group: Group<Object3DEventMap>
Returns void

Remarks
This function is called with the following parameters: renderer, scene, camera, geometry, material, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D, Group or Bone are not renderable and thus this callback is not executed for such objects.
Inherited from THREE.Object3D.onAfterRender
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:353

onAfterShadow

onAfterShadow(renderer, scene, camera, shadowCamera, geometry, depthMaterial, group): void
An optional callback that is executed immediately after a 3D object is rendered to a shadow map.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- shadowCamera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- depthMaterial: Material
- group: Group<Object3DEventMap>
Returns void

Remarks
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D, Group or Bone are not renderable and thus this callback is not executed for such objects.
Inherited from THREE.Object3D.onAfterShadow
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:318

onBeforeRender

onBeforeRender(renderer, scene, camera, geometry, material, group): void
An optional callback that is executed immediately before a 3D object is rendered.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- material: Material
- group: Group<Object3DEventMap>
Returns void

Remarks
This function is called with the following parameters: renderer, scene, camera, geometry, material, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D, Group or Bone are not renderable and thus this callback is not executed for such objects.
Inherited from THREE.Object3D.onBeforeRender
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:336

onBeforeShadow

onBeforeShadow(renderer, scene, camera, shadowCamera, geometry, depthMaterial, group): void
An optional callback that is executed immediately before a 3D object is rendered to a shadow map.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- shadowCamera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- depthMaterial: Material
- group: Group<Object3DEventMap>
Returns void

Remarks
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D, Group or Bone are not renderable and thus this callback is not executed for such objects.
Inherited from THREE.Object3D.onBeforeShadow
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:299

raycast

raycast(raycaster, intersects): void
Abstract (empty) method to get intersections between a casted ray and this object
Parameters
- raycaster: Raycaster
- intersects: Intersection<Object3D<Object3DEventMap>>[]
Returns void

Remarks
Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

See
THREE.Raycaster | Raycaster

Default Value
() => {}
Inherited from THREE.Object3D.raycast
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:610

remove

remove(...object): AbstractSpatialHashGrid
Removes a Object3D as child of this Object3D.
Parameters
- Rest ...object: Object3D<Object3DEventMap>[]
Returns AbstractSpatialHashGrid

Remarks
An arbitrary number of objects may be removed.

See
THREE.Group | Group for info on manually grouping objects.
Inherited from THREE.Object3D.remove
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:523

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends keyof Object3DEventMap
Parameters
- type: T
  
  The type of the listener that gets removed.
- listener: EventListener<Object3DEventMap[T], T, AbstractSpatialHashGrid>
  
  The listener function that gets removed.
Returns void
Inherited from THREE.Object3D.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:72

removeFromParent

removeFromParent(): AbstractSpatialHashGrid
Removes this object from its current parent.

Returns AbstractSpatialHashGrid
Inherited from THREE.Object3D.removeFromParent
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:528

rotateOnAxis

rotateOnAxis(axis, angle): AbstractSpatialHashGrid
Rotate an object along an axis in object space.
Parameters
- axis: Vector3
  
  A normalized vector in object space.
- angle: number
  
  The angle in radians. Expects a Float
Returns AbstractSpatialHashGrid

Remarks
The axis is assumed to be normalized.
Inherited from THREE.Object3D.rotateOnAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:425

rotateOnWorldAxis

rotateOnWorldAxis(axis, angle): AbstractSpatialHashGrid
Rotate an object along an axis in world space.
Parameters
- axis: Vector3
  
  A normalized vector in world space.
- angle: number
  
  The angle in radians. Expects a Float
Returns AbstractSpatialHashGrid

Remarks
The axis is assumed to be normalized Method Assumes no rotated parent.
Inherited from THREE.Object3D.rotateOnWorldAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:434

rotateX

rotateX(angle): AbstractSpatialHashGrid
Rotates the object around x axis in local space.
Parameters
- angle: number
Returns AbstractSpatialHashGrid
Inherited from THREE.Object3D.rotateX
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:440

rotateY

rotateY(angle): AbstractSpatialHashGrid
Rotates the object around y axis in local space.
Parameters
- angle: number
Returns AbstractSpatialHashGrid
Inherited from THREE.Object3D.rotateY
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:446

rotateZ

rotateZ(angle): AbstractSpatialHashGrid
Rotates the object around z axis in local space.
Parameters
- angle: number
Returns AbstractSpatialHashGrid
Inherited from THREE.Object3D.rotateZ
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:452

setRotationFromAxisAngle

setRotationFromAxisAngle(axis, angle): void
Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.
Parameters
- axis: Vector3
  
  A normalized vector in object space.
- angle: number
  
  Angle in radians. Expects a Float
Returns void
Inherited from THREE.Object3D.setRotationFromAxisAngle
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:398

setRotationFromEuler

setRotationFromEuler(euler): void
Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.
Parameters
- euler: Euler
  
  Euler angle specifying rotation amount.
Returns void
Inherited from THREE.Object3D.setRotationFromEuler
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:404

setRotationFromMatrix

setRotationFromMatrix(m): void
Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.
Parameters
- m: Matrix4
  
  Rotate the quaternion by the rotation component of the matrix.
Returns void

Remarks
Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).
Inherited from THREE.Object3D.setRotationFromMatrix
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:411

setRotationFromQuaternion

setRotationFromQuaternion(q): void
Copy the given THREE.Quaternion | Quaternion into .quaternion.
Parameters
- q: Quaternion
  
  Normalized Quaternion.
Returns void
Inherited from THREE.Object3D.setRotationFromQuaternion
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:417

toJSON

toJSON(meta?): Object3DJSON
Convert the object to three.js JSON Object/Scene format.
Parameters
- Optional meta: JSONMeta
  
  Object containing metadata such as materials, textures or images for the object.
Returns Object3DJSON
Inherited from THREE.Object3D.toJSON
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:658

translateOnAxis

translateOnAxis(axis, distance): AbstractSpatialHashGrid
Translate an object by distance along an axis in object space
Parameters
- axis: Vector3
  
  A normalized vector in object space.
- distance: number
  
  The distance to translate. Expects a Float
Returns AbstractSpatialHashGrid

Remarks
The axis is assumed to be normalized.
Inherited from THREE.Object3D.translateOnAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:460

translateX

translateX(distance): AbstractSpatialHashGrid
Translates object along x axis in object space by distance units.
Parameters
- distance: number
  
  Expects a Float
Returns AbstractSpatialHashGrid
Inherited from THREE.Object3D.translateX
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:466

translateY

translateY(distance): AbstractSpatialHashGrid
Translates object along y axis in object space by distance units.
Parameters
- distance: number
  
  Expects a Float
Returns AbstractSpatialHashGrid
Inherited from THREE.Object3D.translateY
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:472

translateZ

translateZ(distance): AbstractSpatialHashGrid
Translates object along z axis in object space by distance units.
Parameters
- distance: number
  
  Expects a Float
Returns AbstractSpatialHashGrid
Inherited from THREE.Object3D.translateZ
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:478

traverse

traverse(callback): void
Executes the callback on this object and all descendants.
Parameters
- callback: ((object) => any)
  
  A function with as first argument an Object3D object.
  - - (object): any
    - Parameters
      
      object: Object3D<Object3DEventMap>
      
      Returns any
Returns void

Remarks
Note: Modifying the scene graph inside the callback is discouraged.
Inherited from THREE.Object3D.traverse
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:617

traverseAncestors

traverseAncestors(callback): void
Executes the callback on all ancestors.
Parameters
- callback: ((object) => any)
  
  A function with as first argument an Object3D object.
  - - (object): any
    - Parameters
      
      object: Object3D<Object3DEventMap>
      
      Returns any
Returns void

Remarks
Note: Modifying the scene graph inside the callback is discouraged.
Inherited from THREE.Object3D.traverseAncestors
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:632

traverseVisible

traverseVisible(callback): void
Like traverse, but the callback will only be executed for visible objects
Parameters
- callback: ((object) => any)
  
  A function with as first argument an Object3D object.
  - - (object): any
    - Parameters
      
      object: Object3D<Object3DEventMap>
      
      Returns any
Returns void

Remarks
Descendants of invisible objects are not traversed. Note: Modifying the scene graph inside the callback is discouraged.
Inherited from THREE.Object3D.traverseVisible
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:625

update

update(): AbstractSpatialHashGrid
Updates the spatial hash grid by first updating the bounding box and then updating the hash grid itself.

This method should be called whenever the spatial data changes to ensure the hash grid remains accurate.

Returns AbstractSpatialHashGrid
- Defined in src/spatial/AbstractSpatialHashGrid.ts:118

updateMatrix

updateMatrix(): void
Updates local transform.

Returns void
Inherited from THREE.Object3D.updateMatrix
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:637

updateMatrixWorld

updateMatrixWorld(force?): void
Updates the global transform of the object. And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.
Parameters
- Optional force: boolean
  
  A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame. Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.
Returns void
Inherited from THREE.Object3D.updateMatrixWorld
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:645

updateWorldMatrix

updateWorldMatrix(updateParents, updateChildren): void
Updates the global transform of the object.
Parameters
- updateParents: boolean
  
  Recursively updates global transform of ancestors.
- updateChildren: boolean
  
  Recursively updates global transform of descendants.
Returns void
Inherited from THREE.Object3D.updateWorldMatrix
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:652

worldToLocal

worldToLocal(vector): Vector3
Converts the vector from world space to this object's local space.
Parameters
- vector: Vector3
  
  A vector representing a position in world space.
Returns Vector3
Inherited from THREE.Object3D.worldToLocal
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:490

Class AbstractSpatialHashGrid

Remarks

Example

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AbstractSpatialHashGrid

Properties

Protected _bounds

Protected _box

Protected _boxGroup

Protected _hashGridGroup

animations

Default Value

boundX

boundY

boundZ

castShadow

Default Value

children

See

Default Value

Optional customDepthMaterial

Remarks

Default Value

Optional customDistanceMaterial

Default Value

frustumCulled

Default Value

Readonly id

Remarks

Readonly isObject3D

Remarks

Default Value

isSpatialHashGrid

layers

Remarks

Default Value

matrix

Default Value

matrixAutoUpdate

Default Value

matrixWorld

Remarks

Default Value

matrixWorldAutoUpdate

Default Value

matrixWorldNeedsUpdate

Default Value

Readonly modelViewMatrix

Default Value

name

Remarks

Default Value

Readonly normalMatrix

Default Value

parent

Remarks

Default Value

Readonly position

Default Value

Readonly quaternion

Default Value

receiveShadow

Default Value

renderOrder

Remarks

Default Value

Readonly rotation

Default Value

Readonly scale

Default Value

spatialHashGrid

Readonly type

Remarks

`Protected` _bounds

`Protected` _box

`Protected` _boxGroup

`Protected` _hashGridGroup

`Optional` customDepthMaterial

`Optional` customDistanceMaterial

`Readonly` id

`Readonly` isObject3D

`Readonly` modelViewMatrix

`Readonly` normalMatrix

`Readonly` position

`Readonly` quaternion

`Readonly` rotation

`Readonly` scale

`Readonly` type

`Static` DEFAULT_MATRIX_AUTO_UPDATE

`Static` DEFAULT_MATRIX_WORLD_AUTO_UPDATE

`Static` DEFAULT_UP

`Protected` _updateBox

`Protected` _updateHashGrid

`Rest` ...object: Object3D<Object3DEventMap>[]

`Optional` recursive: boolean

`Optional` recursive: boolean