Mapspace API Reference

Class: CubicPanoramaTile

CubicPanoramaTile

A cubic panorama tile object is an object that renders one tile for a cubic panorama.

new CubicPanoramaTile(options)

Parameters:
Name Type Description
options Mapspace.street.CubicPanoramaTileOptions

Options.
Source:
mapspace-street/sceneobjects/cubicpanoramatile.js
Fires:
  • ol.events.Event#event:objectchanged
  • ol.events.Event#event:ready

Extends

Members

children :Array.<SceneObject>

The SceneObjects children of this object. Any SceneObject can have any number of SceneObject children in its own hierachy.

Inherited From:
Source:
mapspace-street/sceneobjects/sceneobject.js

object3D :THREE.Object3D

The THREE.Object3D that contains this SceneObject. Each SceneObject can contain one and only one THREE.Object3D, but any THREE.Object3D can have any number of THREE.Object chidren in its own hierachy.

Inherited From:
Source:
mapspace-street/sceneobjects/sceneobject.js

Methods

<static> equals(cpt1, cpt2)

Compares two CubicPanoramaTile to check if thet are the same or not.

Parameters:
Name Type Description
cpt1 Mapspace.street.threejs.CubicPanoramaTile

Fisrt CubicPanoramaTile to compare.
cpt2 Mapspace.street.threejs.CubicPanoramaTile

Second CubicPanoramaTile to compare.
Source:
mapspace-street/sceneobjects/cubicpanoramatile.js
Returns:

True or false.

Type
boolean

<static> hash(cpt)

Returns a hash code for this cubic panorama tile.

Parameters:
Name Type Description
cpt Mapspace.street.threejs.CubicPanoramaTile

CubicPanoramaTile to hash.
Source:
mapspace-street/sceneobjects/cubicpanoramatile.js
Returns:

An integer.

Type
number

addChild(child)

Adds a child SceneObject to this object.

Parameters:
Name Type Description
child Mapspace.street.threejs.SceneObject

Child SceneObject.
Inherited From:
Source:
mapspace-street/sceneobjects/sceneobject.js

changePanoramaSize(size)

Change panorama size.

Parameters:
Name Type Description
size number

Size of the panorama in meters.
Source:
mapspace-street/sceneobjects/cubicpanoramatile.js

findIntersection(raycaster)

Returns a THREE.Vector3 point and tile ID with the intersection of the raycaster.

Parameters:
Name Type Description
raycaster THREE.Raycaster

Raycaster.
Source:
mapspace-street/sceneobjects/cubicpanoramatile.js
Returns:

Object with a point and tileID values or null if no intersection.

Type
Object

findSceneObjects(raycaster)

Returns an array of SceneObjects that are intersected by given raycaster. Function to be overrided in derived classes.

Parameters:
Name Type Description
raycaster THREE.Raycaster

Raycaster.
Inherited From:
Overrides:
Source:
mapspace-street/sceneobjects/sceneobject.js
Returns:

Array of SceneObject.

Type
Array.<Mapspace.street.threejs.SceneObject>

findThreeObjects(raycaster)

Returns an array of THREE.Object3D that are intersected by given raycaster. Function to be overrided in derived classes.

Parameters:
Name Type Description
raycaster THREE.Raycaster

Raycaster.
Inherited From:
Overrides:
Source:
mapspace-street/sceneobjects/sceneobject.js
Returns:

Array of THREE.Object3D.

Type
Array.<THREE.Object3D>

getDebugColor()

Gets if the color debug grid of this object.

Source:
mapspace-street/sceneobjects/cubicpanoramatile.js
Returns:
Type
string

getDebugGrid()

Gets if the debug grid is visible in this object or not.

Source:
mapspace-street/sceneobjects/cubicpanoramatile.js
Returns:
Type
boolean

getMaterialOpacity()

Gets this object material opacity. Opacity from 0 to 1, zero transparent.

Source:
mapspace-street/sceneobjects/cubicpanoramatile.js
Returns:
Type
number

getMaterialVisibility()

Gets this object material visibility.

Source:
mapspace-street/sceneobjects/cubicpanoramatile.js
Returns:
Type
boolean

getScene()

Returns the Three.js scene the object3D contained inside this object is attached to.

Inherited From:
Source:
mapspace-street/sceneobjects/sceneobject.js
Returns:

The scene.

Type
THREE.Scene

getSceneManager()

Returns the SceneManager this SceneObject is attached to.

Inherited From:
Source:
mapspace-street/sceneobjects/sceneobject.js
Returns:

SceneManager.

Type
Mapspace.streetthreejs.SceneManager

getTileID()

Returns the face_z_y_x tile ID. This convention is the one used in web services params.

Source:
mapspace-street/sceneobjects/cubicpanoramatile.js
Returns:
Type
string

getVisible()

Returns the visibility of the objects of this object.

Inherited From:
Source:
mapspace-street/sceneobjects/sceneobject.js
Returns:
Type
boolean

isVisible(frustum)

Returns if this object is visible for current camera frustum.

Parameters:
Name Type Description
frustum THREE.Frustum

Camera frustum.
Source:
mapspace-street/sceneobjects/cubicpanoramatile.js
Returns:
Type
boolean

removeChild(child)

Removes a child SceneObject from this object.

Parameters:
Name Type Description
child Mapspace.street.threejs.SceneObject

Child SceneObject.
Inherited From:
Source:
mapspace-street/sceneobjects/sceneobject.js

rotateAroundWorldAxis(axis, radians)

Rotate the object3D of this SceneObject around an arbitrary axis in world space.

Parameters:
Name Type Description
axis THREE.Vector3

Axis. It is not needed the axis to be normalized.
radians number

Angle in radians.
Inherited From:
Source:
mapspace-street/sceneobjects/sceneobject.js

setDebugColor(debugColor)

Updates the color debug grid of this object.

Parameters:
Name Type Description
debugColor string

The color as a CSS color.
Source:
mapspace-street/sceneobjects/cubicpanoramatile.js

setDebugGrid(debugGrid)

Updates this object to add the debug style or not.

Parameters:
Name Type Description
debugGrid boolean

True to show in debug mode, false to hide it.
Source:
mapspace-street/sceneobjects/cubicpanoramatile.js

setMaterial(texturematerial)

Sets texture material for this object.

Parameters:
Name Type Description
texturematerial THREE.MeshBasicMaterial

Material for rendering.
Source:
mapspace-street/sceneobjects/cubicpanoramatile.js

setMaterialOpacity(opacity)

Sets this object material opacity.

Parameters:
Name Type Description
opacity number

Opacity from 0 to 1, zero transparent.
Source:
mapspace-street/sceneobjects/cubicpanoramatile.js

setMaterialVisibility(visible)

Sets this object material visibility.

Parameters:
Name Type Description
visible boolean

Visibility.
Source:
mapspace-street/sceneobjects/cubicpanoramatile.js

setObject3D(object3D)

Sets the THREE.Object3D of this object.

Parameters:
Name Type Description
object3D THREE.Object3D

The Object3D of this object.
Inherited From:
Source:
mapspace-street/sceneobjects/sceneobject.js

setPosition(x, y, z)

Move this object to new coordinates.

Parameters:
Name Type Description
x number

X coord.
y number

Y coord.
z number

Z coord.
Inherited From:
Source:
mapspace-street/sceneobjects/sceneobject.js

setVisible(visible)

Change the visibility of this object.

Parameters:
Name Type Description
visible boolean

If object should be visible or not.
Inherited From:
Source:
mapspace-street/sceneobjects/sceneobject.js

updateDebugGridVisibility()

Sets debug grid visibility.

Source:
mapspace-street/sceneobjects/cubicpanoramatile.js

updateDebugMaterial()

Updates the material of the debug style.

Source:
mapspace-street/sceneobjects/cubicpanoramatile.js

updateNeighbors()

Updates the internal list of neighbor tiles.

Source:
mapspace-street/sceneobjects/cubicpanoramatile.js