Constructor for the map view objects.
Map view node modes can be SPHERICAL, HEIGHT or PLANAR. PLANAR is used by default. Can also be a custom MapNode instance.
Map color tile provider by default a OSM maps provider is used if none specified.
Map height tile provider, by default no height provider is used.
Array with object's animation clips.
[]
Indicate if the nodes should cache its children when it is simplified. Nodes that are no longer in use should be kept in memory.
Usefull for fast moving scenarios to prevent reparsing data in fast moving scenes.
Should only be used if the child generation process is time consuming. Should be kept off unless required.
Whether the object gets rendered into shadow map.
false
Array with object's children.
THREE.Object3DGroup | Group for info on manually grouping objects.
[]
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
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().
Map height (terrain elevation) layer provider.
Only used for HEIGHT, HEIGHT_SHADER and MARTINI map modes.
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.
Readonly isRead-only flag to check if a given object is of type Mesh.
This is a constant value
true
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()
LOD control object used to defined how tiles are loaded in and out of memory.
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).
""
Readonly normalnew THREE.Matrix3()
Ajust node configuration depending on the camera distance.
Called everytime automatically before render by the renderer.
Readonly positionObject's local position.
new THREE.Vector3() - that is (0, 0, 0).
Map tile color layer provider.
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
Define the type of map node in use, defined how the map is presented.
Should only be set on creation.
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 )
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
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 HEIGHTPlanar map projection with height deformation.
Static HEIGHT_Planar map projection with height deformation using the GPU for height generation.
Static MARTINIRTIN map mode.
Static PLANARPlanar map projection.
Static SPHERICALSpherical map projection.
Static mapMap of the map node types available.
Adds a listener to an event type.
The type of event to listen to.
The function that gets called when the event is fired.
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 to a shadow map.
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group.
Removes a listener from an event type.
The type of the listener that gets removed.
The listener function that gets removed.
Change the map height provider of this map view.
Will discard all the tiles already loaded using the old provider.
Change the map provider of this map view.
Will discard all the tiles already loaded using the old provider.
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
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.
Generated using TypeDoc
Map viewer is used to read and display map tiles from a server.
It was designed to work with a OpenMapTiles but can also be used with another map tiles.
The map is drawn in plane map nodes using a quad tree that is subdivided as necessary to guaratee good map quality.