[ThreeMap](api-readme.md) > [ThreeMap](api-modules-threemap.md) > [Map](api-classes-threemap.map.md)
## Class: Map
ThreeMap base class
## Hierarchy
`Object3D`
**↳ Map**
### Constructors
* [constructor](api-classes-threemap.map.md#constructor)
### Properties
* [castShadow](api-classes-threemap.map.md#castshadow)
* [children](api-classes-threemap.map.md#children)
* [events](api-classes-threemap.map.md#events)
* [frustumCulled](api-classes-threemap.map.md#frustumculled)
* [id](api-classes-threemap.map.md#id)
* [isObject3D](api-classes-threemap.map.md#isobject3d)
* [layers](api-classes-threemap.map.md#layers)
* [matrix](api-classes-threemap.map.md#matrix)
* [matrixAutoUpdate](api-classes-threemap.map.md#matrixautoupdate)
* [matrixWorld](api-classes-threemap.map.md#matrixworld)
* [matrixWorldNeedsUpdate](api-classes-threemap.map.md#matrixworldneedsupdate)
* [modelViewMatrix](api-classes-threemap.map.md#modelviewmatrix)
* [name](api-classes-threemap.map.md#name)
* [normalMatrix](api-classes-threemap.map.md#normalmatrix)
* [onAfterRender](api-classes-threemap.map.md#onafterrender)
* [onBeforeRender](api-classes-threemap.map.md#onbeforerender)
* [parent](api-classes-threemap.map.md#parent)
* [position](api-classes-threemap.map.md#position)
* [quaternion](api-classes-threemap.map.md#quaternion)
* [receiveShadow](api-classes-threemap.map.md#receiveshadow)
* [renderOrder](api-classes-threemap.map.md#renderorder)
* [rotation](api-classes-threemap.map.md#rotation)
* [scale](api-classes-threemap.map.md#scale)
* [type](api-classes-threemap.map.md#type)
* [up](api-classes-threemap.map.md#up)
* [userData](api-classes-threemap.map.md#userdata)
* [uuid](api-classes-threemap.map.md#uuid)
* [visible](api-classes-threemap.map.md#visible)
* [DefaultMatrixAutoUpdate](api-classes-threemap.map.md#defaultmatrixautoupdate)
* [DefaultUp](api-classes-threemap.map.md#defaultup)
### Methods
* [add](api-classes-threemap.map.md#add)
* [addEventListener](api-classes-threemap.map.md#addeventlistener)
* [applyMatrix](api-classes-threemap.map.md#applymatrix)
* [clone](api-classes-threemap.map.md#clone)
* [copy](api-classes-threemap.map.md#copy)
* [dispatchEvent](api-classes-threemap.map.md#dispatchevent)
* [getObjectById](api-classes-threemap.map.md#getobjectbyid)
* [getObjectByName](api-classes-threemap.map.md#getobjectbyname)
* [getObjectByProperty](api-classes-threemap.map.md#getobjectbyproperty)
* [getWorldDirection](api-classes-threemap.map.md#getworlddirection)
* [getWorldPosition](api-classes-threemap.map.md#getworldposition)
* [getWorldQuaternion](api-classes-threemap.map.md#getworldquaternion)
* [getWorldScale](api-classes-threemap.map.md#getworldscale)
* [hasEventListener](api-classes-threemap.map.md#haseventlistener)
* [localToWorld](api-classes-threemap.map.md#localtoworld)
* [lookAt](api-classes-threemap.map.md#lookat)
* [off](api-classes-threemap.map.md#off)
* [on](api-classes-threemap.map.md#on)
* [raycast](api-classes-threemap.map.md#raycast)
* [registerExtension](api-classes-threemap.map.md#registerextension)
* [remove](api-classes-threemap.map.md#remove)
* [removeEventListener](api-classes-threemap.map.md#removeeventlistener)
* [rotateOnAxis](api-classes-threemap.map.md#rotateonaxis)
* [rotateOnWorldAxis](api-classes-threemap.map.md#rotateonworldaxis)
* [rotateX](api-classes-threemap.map.md#rotatex)
* [rotateY](api-classes-threemap.map.md#rotatey)
* [rotateZ](api-classes-threemap.map.md#rotatez)
* [setRotationFromAxisAngle](api-classes-threemap.map.md#setrotationfromaxisangle)
* [setRotationFromEuler](api-classes-threemap.map.md#setrotationfromeuler)
* [setRotationFromMatrix](api-classes-threemap.map.md#setrotationfrommatrix)
* [setRotationFromQuaternion](api-classes-threemap.map.md#setrotationfromquaternion)
* [toJSON](api-classes-threemap.map.md#tojson)
* [translateOnAxis](api-classes-threemap.map.md#translateonaxis)
* [translateX](api-classes-threemap.map.md#translatex)
* [translateY](api-classes-threemap.map.md#translatey)
* [translateZ](api-classes-threemap.map.md#translatez)
* [traverse](api-classes-threemap.map.md#traverse)
* [traverseAncestors](api-classes-threemap.map.md#traverseancestors)
* [traverseVisible](api-classes-threemap.map.md#traversevisible)
* [updateMatrix](api-classes-threemap.map.md#updatematrix)
* [updateMatrixWorld](api-classes-threemap.map.md#updatematrixworld)
* [worldToLocal](api-classes-threemap.map.md#worldtolocal)
* [lonLatToMerc](api-classes-threemap.map.md#lonlattomerc)
* [mercToLonLat](api-classes-threemap.map.md#merctolonlat)
---
## Constructors
### ⊕ **new Map**(params: *`object`*): [Map](api-classes-threemap.map.md)
*Overrides Object3D.__constructor*
*Defined in [index.ts:40](https://github.com/areknawo/ThreeMap/blob/master/src/index.ts#L40)*
*__example__*: `var map = new ThreeMap({camera: [...], controls: [...], style: [...]});`
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| params | `object` | Object with ThreeJS camera, controls and ThreeMap style configuration object. |
**Returns:** [Map](api-classes-threemap.map.md)
---
## Properties
### castShadow
**● castShadow**: *`boolean`*
*Inherited from Object3D.castShadow*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1615*
Gets rendered into shadow map.
___
### children
**● children**: *`Object3D`[]*
*Inherited from Object3D.children*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1555*
Array with object's children.
___
### events
**● events**: *`EventEmitter.Emitter`*
*Defined in [index.ts:40](https://github.com/areknawo/ThreeMap/blob/master/src/index.ts#L40)*
___
### frustumCulled
**● frustumCulled**: *`boolean`*
*Inherited from Object3D.frustumCulled*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1625*
When this is set, it checks every frame if the object is in the frustum of the camera. Otherwise the object gets drawn every frame even if it isn't visible.
___
### id
**● id**: *`number`*
*Inherited from Object3D.id*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1533*
Unique number of this object instance.
___
### isObject3D
**● isObject3D**: *`boolean`*
*Inherited from Object3D.isObject3D*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1638*
Used to check whether this or derived classes are Object3Ds. Default is true. You should not change this, as it is used internally for optimisation.
___
### layers
**● layers**: *`Layers`*
*Inherited from Object3D.layers*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1606*
___
### matrix
**● matrix**: *`Matrix4`*
*Inherited from Object3D.matrix*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1589*
Local transform.
___
### matrixAutoUpdate
**● matrixAutoUpdate**: *`boolean`*
*Inherited from Object3D.matrixAutoUpdate*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1599*
When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property.
___
### matrixWorld
**● matrixWorld**: *`Matrix4`*
*Inherited from Object3D.matrixWorld*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1594*
The global transform of the object. If the Object3d has no parent, then it's identical to the local transform.
___
### matrixWorldNeedsUpdate
**● matrixWorldNeedsUpdate**: *`boolean`*
*Inherited from Object3D.matrixWorldNeedsUpdate*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1604*
When this is set, it calculates the matrixWorld in that frame and resets this property to false.
___
### modelViewMatrix
**● modelViewMatrix**: *`Matrix4`*
*Inherited from Object3D.modelViewMatrix*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1582*
___
### name
**● name**: *`string`*
*Inherited from Object3D.name*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1543*
Optional name of the object (doesn't need to be unique).
___
### normalMatrix
**● normalMatrix**: *`Matrix3`*
*Inherited from Object3D.normalMatrix*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1584*
___
### onAfterRender
**● onAfterRender**: *`function`*
*Inherited from Object3D.onAfterRender*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1649*
Calls after rendering object
#### Type declaration
►(renderer: *`WebGLRenderer`*, scene: *`Scene`*, camera: *`Camera`*, geometry: *`Geometry`⎮`BufferGeometry`*, material: *`Material`*, group: *`Group`*): `void`
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| renderer | `WebGLRenderer` | - |
| scene | `Scene` | - |
| camera | `Camera` | - |
| geometry | `Geometry`⎮`BufferGeometry` | - |
| material | `Material` | - |
| group | `Group` | - |
**Returns:** `void`
___
### onBeforeRender
**● onBeforeRender**: *`function`*
*Inherited from Object3D.onBeforeRender*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1643*
Calls before rendering object
#### Type declaration
►(renderer: *`WebGLRenderer`*, scene: *`Scene`*, camera: *`Camera`*, geometry: *`Geometry`⎮`BufferGeometry`*, material: *`Material`*, group: *`Group`*): `void`
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| renderer | `WebGLRenderer` | - |
| scene | `Scene` | - |
| camera | `Camera` | - |
| geometry | `Geometry`⎮`BufferGeometry` | - |
| material | `Material` | - |
| group | `Group` | - |
**Returns:** `void`
___
### parent
**● parent**: *`Object3D`*
*Inherited from Object3D.parent*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1550*
Object's parent in the scene graph.
___
### position
**● position**: *`Vector3`*
*Inherited from Object3D.position*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1565*
Object's local position.
___
### quaternion
**● quaternion**: *`Quaternion`*
*Inherited from Object3D.quaternion*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1575*
Global rotation.
___
### receiveShadow
**● receiveShadow**: *`boolean`*
*Inherited from Object3D.receiveShadow*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1620*
Material gets baked in shadow receiving.
___
### renderOrder
**● renderOrder**: *`number`*
*Inherited from Object3D.renderOrder*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1627*
___
### rotation
**● rotation**: *`Euler`*
*Inherited from Object3D.rotation*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1570*
Object's local rotation (Euler angles), in radians.
___
### scale
**● scale**: *`Vector3`*
*Inherited from Object3D.scale*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1580*
Object's local scale.
___
### type
**● type**: *`string`*
*Inherited from Object3D.type*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1545*
___
### up
**● up**: *`Vector3`*
*Inherited from Object3D.up*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1560*
Up direction.
___
### userData
**● userData**: *`any`*
*Inherited from Object3D.userData*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1632*
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.
___
### uuid
**● uuid**: *`string`*
*Inherited from Object3D.uuid*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1538*
___
### visible
**● visible**: *`boolean`*
*Inherited from Object3D.visible*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1610*
Object gets rendered if true.
___
### «Static» DefaultMatrixAutoUpdate
**● DefaultMatrixAutoUpdate**: *`boolean`*
*Inherited from Object3D.DefaultMatrixAutoUpdate*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1656*
___
### «Static» DefaultUp
**● DefaultUp**: *`Vector3`*
*Inherited from Object3D.DefaultUp*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1655*
___
## Methods
### add
► **add**(...object: *`Object3D`[]*): `void`
*Inherited from Object3D.add*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1761*
Adds object as child of this object.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| object | `Object3D`[] | - |
**Returns:** `void`
___
### addEventListener
► **addEventListener**(type: *`string`*, listener: *`function`*): `void`
*Inherited from EventDispatcher.addEventListener*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1078*
Adds a listener to an event type.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| type | `string` | The type of the listener that gets removed. |
| listener | `function` | The listener function that gets removed. |
**Returns:** `void`
___
### applyMatrix
► **applyMatrix**(matrix: *`Matrix4`*): `void`
*Inherited from Object3D.applyMatrix*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1661*
This updates the position, rotation and scale with the matrix.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| matrix | `Matrix4` | - |
**Returns:** `void`
___
### clone
► **clone**(recursive?: *`boolean`*): `this`
*Inherited from Object3D.clone*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1807*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| recursive | `boolean` | - |
**Returns:** `this`
___
### copy
► **copy**(source: *`this`*, recursive?: *`boolean`*): `this`
*Inherited from Object3D.copy*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1814*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| source | `this` | - |
| recursive | `boolean` | - |
**Returns:** `this`
___
### dispatchEvent
► **dispatchEvent**(event: *`object`*): `void`
*Inherited from EventDispatcher.dispatchEvent*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1098*
Fire an event type.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| event | `object` | - |
**Returns:** `void`
___
### getObjectById
► **getObjectById**(id: *`number`*): `Object3D`
*Inherited from Object3D.getObjectById*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1772*
Searches through the object's children and returns the first with a matching id, optionally recursive.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| id | `number` | Unique number of the object instance |
**Returns:** `Object3D`
___
### getObjectByName
► **getObjectByName**(name: *`string`*): `Object3D`
*Inherited from Object3D.getObjectByName*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1778*
Searches through the object's children and returns the first with a matching name, optionally recursive.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| name | `string` | String to match to the children's Object3d.name property. |
**Returns:** `Object3D`
___
### getObjectByProperty
► **getObjectByProperty**(name: *`string`*, value: *`string`*): `Object3D`
*Inherited from Object3D.getObjectByProperty*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1780*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| name | `string` | - |
| value | `string` | - |
**Returns:** `Object3D`
___
### getWorldDirection
► **getWorldDirection**(target: *`Vector3`*): `Vector3`
*Inherited from Object3D.getWorldDirection*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1785*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| target | `Vector3` | - |
**Returns:** `Vector3`
___
### getWorldPosition
► **getWorldPosition**(target: *`Vector3`*): `Vector3`
*Inherited from Object3D.getWorldPosition*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1782*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| target | `Vector3` | - |
**Returns:** `Vector3`
___
### getWorldQuaternion
► **getWorldQuaternion**(target: *`Quaternion`*): `Quaternion`
*Inherited from Object3D.getWorldQuaternion*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1783*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| target | `Quaternion` | - |
**Returns:** `Quaternion`
___
### getWorldScale
► **getWorldScale**(target: *`Vector3`*): `Vector3`
*Inherited from Object3D.getWorldScale*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1784*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| target | `Vector3` | - |
**Returns:** `Vector3`
___
### hasEventListener
► **hasEventListener**(type: *`string`*, listener: *`function`*): `void`
*Inherited from EventDispatcher.hasEventListener*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1085*
Adds a listener to an event type.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| type | `string` | The type of the listener that gets removed. |
| listener | `function` | The listener function that gets removed. |
**Returns:** `void`
___
### localToWorld
► **localToWorld**(vector: *`Vector3`*): `Vector3`
*Inherited from Object3D.localToWorld*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1743*
Updates the vector from local space to world space.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| vector | `Vector3` | A local vector. |
**Returns:** `Vector3`
___
### lookAt
► **lookAt**(vector: *`Vector3`*): `void`
► **lookAt**(x: *`number`*, y: *`number`*, z: *`number`*): `void`
*Inherited from Object3D.lookAt*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1755*
Rotates object to face point in space.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| vector | `Vector3` | A world vector to look at. |
**Returns:** `void`
*Inherited from Object3D.lookAt*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1756*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| x | `number` | - |
| y | `number` | - |
| z | `number` | - |
**Returns:** `void`
___
### off
► **off**(event: *`string`*, callback: *`function`*): `void`
*Defined in [index.ts:96](https://github.com/areknawo/ThreeMap/blob/master/src/index.ts#L96)*
Unregister ThreeMap's event listener.
*__example__*: `map.off('tileCreated', (e) => console.log(e));`
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| event | `string` | Event's name. |
| callback | `function` | Event's associated callback. |
**Returns:** `void`
___
### on
► **on**(event: *`string`*, callback: *`function`*): `void`
*Defined in [index.ts:108](https://github.com/areknawo/ThreeMap/blob/master/src/index.ts#L108)*
Register ThreeMap's event listener.
*__example__*: `map.on('tileCreated', (e) => console.log(e));` ```
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| event | `string` | Event's name. |
| callback | `function` | Event's callback. |
**Returns:** `void`
___
### raycast
► **raycast**(raycaster: *`Raycaster`*, intersects: *`any`*): `void`
*Inherited from Object3D.raycast*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1787*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| raycaster | `Raycaster` | - |
| intersects | `any` | - |
**Returns:** `void`
___
### registerExtension
► **registerExtension**(ext: *[Extension](api-classes-extension.extension-1.md)*): `void`
*Defined in [index.ts:119](https://github.com/areknawo/ThreeMap/blob/master/src/index.ts#L119)*
Registers new ThreeMap's extensions.
*__example__*: `map.register(new ThreeMap.Extension({...}));` ```
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| ext | [Extension](api-classes-extension.extension-1.md) | ThreeMap's Extension class instance. |
**Returns:** `void`
___
### remove
► **remove**(...object: *`Object3D`[]*): `void`
*Inherited from Object3D.remove*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1766*
Removes object as child of this object.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| object | `Object3D`[] | - |
**Returns:** `void`
___
### removeEventListener
► **removeEventListener**(type: *`string`*, listener: *`function`*): `void`
*Inherited from EventDispatcher.removeEventListener*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1092*
Removes a listener from an event type.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| type | `string` | The type of the listener that gets removed. |
| listener | `function` | The listener function that gets removed. |
**Returns:** `void`
___
### rotateOnAxis
► **rotateOnAxis**(axis: *`Vector3`*, angle: *`number`*): `Object3D`
*Inherited from Object3D.rotateOnAxis*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1688*
Rotate an object along an axis in object space. The axis is assumed to be normalized.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| axis | `Vector3` | A normalized vector in object space. |
| angle | `number` | The angle in radians. |
**Returns:** `Object3D`
___
### rotateOnWorldAxis
► **rotateOnWorldAxis**(axis: *`Vector3`*, angle: *`number`*): `Object3D`
*Inherited from Object3D.rotateOnWorldAxis*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1695*
Rotate an object along an axis in world space. The axis is assumed to be normalized. Method Assumes no rotated parent.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| axis | `Vector3` | A normalized vector in object space. |
| angle | `number` | The angle in radians. |
**Returns:** `Object3D`
___
### rotateX
► **rotateX**(angle: *`number`*): `Object3D`
*Inherited from Object3D.rotateX*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1701*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| angle | `number` | - |
**Returns:** `Object3D`
___
### rotateY
► **rotateY**(angle: *`number`*): `Object3D`
*Inherited from Object3D.rotateY*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1707*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| angle | `number` | - |
**Returns:** `Object3D`
___
### rotateZ
► **rotateZ**(angle: *`number`*): `Object3D`
*Inherited from Object3D.rotateZ*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1713*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| angle | `number` | - |
**Returns:** `Object3D`
___
### setRotationFromAxisAngle
► **setRotationFromAxisAngle**(axis: *`Vector3`*, angle: *`number`*): `void`
*Inherited from Object3D.setRotationFromAxisAngle*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1666*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| axis | `Vector3` | - |
| angle | `number` | - |
**Returns:** `void`
___
### setRotationFromEuler
► **setRotationFromEuler**(euler: *`Euler`*): `void`
*Inherited from Object3D.setRotationFromEuler*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1671*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| euler | `Euler` | - |
**Returns:** `void`
___
### setRotationFromMatrix
► **setRotationFromMatrix**(m: *`Matrix4`*): `void`
*Inherited from Object3D.setRotationFromMatrix*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1676*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| m | `Matrix4` | - |
**Returns:** `void`
___
### setRotationFromQuaternion
► **setRotationFromQuaternion**(q: *`Quaternion`*): `void`
*Inherited from Object3D.setRotationFromQuaternion*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1681*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| q | `Quaternion` | - |
**Returns:** `void`
___
### toJSON
► **toJSON**(meta?: *`object`*): `any`
*Inherited from Object3D.toJSON*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1805*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| meta | `object` | - |
**Returns:** `any`
___
### translateOnAxis
► **translateOnAxis**(axis: *`Vector3`*, distance: *`number`*): `Object3D`
*Inherited from Object3D.translateOnAxis*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1719*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| axis | `Vector3` | A normalized vector in object space. |
| distance | `number` | The distance to translate. |
**Returns:** `Object3D`
___
### translateX
► **translateX**(distance: *`number`*): `Object3D`
*Inherited from Object3D.translateX*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1725*
Translates object along x axis by distance.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| distance | `number` | Distance. |
**Returns:** `Object3D`
___
### translateY
► **translateY**(distance: *`number`*): `Object3D`
*Inherited from Object3D.translateY*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1731*
Translates object along y axis by distance.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| distance | `number` | Distance. |
**Returns:** `Object3D`
___
### translateZ
► **translateZ**(distance: *`number`*): `Object3D`
*Inherited from Object3D.translateZ*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1737*
Translates object along z axis by distance.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| distance | `number` | Distance. |
**Returns:** `Object3D`
___
### traverse
► **traverse**(callback: *`function`*): `void`
*Inherited from Object3D.traverse*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1789*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| callback | `function` | - |
**Returns:** `void`
___
### traverseAncestors
► **traverseAncestors**(callback: *`function`*): `void`
*Inherited from Object3D.traverseAncestors*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1793*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| callback | `function` | - |
**Returns:** `void`
___
### traverseVisible
► **traverseVisible**(callback: *`function`*): `void`
*Inherited from Object3D.traverseVisible*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1791*
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| callback | `function` | - |
**Returns:** `void`
___
### updateMatrix
► **updateMatrix**(): `void`
*Inherited from Object3D.updateMatrix*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1798*
Updates local transform.
**Returns:** `void`
___
### updateMatrixWorld
► **updateMatrixWorld**(force: *`boolean`*): `void`
*Inherited from Object3D.updateMatrixWorld*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1803*
Updates global transform of the object and its children.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| force | `boolean` | - |
**Returns:** `void`
___
### worldToLocal
► **worldToLocal**(vector: *`Vector3`*): `Vector3`
*Inherited from Object3D.worldToLocal*
*Defined in /home/arek/Desktop/ThreeMap/node_modules/@types/three/three-core.d.ts:1749*
Updates the vector from world space to local space.
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| vector | `Vector3` | A world vector. |
**Returns:** `Vector3`
___
### «Static» lonLatToMerc
► **lonLatToMerc**(latlng: *`number`[]*): `number`[]
*Defined in [index.ts:25](https://github.com/areknawo/ThreeMap/blob/master/src/index.ts#L25)*
Convert longitude - latitude coordinates to mercator coordinates.
*__example__*: `ThreeMap.lonlatToMerc([77.35262, 40.2525]);`
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| latlng | `number`[] | Array of longitude & latitude coordinates. |
**Returns:** `number`[]
Array of mercator x & y coordinates.
___
### «Static» mercToLonLat
► **mercToLonLat**(mercXY: *`number`[]*): `number`[]
*Defined in [index.ts:36](https://github.com/areknawo/ThreeMap/blob/master/src/index.ts#L36)*
Convert mercator coordinates to longitude - latitude coordinates.
*__example__*: `ThreeMap.mercToLonLat([462073.1353, 295052.562]);`
**Parameters:**
| Param | Type | Description |
| ------ | ------ | ------ |
| mercXY | `number`[] | Array of mercator x & y coordinates. |
**Returns:** `number`[]
Array of longitude & latitude coordinates.
___