Javascript API 7.x

Namespace: street

bu. street

This is the namespace that contains support classes for the bu.street.Viewer.

Source:
bu-street/bu.street.threejs.jsdoc

Classes

DebugEvent
DOMEvent
FixedLevelEvent
GraphFinder
HotspotEvent
Image
ImagesManager
Viewer

Namespaces

action
controldef
movements

Type Definitions

CameraParameters

Camera parameters. x, y and z are normally 0,0,0 because the camera is set in the origin, but in certain cases as in an animation or movement effect, camera position can temporarily change.

Type:
  • Object
Properties:
Name Type Description
yaw number | undefined

Angle in +Y axis with zero in -Z direction [PI,-PI].
pitch number | undefined

Angle in +X axis [PI/2,-PI/2].
roll number | undefined

Angle in +Z axis. [PI/2,-PI/2]. It usually is zero.
fov number | undefined

Angle of view in degrees. [0,360.0].
x number | undefined

X position of the camera in scene coordinates. Always meters.
y number | undefined

Y position of the camera in scene coordinates. Always meters.
z number | undefined

Z position of the camera in scene coordinates. Always meters.
Source:
bu-street/typedefs.js

DebugEventType

Type of events for debugging.

DEBUGMESSAGECHANGED: 'debugmessagechanged' // The debug message has changed
Type:
  • string
Source:
bu-street/enums.js

Hotspot

Hotspot.

Type:
  • Object
Properties:
Name Type Description
id string | undefined

Image ID.
local_xcp number | undefined

Coordinate X in local projection.
local_ycp number | undefined

Coordinate Y in local projection.
type string | undefined

Type of hotspot.
xcp number | undefined

Image longitude.
ycp number | undefined

Image latitude.
zcp number | undefined

Coordinate Z in local projection.
srid number | undefined

SRID code of the local projection.
camera_height number | undefined

Camera height from ground.
Source:
bu-street/typedefs.js

ImagesManagerEventType

Type of events for a bu.street.ImagesManager.

IMAGEADDED: 'imageadded' // Triggered when a new Image is loaded
Type:
  • string
Source:
bu-street/enums.js

LayerFilterFunctionType

Type of functions to filter information in layers.

ALLLAYERS: 'alllayers' // The function will include all layers
ALLVECTOR: 'allvector' // The function will include all vector layers
ALLVECTOREXCEPTPANORAMAS: 'allvectorexceptpanoramas' // The function will include 
 // all vector layers except the Panoramas layer
ALLVECTOREXCEPTPANORAMASPOINTSLINES: 'allvectorexceptpanoramaspointslines' // The 
 // function will include all vector layers, but for a Panoramas layer
 // it will include only
Type:
  • string
Source:
bu-street/enums.js

Level

Level properties.

Type:
  • Object
Properties:
Name Type Description
index number

zoom level index
size number

Size in pixels of each full image. For a cube panorama is the full size of each of six images that comprises the cube.
tileSize number

Size of tiles.
numTiles number

size / tileSize. Always an integer value.
Source:
bu-street/typedefs.js

MeasurementType

Type of the street measurement (point, segment length, length, elevation, vertical area) for street viewers.

POINT: 'point'
SEGMENT_LENGTH: 'segmentlength'
LENGTH: 'length
ELEVATION: 'elevation'
VERTICAL_AREA: 'verticalarea'
Type:
  • string
Source:
bu-street/enums.js

Tile

Tile.

Type:
  • Object
Properties:
Name Type Description
x number

X coordinate of the tile. Tiles start in zero and ranges from upper left corner tile to bottom right corner tile with X and Y increasing in that direction.
y number

Y coordinate of the tile. Tiles start in zero and ranges from upper left corner tile to bottom right corner tile with X and Y increasing in that direction.
z number

Z coordinate of the tile representing the zoom level. The first level is zero and is the one with the minimum number of tiles for each cubic face in the cubemap, usually only one tile.
face string

Tile face (b, d, f, l, r, u). Back, Down, Front, Left, Right or Up.
Source:
bu-street/typedefs.js

TransformType

Type of transformation between street coordinates and world coordinates.

TOSTREET2D: 'toStreet2D' // Transformation from world 2D coordinates to pixel 
street image coordinates.
TOSTREET3D: 'toStreet3D' // Transformation from world 3D coordinates to pixel 
street image coordinates.
TOWORLD: 'toWorld' // Transformation from pixel street image coordinates at 
a given distance to world coordinates.
TOWORLDDEPTHMAP: 'toWorldDepthMap' // Transformation from pixel street image 
coordinates to world coordinates using a depth map
Type:
  • string
Source:
bu-street/enums.js

ViewerEventType

Type of events of a bu.street.Viewer.

IMAGEIDCHANGED: 'change:imageid'
CENTERCHANGED: 'change:center'
ROTATIONCHANGED: 'change:rotation'
ROLLCHANGED: 'change:roll'
PITCHCHANGED: 'change:pitch'
YAWCHANGED: 'change:yaw'
FOVCHANGED: 'change:fov'
BRIGHTNESSCHANGED: 'change:brightness'
CONTRASTCHANGED: 'change:contrast'
LAYERGROUPCHANGED: 'change:layergroup'
LAYERCHANGED: 'change:layer'
CUBICPANORAMAADDED: 'cubicpanoramaadded' // Triggered when a new cubic panorama 
// is added to the scene
IMAGEOPENED: 'imageopened' //When a street image finishes the opening
Type:
  • string
Source:
bu-street/enums.js

ViewerOptions

Options for bu.street.Viewer.

Type:
  • Object
Properties:
Name Type Description
target Element | string | undefined

The DOM target element where this viewer will be appended.
imageid string | undefined

Image ID to open on start.
center bu.Coordinate | undefined

Center to use on start. If both a center and an iamgeid are provided, then the center will be used.
rotation number | undefined

Resolution on start.
fov number | undefined

FOV on start.
pitch number | undefined

Pitch on start.
yaw number | undefined

Yaw on start.
autorotate number | undefined

Time in milliseconds to wait to start an autorotateTimeout movement if no other movement has been set. If not value then never autorotates.
brightness number | undefined

Brightness on start.
contrast number | undefined

Contrasst on start.
debuggrid boolean | undefined

If true a grid of tiles and Tile IDs is drawn for debugging purposes.
extraZoomLevels number | undefined

Number of zoom levels to add to existing zoom levels defined in any panorama. In the new zoom levels the tiles will be rescaled.
totalZoomLevels number | undefined

Maximum number of zoom levels. Zoom levels defined in any panorama will be redefined to have this number. If this number is greater than the size of the last zoom level defined in the panorama metadata, then the tiles will be shown rescaled. If defined, this property overshadows extraZoomLevels.
interactions Object | undefined

an object with same structure the one Collection.registerDefaultInteractions returns. An object with interaction id as properties and interaction as values.
panoramaSize number | undefined

The size in meters of the cube that shows the panorama. Anything outside this cube will be occluded by it and will not be rendered.
transitionDuration number | undefined

time in miliseconds that panoramas transition from one to next.
Source:
bu-street/typedefs.js

ViewerProperty

Properties of a bu.street.Viewer.

IMAGEID: 'imageid' // Name of the street image loaded.
CENTER: 'center' // Center.
ROTATION: 'rotation' // Rotation.
ROLL: 'roll' // Roll.
PITCH: 'pitch' // Pitch.
YAW: 'yaw' // Yaw.
FOV: 'fov' // Fiel of vision.
BRIGHTNESS: 'brightness' // Brightness.
CONTRAST: 'contrast' // Contrast.
LAYERGROUP: 'layergroup' // Layer group.
LAYER: 'layer' // Layer is a property that defines sets of data.
Type:
  • string
Source:
bu-street/enums.js

Namespace: street

bu. street

This is the main namespace of the Street module, that contains the bu.street.Viewer. This viewer shows 360 panoramic images captured with a car mounted rig and vector data overlapped using a 3D viewer.

Source:
bu-street/bu.street.jsdoc

Classes

DebugEvent
DOMEvent
FixedLevelEvent
GraphFinder
HotspotEvent
Image
ImagesManager
Viewer

Namespaces

action
controldef
movements

Type Definitions

CameraParameters

Camera parameters. x, y and z are normally 0,0,0 because the camera is set in the origin, but in certain cases as in an animation or movement effect, camera position can temporarily change.

Type:
  • Object
Properties:
Name Type Description
yaw number | undefined

Angle in +Y axis with zero in -Z direction [PI,-PI].
pitch number | undefined

Angle in +X axis [PI/2,-PI/2].
roll number | undefined

Angle in +Z axis. [PI/2,-PI/2]. It usually is zero.
fov number | undefined

Angle of view in degrees. [0,360.0].
x number | undefined

X position of the camera in scene coordinates. Always meters.
y number | undefined

Y position of the camera in scene coordinates. Always meters.
z number | undefined

Z position of the camera in scene coordinates. Always meters.
Source:
bu-street/typedefs.js

DebugEventType

Type of events for debugging.

DEBUGMESSAGECHANGED: 'debugmessagechanged' // The debug message has changed
Type:
  • string
Source:
bu-street/enums.js

Hotspot

Hotspot.

Type:
  • Object
Properties:
Name Type Description
id string | undefined

Image ID.
local_xcp number | undefined

Coordinate X in local projection.
local_ycp number | undefined

Coordinate Y in local projection.
type string | undefined

Type of hotspot.
xcp number | undefined

Image longitude.
ycp number | undefined

Image latitude.
zcp number | undefined

Coordinate Z in local projection.
srid number | undefined

SRID code of the local projection.
camera_height number | undefined

Camera height from ground.
Source:
bu-street/typedefs.js

ImagesManagerEventType

Type of events for a bu.street.ImagesManager.

IMAGEADDED: 'imageadded' // Triggered when a new Image is loaded
Type:
  • string
Source:
bu-street/enums.js

LayerFilterFunctionType

Type of functions to filter information in layers.

ALLLAYERS: 'alllayers' // The function will include all layers
ALLVECTOR: 'allvector' // The function will include all vector layers
ALLVECTOREXCEPTPANORAMAS: 'allvectorexceptpanoramas' // The function will include 
 // all vector layers except the Panoramas layer
ALLVECTOREXCEPTPANORAMASPOINTSLINES: 'allvectorexceptpanoramaspointslines' // The 
 // function will include all vector layers, but for a Panoramas layer
 // it will include only
Type:
  • string
Source:
bu-street/enums.js

Level

Level properties.

Type:
  • Object
Properties:
Name Type Description
index number

zoom level index
size number

Size in pixels of each full image. For a cube panorama is the full size of each of six images that comprises the cube.
tileSize number

Size of tiles.
numTiles number

size / tileSize. Always an integer value.
Source:
bu-street/typedefs.js

MeasurementType

Type of the street measurement (point, segment length, length, elevation, vertical area) for street viewers.

POINT: 'point'
SEGMENT_LENGTH: 'segmentlength'
LENGTH: 'length
ELEVATION: 'elevation'
VERTICAL_AREA: 'verticalarea'
Type:
  • string
Source:
bu-street/enums.js

Tile

Tile.

Type:
  • Object
Properties:
Name Type Description
x number

X coordinate of the tile. Tiles start in zero and ranges from upper left corner tile to bottom right corner tile with X and Y increasing in that direction.
y number

Y coordinate of the tile. Tiles start in zero and ranges from upper left corner tile to bottom right corner tile with X and Y increasing in that direction.
z number

Z coordinate of the tile representing the zoom level. The first level is zero and is the one with the minimum number of tiles for each cubic face in the cubemap, usually only one tile.
face string

Tile face (b, d, f, l, r, u). Back, Down, Front, Left, Right or Up.
Source:
bu-street/typedefs.js

TransformType

Type of transformation between street coordinates and world coordinates.

TOSTREET2D: 'toStreet2D' // Transformation from world 2D coordinates to pixel 
street image coordinates.
TOSTREET3D: 'toStreet3D' // Transformation from world 3D coordinates to pixel 
street image coordinates.
TOWORLD: 'toWorld' // Transformation from pixel street image coordinates at 
a given distance to world coordinates.
TOWORLDDEPTHMAP: 'toWorldDepthMap' // Transformation from pixel street image 
coordinates to world coordinates using a depth map
Type:
  • string
Source:
bu-street/enums.js

ViewerEventType

Type of events of a bu.street.Viewer.

IMAGEIDCHANGED: 'change:imageid'
CENTERCHANGED: 'change:center'
ROTATIONCHANGED: 'change:rotation'
ROLLCHANGED: 'change:roll'
PITCHCHANGED: 'change:pitch'
YAWCHANGED: 'change:yaw'
FOVCHANGED: 'change:fov'
BRIGHTNESSCHANGED: 'change:brightness'
CONTRASTCHANGED: 'change:contrast'
LAYERGROUPCHANGED: 'change:layergroup'
LAYERCHANGED: 'change:layer'
CUBICPANORAMAADDED: 'cubicpanoramaadded' // Triggered when a new cubic panorama 
// is added to the scene
IMAGEOPENED: 'imageopened' //When a street image finishes the opening
Type:
  • string
Source:
bu-street/enums.js

ViewerOptions

Options for bu.street.Viewer.

Type:
  • Object
Properties:
Name Type Description
target Element | string | undefined

The DOM target element where this viewer will be appended.
imageid string | undefined

Image ID to open on start.
center bu.Coordinate | undefined

Center to use on start. If both a center and an iamgeid are provided, then the center will be used.
rotation number | undefined

Resolution on start.
fov number | undefined

FOV on start.
pitch number | undefined

Pitch on start.
yaw number | undefined

Yaw on start.
autorotate number | undefined

Time in milliseconds to wait to start an autorotateTimeout movement if no other movement has been set. If not value then never autorotates.
brightness number | undefined

Brightness on start.
contrast number | undefined

Contrasst on start.
debuggrid boolean | undefined

If true a grid of tiles and Tile IDs is drawn for debugging purposes.
extraZoomLevels number | undefined

Number of zoom levels to add to existing zoom levels defined in any panorama. In the new zoom levels the tiles will be rescaled.
totalZoomLevels number | undefined

Maximum number of zoom levels. Zoom levels defined in any panorama will be redefined to have this number. If this number is greater than the size of the last zoom level defined in the panorama metadata, then the tiles will be shown rescaled. If defined, this property overshadows extraZoomLevels.
interactions Object | undefined

an object with same structure the one Collection.registerDefaultInteractions returns. An object with interaction id as properties and interaction as values.
panoramaSize number | undefined

The size in meters of the cube that shows the panorama. Anything outside this cube will be occluded by it and will not be rendered.
transitionDuration number | undefined

time in miliseconds that panoramas transition from one to next.
Source:
bu-street/typedefs.js

ViewerProperty

Properties of a bu.street.Viewer.

IMAGEID: 'imageid' // Name of the street image loaded.
CENTER: 'center' // Center.
ROTATION: 'rotation' // Rotation.
ROLL: 'roll' // Roll.
PITCH: 'pitch' // Pitch.
YAW: 'yaw' // Yaw.
FOV: 'fov' // Fiel of vision.
BRIGHTNESS: 'brightness' // Brightness.
CONTRAST: 'contrast' // Contrast.
LAYERGROUP: 'layergroup' // Layer group.
LAYER: 'layer' // Layer is a property that defines sets of data.
Type:
  • string
Source:
bu-street/enums.js