Array with object's animation clips.
[]
Whether the object gets rendered into shadow map.
false
Array with object's children.
THREE.Object3DGroup | Group for info on manually grouping objects.
[]
Cache with the children objects created from subdivision.
Used to avoid recreate object after simplification and subdivision.
The default value is null. Only used if "cacheTiles" is set to true.
Optional customCustom depth material to be used when rendering to the depth map.
Can only be used in context of meshes.
undefined
Optional customSame as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.
undefined
Flag to indicate if the map node was disposed.
When a map node is disposed its resources are dealocated to save memory.
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.
true
An instance of THREE.BufferGeometry | BufferGeometry (or derived classes), defining the object's structure.
THREE.BufferGeometry | new THREE.BufferGeometry().
If true the tiles will compute their normals.
Size of the grid of the geometry displayed on the scene for each tile.
Flag indicating if the tile height data was loaded.
Readonly idUnique number for this Object3D instance.
Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
Flag to check if the node is a mesh by the renderer.
Used to toggle the visibility of the node. The renderer skips the node rendering if this is set false.
Readonly isFlag to check if a given object is of type Object3D.
This is a constant value
true
The layer membership of the object.
The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.
new THREE.Layers()
Tile level of this node.
Index of the map node in the quad-tree parent node.
Position in the tree parent, can be topLeft, topRight, bottomLeft or bottomRight.
The map view object where the node is placed.
An instance of material derived from the THREE.Material | Material base class or an array of materials, defining the object's appearance.
THREE.MeshBasicMaterial | new THREE.MeshBasicMaterial().
The local transform matrix.
new THREE.Matrix4()
When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property.
DEFAULT_MATRIX_AUTO_UPDATE - that is (true).
The global transform of the object.
If the Object3D has no parent, then it's identical to the local transform THREE.Object3D.matrix | .matrix.
new THREE.Matrix4()
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_MATRIX_WORLD_AUTO_UPDATE - that is (true).
When this is set, it calculates the matrixWorld in that frame and resets this property to false.
false
Readonly modelnew THREE.Matrix4()
Optional morphA dictionary of morphTargets based on the morphTarget.name property.
undefined, but rebuilt by .updateMorphTargets().
Optional morphAn array of weights typically from 0-1 that specify how much of the morph is applied.
undefined, but reset to a blank array by .updateMorphTargets().
Optional name of the object
(doesn't need to be unique).
""
Indicates how many children nodes are loaded.
The child on become visible once all of them are loaded.
Readonly normalnew THREE.Matrix3()
Parent node (from an upper tile level).
Readonly positionObject's local position.
new THREE.Vector3() - that is (0, 0, 0).
Readonly quaternionObject's local rotation as a THREE.Quaternion | Quaternion.
new THREE.Quaternion() - that is (0, 0, 0, 1).
Whether the material receives shadows.
false
This value allows the default rendering order of scene graph objects to be overridden although opaque and transparent objects remain sorted independently.
When this property is set for an instance of Group | Group, all descendants objects will be sorted and rendered together.
0
Readonly rotationObject's local rotation (Euler angles), in radians.
new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).
Readonly scaleThe object's local scale.
new THREE.Vector3( 1, 1, 1 )
Variable to check if the node is subdivided.
To avoid bad visibility changes on node load.
Flag indicating if the tile texture was loaded.
Readonly typeMesh
This is used by the lookAt method, for example, to determine the orientation of the result.
Object3D.DEFAULT_UP - that is (0, 1, 0).
An object that can be used to store custom data about the Object3D.
It should not hold references to functions as these will not be cloned.
{}
Object gets rendered if true.
true
Tile x position.
Tile y position.
Static DEFAULT_Static DEFAULT_Static DEFAULT_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).
new THREE.Vector3( 0, 1, 0)
Static baseBase geometry of the map node.
Static baseBase scale of the map node.
Static childrensHow many children each branch of the tree has.
For a quad-tree this value is 4.
Static defaultDefault height texture applied when tile load fails.
This tile sets the height to sea level where it is common for the data sources to be missing height data.
Static defaultDefault texture used when texture fails to load.
Static geometryMap node plane geometry.
Static geometrySize of the grid of the geometry displayed on the scene for each tile.
Static tileOriginal tile size of the images retrieved from the height provider.
Adds another Object3D as child of this Object3D.
An arbitrary number of objects may be added
Rest ...object: Object3D<Object3DEventMap>[]Adds a listener to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
Applies the rotation represented by the quaternion to the object.
Adds a Object3D as a child of this, while maintaining the object's world transform.
Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).
Removes all child objects.
Returns a clone of this object and optionally all descendants.
Optional recursive: booleanIf true, descendants of the object are also cloned. Default true
Copy the given object into this object
Note: event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.
Optional recursive: booleanIf true, descendants of the object are also copied. Default true
Searches through an object and its children, starting with the object itself, and returns the first with a matching id.
Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
Unique number of the object instance. Expects a Integer
Searches through an object and its children, starting with the object itself, and returns the first with a matching name.
Note that for most objects the name is an empty string by default
String to match to the children's Object3D.name property.
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
the property name to search for.
value of the given property.
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
The property name to search for.
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;).
Checks if listener is added to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
Rotates the object to face a point in world space.
This method does not support objects having non-uniformly-scaled parent(s).
A vector representing a position in world space to look at.
Rotates the object to face a point in world space.
This method does not support objects having non-uniformly-scaled parent(s).
Expects a Float
Expects a Float
Expects a Float
An optional callback that is executed immediately after a 3D object is rendered.
This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
An optional callback that is executed immediately after a 3D object is rendered to a shadow map.
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group.
An optional callback that is executed immediately before a 3D object is rendered.
This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
An optional callback that is executed immediately before a 3D object is rendered to a shadow map.
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group.
Overrides normal raycasting, to avoid raycasting when isMesh is set to false.
Switches the geometry for a simpler one for faster raycasting.
Removes a Object3D as child of this Object3D.
An arbitrary number of objects may be removed.
THREE.Group | Group for info on manually grouping objects.
Rest ...object: Object3D<Object3DEventMap>[]Removes a listener from an event type.
The type of the listener that gets removed.
The listener function that gets removed.
Removes this object from its current parent.
Rotate an object along an axis in object space.
The axis is assumed to be normalized.
A normalized vector in object space.
The angle in radians. Expects a Float
Rotate an object along an axis in world space.
The axis is assumed to be normalized
A normalized vector in world space.
The angle in radians. Expects a Float
Rotates the object around x axis in local space.
Rotates the object around y axis in local space.
Rotates the object around z axis in local space.
Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.
A normalized vector in object space.
Angle in radians. Expects a Float
Calls THREE.Quaternion.setFromEuler | setFromEuler(euler) on the .quaternion.
Euler angle specifying rotation amount.
Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.
Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).
Rotate the quaternion by the rotation component of the matrix.
Copy the given THREE.Quaternion | Quaternion into .quaternion.
Normalized Quaternion.
Convert the object to three.js JSON Object/Scene format.
Optional meta: { Object containing metadata such as materials, textures or images for the object.
Translate an object by distance along an axis in object space
The axis is assumed to be normalized.
A normalized vector in object space.
The distance to translate. Expects a Float
Translates object along x axis in object space by distance units.
Expects a Float
Translates object along y axis in object space by distance units.
Expects a Float
Translates object along z axis in object space by distance units.
Expects a Float
Executes the callback on this object and all descendants.
Note: Modifying the scene graph inside the callback is discouraged.
A function with as first argument an Object3D object.
Executes the callback on all ancestors.
Note: Modifying the scene graph inside the callback is discouraged.
A function with as first argument an Object3D object.
Like traverse, but the callback will only be executed for visible objects
Descendants of invisible objects are not traversed.
A function with as first argument an Object3D object.
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.
Optional force: booleanA 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.
Updates the morphTargets to have no influence on the object
Resets the morphTargetInfluences and morphTargetDictionary properties.
Static prepareGenerated using TypeDoc
Map height node that uses GPU height calculation to generate the deformed plane mesh.
This solution is faster if no mesh interaction is required since all trasnformations are done in the GPU the transformed mesh cannot be accessed for CPU operations (e.g. raycasting).
Param
The parent node of this node.
Param
Map view object where this node is placed.
Param
Position in the node tree relative to the parent.
Param
Zoom level in the tile tree of the node.
Param
X position of the node in the tile tree.
Param
Y position of the node in the tile tree.