Class MapPlaneNode

Represents a basic plane tile node.

Hierarchy

MapNode
- MapPlaneNode

Index

Constructors

constructor

Constructors

constructor

new MapPlaneNode(parentNode?: any, mapView?: any, location?: number, level?: number, x?: number, y?: number): MapPlaneNode
Parameters
- parentNode: any = null
- mapView: any = null
- location: number = QuadTreePosition.root
- level: number = 0
- x: number = 0
- y: number = 0
Returns MapPlaneNode
Overrides MapNode.constructor
- Defined in source/nodes/MapPlaneNode.ts:10

Properties

animations

animations: AnimationClip[]

Array with object's animation clips.

Default Value

[]

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

[]

childrenCache

childrenCache: Object3D<Object3DEventMap>[] = null

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` customDepthMaterial

customDepthMaterial?: Material

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

Remarks

Can only be used in context of meshes.

Default Value

undefined

`Optional` customDistanceMaterial

customDistanceMaterial?: Material

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

Default Value

undefined

disposed

disposed: boolean = false

Flag to indicate if the map node was disposed.

When a map node is disposed its resources are dealocated to save memory.

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

geometry

geometry: BufferGeometry<NormalBufferAttributes>

An instance of THREE.BufferGeometry | BufferGeometry (or derived classes), defining the object's structure.

Default Value

THREE.BufferGeometry | new THREE.BufferGeometry().

`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.

isMesh

isMesh: true = true

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` isObject3D

isObject3D: true

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

Remarks

This is a constant value

Default Value

true

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.

Default Value

new THREE.Layers()

level

level: number

Tile level of this node.

location

location: number

Index of the map node in the quad-tree parent node.

Position in the tree parent, can be topLeft, topRight, bottomLeft or bottomRight.

mapView

mapView: MapView = null

The map view object where the node is placed.

material

material: Material | Material[]

An instance of material derived from the THREE.Material | Material base class or an array of materials, defining the object's appearance.

Default Value

THREE.MeshBasicMaterial | new THREE.MeshBasicMaterial().

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()

`Optional` morphTargetDictionary

morphTargetDictionary?: {
[key: string]: number;
}

A dictionary of morphTargets based on the morphTarget.name property.

Default Value

undefined, but rebuilt by .updateMorphTargets().

Type declaration

[key: string]: number

`Optional` morphTargetInfluences

morphTargetInfluences?: number[]

An array of weights typically from 0-1 that specify how much of the morph is applied.

Default Value

undefined, but reset to a blank array by .updateMorphTargets().

name

name: string

Optional name of the object

Remarks

(doesn't need to be unique).

Default Value

""

nodesLoaded

nodesLoaded: number = 0

Indicates how many children nodes are loaded.

The child on become visible once all of them are loaded.

`Readonly` normalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

parent

parent: Object3D<Object3DEventMap>

Object's parent in the scene graph.

Remarks

An object can have at most one parent.

Default Value

null

parentNode

parentNode: MapNode = null

Parent node (from an upper tile level).

`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.

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 )

subdivided

subdivided: boolean = false

Variable to check if the node is subdivided.

To avoid bad visibility changes on node load.

`Readonly` type

type: string

Default Value

Mesh

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

x

x: number

Tile x position.

y

y: number

Tile y position.

`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)

`Static` baseGeometry

baseGeometry: BufferGeometry<NormalBufferAttributes> = MapPlaneNode.geometry

Base geometry is attached to the map viewer object.

It should have the full size of the world so that operations over the MapView bounding box/sphere work correctly.

`Static` baseScale

baseScale: Vector3 = ...

Base scale applied to the map viewer object.

`Static` childrens

childrens: number = 4

How many children each branch of the tree has.

For a quad-tree this value is 4.

`Static` defaultTexture

defaultTexture: Texture = ...

Default texture used when texture fails to load.

`Static` geometry

geometry: BufferGeometry<NormalBufferAttributes> = ...

Map node plane geometry.

Methods

add

add(...object: Object3D<Object3DEventMap>[]): MapPlaneNode
Adds another Object3D as child of this Object3D.

Remarks
An arbitrary number of objects may be added

See
- attach
- THREE.Group | Group for info on manually grouping objects.
Parameters
- Rest ...object: Object3D<Object3DEventMap>[]
Returns MapPlaneNode
Inherited from MapNode.add
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:451

addEventListener

addEventListener<T>(type: T, listener: EventListener<Object3DEventMap[T], T, MapPlaneNode>): 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, MapPlaneNode>
  
  The function that gets called when the event is fired.
Returns void
Inherited from MapNode.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:52
addEventListener<T>(type: T, listener: EventListener<{}, T, MapPlaneNode>): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, MapPlaneNode>
Returns void
Inherited from MapNode.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:56

applyMatrix4

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

applyQuaternion

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

applyTexture

applyTexture(image: HTMLImageElement): Promise<void>
Parameters
- image: HTMLImageElement
Returns Promise<void>
Inherited from MapNode.applyTexture
- Defined in source/nodes/MapNode.ts:281

attach

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

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

See
add
Parameters
- object: Object3D<Object3DEventMap>
Returns MapPlaneNode
Inherited from MapNode.attach
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:477

clear

clear(): MapPlaneNode
Removes all child objects.

Returns MapPlaneNode
Inherited from MapNode.clear
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:469

clone

clone(recursive?: boolean): MapPlaneNode
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 MapPlaneNode
Inherited from MapNode.clone
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:600

copy

copy(source: MapPlaneNode, recursive?: boolean): MapPlaneNode
Copy the given object into this object

Remarks
Note: event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.
Parameters
- source: MapPlaneNode
- Optional recursive: boolean
  
  If true, descendants of the object are also copied. Default true
Returns MapPlaneNode
Inherited from MapNode.copy
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:608

createChildNodes

createChildNodes(): void
Create the child nodes to represent the next tree level.

These nodes should be added to the object, and their transformations matrix should be updated.

Returns void
Overrides MapNode.createChildNodes
- Defined in source/nodes/MapPlaneNode.ts:37

dispatchEvent

dispatchEvent<T>(event: BaseEvent<T> & Object3DEventMap[T]): 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 MapNode.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:84

dispose

dispose(): void
Dispose the map node and its resources.

Should cancel all pending processing for the node.

Returns void
Inherited from MapNode.dispose
- Defined in source/nodes/MapNode.ts:352

getObjectById

getObjectById(id: number): Object3D<Object3DEventMap>
Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

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

See
id
Parameters
- id: number
  
  Unique number of the object instance. Expects a Integer
Returns Object3D<Object3DEventMap>
Inherited from MapNode.getObjectById
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:485

getObjectByName

getObjectByName(name: string): Object3D<Object3DEventMap>
Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

Remarks
Note that for most objects the name is an empty string by default
Parameters
- name: string
  
  String to match to the children's Object3D.name property.
Returns Object3D<Object3DEventMap>
Inherited from MapNode.getObjectByName
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:493

getObjectByProperty

getObjectByProperty(name: string, value: any): 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 Object3D<Object3DEventMap>
Inherited from MapNode.getObjectByProperty
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:502

getObjectsByProperty

getObjectsByProperty(name: string, value: any, optionalTarget?: Object3D<Object3DEventMap>[]): 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 MapNode.getObjectsByProperty
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:512

getVertexPosition

getVertexPosition(index: number, target: Vector3): Vector3
Get the local-space position of the vertex at the given index, taking into account the current animation state of both morph targets and skinning.
Parameters
- index: number
  
  Expects a Integer
- target: Vector3
Returns Vector3
Inherited from MapNode.getVertexPosition
- Defined in node_modules/@types/three/src/objects/Mesh.d.ts:84

getWorldDirection

getWorldDirection(target: Vector3): 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 MapNode.getWorldDirection
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:536

getWorldPosition

getWorldPosition(target: Vector3): 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 MapNode.getWorldPosition
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:518

getWorldQuaternion

getWorldQuaternion(target: Quaternion): 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 MapNode.getWorldQuaternion
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:524

getWorldScale

getWorldScale(target: Vector3): 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 MapNode.getWorldScale
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:530

hasEventListener

hasEventListener<T>(type: T, listener: EventListener<Object3DEventMap[T], T, MapPlaneNode>): 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, MapPlaneNode>
  
  The function that gets called when the event is fired.
Returns boolean
Inherited from MapNode.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:63
hasEventListener<T>(type: T, listener: EventListener<{}, T, MapPlaneNode>): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, MapPlaneNode>
Returns boolean
Inherited from MapNode.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:67

initialize

initialize(): Promise<void>
Initialize resources that require access to data from the MapView.

Called automatically by the constructor for child nodes and MapView when a root node is attached to it.

Returns Promise<void>
Overrides MapNode.initialize
- Defined in source/nodes/MapPlaneNode.ts:28

loadData

loadData(): Promise<void>
Load tile texture from the server.

This base method assumes the existence of a material attribute with a map texture.

Returns Promise<void>
Inherited from MapNode.loadData
- Defined in source/nodes/MapNode.ts:246

localToWorld

localToWorld(vector: Vector3): 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 MapNode.localToWorld
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:420

lookAt

lookAt(vector: Vector3): void
Rotates the object to face a point in world space.

Remarks
This method does not support objects having non-uniformly-scaled parent(s).
Parameters
- vector: Vector3
  
  A vector representing a position in world space to look at.
Returns void
Inherited from MapNode.lookAt
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:433
lookAt(x: number, y: number, z: number): void
Rotates the object to face a point in world space.

Remarks
This method does not support objects having non-uniformly-scaled parent(s).
Parameters
- x: number
  
  Expects a Float
- y: number
  
  Expects a Float
- z: number
  
  Expects a Float
Returns void
Inherited from MapNode.lookAt
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:441

nodeReady

nodeReady(): void
Increment the child loaded counter.

Should be called after a map node is ready for display.

Returns void
Inherited from MapNode.nodeReady
- Defined in source/nodes/MapNode.ts:308

onAfterRender

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

Remarks
This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- material: Material
- group: Group<Object3DEventMap>
Returns void
Inherited from MapNode.onAfterRender
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:289

onAfterShadow

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

Remarks
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- shadowCamera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- depthMaterial: Material
- group: Group<Object3DEventMap>
Returns void
Inherited from MapNode.onAfterShadow
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:255

onBeforeRender

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

Remarks
This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- material: Material
- group: Group<Object3DEventMap>
Returns void
Inherited from MapNode.onBeforeRender
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:272

onBeforeShadow

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

Remarks
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- shadowCamera: Camera
- geometry: BufferGeometry<NormalBufferAttributes>
- depthMaterial: Material
- group: Group<Object3DEventMap>
Returns void
Inherited from MapNode.onBeforeShadow
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:237

raycast

raycast(raycaster: Raycaster, intersects: Intersection<Object3D<Object3DEventMap>>[]): void
Overrides normal raycasting, to avoid raycasting when isMesh is set to false.
Parameters
- raycaster: Raycaster
- intersects: Intersection<Object3D<Object3DEventMap>>[]
Returns void
Overrides MapNode.raycast
- Defined in source/nodes/MapPlaneNode.ts:77

remove

remove(...object: Object3D<Object3DEventMap>[]): MapPlaneNode
Removes a Object3D as child of this Object3D.

Remarks
An arbitrary number of objects may be removed.

See
THREE.Group | Group for info on manually grouping objects.
Parameters
- Rest ...object: Object3D<Object3DEventMap>[]
Returns MapPlaneNode
Inherited from MapNode.remove
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:459

removeEventListener

removeEventListener<T>(type: T, listener: EventListener<Object3DEventMap[T], T, MapPlaneNode>): 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, MapPlaneNode>
  
  The listener function that gets removed.
Returns void
Inherited from MapNode.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:74
removeEventListener<T>(type: T, listener: EventListener<{}, T, MapPlaneNode>): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, MapPlaneNode>
Returns void
Inherited from MapNode.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:78

removeFromParent

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

Returns MapPlaneNode
Inherited from MapNode.removeFromParent
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:464

rotateOnAxis

rotateOnAxis(axis: Vector3, angle: number): MapPlaneNode
Rotate an object along an axis in object space.

Remarks
The axis is assumed to be normalized.
Parameters
- axis: Vector3
  
  A normalized vector in object space.
- angle: number
  
  The angle in radians. Expects a Float
Returns MapPlaneNode
Inherited from MapNode.rotateOnAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:361

rotateOnWorldAxis

rotateOnWorldAxis(axis: Vector3, angle: number): MapPlaneNode
Rotate an object along an axis in world space.

Remarks
The axis is assumed to be normalized
Parameters
- axis: Vector3
  
  A normalized vector in world space.
- angle: number
  
  The angle in radians. Expects a Float
Returns MapPlaneNode
Inherited from MapNode.rotateOnWorldAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:370

rotateX

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

rotateY

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

rotateZ

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

setRotationFromAxisAngle

setRotationFromAxisAngle(axis: Vector3, angle: number): 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 MapNode.setRotationFromAxisAngle
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:334

setRotationFromEuler

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

setRotationFromMatrix

setRotationFromMatrix(m: Matrix4): void
Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.

Remarks
Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).
Parameters
- m: Matrix4
  
  Rotate the quaternion by the rotation component of the matrix.
Returns void
Inherited from MapNode.setRotationFromMatrix
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:347

setRotationFromQuaternion

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

simplify

simplify(): void
Simplify node, remove all children from node, store them in cache.

Reset the subdivided flag and restore the visibility.

This base method assumes that the node implementation is based off Mesh and that the isMesh property is used to toggle visibility.

Returns void
Inherited from MapNode.simplify
- Defined in source/nodes/MapNode.ts:212

subdivide

subdivide(): void
Subdivide node,check the maximum depth allowed for the tile provider.

Uses the createChildNodes() method to actually create the child nodes that represent the next tree level.

Returns void
Inherited from MapNode.subdivide
- Defined in source/nodes/MapNode.ts:182

toJSON

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

translateOnAxis

translateOnAxis(axis: Vector3, distance: number): MapPlaneNode
Translate an object by distance along an axis in object space

Remarks
The axis is assumed to be normalized.
Parameters
- axis: Vector3
  
  A normalized vector in object space.
- distance: number
  
  The distance to translate. Expects a Float
Returns MapPlaneNode
Inherited from MapNode.translateOnAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:396

translateX

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

translateY

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

translateZ

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

traverse

traverse(callback: ((object: Object3D<Object3DEventMap>) => any)): void
Executes the callback on this object and all descendants.

Remarks
Note: Modifying the scene graph inside the callback is discouraged.
Parameters
- callback: ((object: Object3D<Object3DEventMap>) => any)
  
  A function with as first argument an Object3D object.
  - - (object: Object3D<Object3DEventMap>): any
    - Parameters
      
      object: Object3D<Object3DEventMap>
      
      Returns any
Returns void
Inherited from MapNode.traverse
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:553

traverseAncestors

traverseAncestors(callback: ((object: Object3D<Object3DEventMap>) => any)): void
Executes the callback on all ancestors.

Remarks
Note: Modifying the scene graph inside the callback is discouraged.
Parameters
- callback: ((object: Object3D<Object3DEventMap>) => any)
  
  A function with as first argument an Object3D object.
  - - (object: Object3D<Object3DEventMap>): any
    - Parameters
      
      object: Object3D<Object3DEventMap>
      
      Returns any
Returns void
Inherited from MapNode.traverseAncestors
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:568

traverseVisible

traverseVisible(callback: ((object: Object3D<Object3DEventMap>) => any)): void
Like traverse, but the callback will only be executed for visible objects

Remarks
Descendants of invisible objects are not traversed.
Parameters
- callback: ((object: Object3D<Object3DEventMap>) => any)
  
  A function with as first argument an Object3D object.
  - - (object: Object3D<Object3DEventMap>): any
    - Parameters
      
      object: Object3D<Object3DEventMap>
      
      Returns any
Returns void
Inherited from MapNode.traverseVisible
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:561

updateMatrix

updateMatrix(): void
Updates local transform.

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

updateMatrixWorld

updateMatrixWorld(force?: boolean): 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 MapNode.updateMatrixWorld
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:581

updateMorphTargets

updateMorphTargets(): void
Updates the morphTargets to have no influence on the object

Remarks
Resets the morphTargetInfluences and morphTargetDictionary properties.

Returns void
Inherited from MapNode.updateMorphTargets
- Defined in node_modules/@types/three/src/objects/Mesh.d.ts:76

updateWorldMatrix

updateWorldMatrix(updateParents: boolean, updateChildren: boolean): 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 MapNode.updateWorldMatrix
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:588

worldToLocal

worldToLocal(vector: Vector3): 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 MapNode.worldToLocal
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:426

Class MapPlaneNode

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

parentNode: any = null

mapView: any = null

location: number = QuadTreePosition.root

level: number = 0

x: number = 0

y: number = 0

Returns MapPlaneNode

Properties

animations

Default Value

castShadow

Default Value

children

See

Default Value

childrenCache

Optional customDepthMaterial

Remarks

Default Value

Optional customDistanceMaterial

Default Value

disposed

frustumCulled

Default Value

geometry

Default Value

Readonly id

Remarks

isMesh

Readonly isObject3D

Remarks

Default Value

layers

Remarks

Default Value

level

location

mapView

material

Default Value

matrix

Default Value

matrixAutoUpdate

Default Value

matrixWorld

Remarks

Default Value

matrixWorldAutoUpdate

Default Value

matrixWorldNeedsUpdate

Default Value

Readonly modelViewMatrix

Default Value

Optional morphTargetDictionary

Default Value

Type declaration

[key: string]: number

Optional morphTargetInfluences

Default Value

name

Remarks

Default Value

nodesLoaded

Readonly normalMatrix

Default Value

parent

Remarks

Default Value

parentNode

Readonly position

Default Value

`Optional` customDepthMaterial

`Optional` customDistanceMaterial

`Readonly` id

`Readonly` isObject3D

`Readonly` modelViewMatrix

`Optional` morphTargetDictionary

`Optional` morphTargetInfluences

`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

`Static` baseGeometry

`Static` baseScale

`Static` childrens

`Static` defaultTexture

`Static` geometry

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