Global

Members

(constant) colorSpace

Texture encoding used to have the right color of the .glb model + have an alpha channel

Source: THREEUtil.js, line 96

(constant) defaultConfigScene :SceneConfig

Default scene 3D config

Type:

SceneConfig

Source: THREEUtil.js, line 21

Methods

RequestService()

Used by Widget.WebService Service used to make authentificate HTTP requests (with a token) Wiki : https://github.com/MEPP-team/UD-Viz/wiki/Request-Service#request-service

Source: RequestService.js, line 6

URLSetCameraMatrix(camera) → {boolean}

Initialize camera matrix with url search params produced by appendCameraMatrixToURL

Parameters:

Name	Type	Description
`camera`	THREE.PerspectiveCamera	camera to initialize with url

Source: url.js, line 12

Returns:

true if a camera matrix has been found in url

Type:: boolean

addCubeTexture(paths, scene)

Parameters:

Name	Type	Description
`paths`	Array.<string>	paths of cube texture order should be negX posX negY posY posZ negZ
`scene`	THREE.Scene	3d scene

Source: THREEUtil.js, line 104

addLights(scene) → {Object}

Add default lights to a scene 3D one directional and one ambient

Parameters:

Name	Type	Description
`scene`	THREE.Scene	the scene where to add lights

Source: THREEUtil.js, line 117

Returns:

lights added

Type:: Object

appendCameraMatrixToURL(url, camera) → {URL}

Append in search params of an url the camera matrix

Parameters:

Name	Type	Description
`url`	URL	url to append the camera matrix
`camera`	THREE.PerspectiveCamera	camera to read the matrix from

Source: url.js, line 37

Returns:

url to append the camera matrix

Type:: URL

appendWireframeByGeometryAttributeToObject3D(object3D, nameOfGeometryAttribute, threshOldAngle)

Traverse a THREE.Object3D and append in each Object3D children a THREE.LineSegment geometry representing its wireframe. Each wireframe geometry will keep the associated attribute value.

Parameters:

Name	Type	Description
`object3D`	THREE.Object3D	An Object3D from three
`nameOfGeometryAttribute`	string	The attribute used to split each geometry of the BufferGeometry
`threshOldAngle`	number	An edge is only rendered if the angle (in degrees) between the face normals of the adjoining faces exceeds this value. default = 1 degree.

Source: THREEUtil.js, line 304

appendWireframeToObject3D(object3D, threshOldAngle)

Traverse a THREE.Object3D and append in each Object3D children a THREE.LineSegment geometry representing its wireframe

Parameters:

Name	Type	Description
`object3D`	THREE.Object3D	An Object3D from three
`threshOldAngle`	number	An edge is only rendered if the angle (in degrees) between the face normals of the adjoining faces exceeds this value. default = 1 degree.

Source: THREEUtil.js, line 262

autoDurationTravel(controls, targetPos) → {number}

Compute a distance automatically for travel features of itowns Planar View

Note: Code retrieve itowns - https://github.com/iTowns/itowns/blob/1bad0d627764c73b606179c636ad7b70105dd633/src/Controls/PlanarControls.js#L712

Parameters:

Name	Type	Description
`controls`	itowns.PlanarControls	planar controls of itownsView
`targetPos`	THREE.Vector3	position of our target

Source: itownsUtil.js, line 17

Returns:

the duration of travel to focus a targetPosition

Type:: number

bindLightTransform(offset, phi, theta, obj, dirLight)

Place the directional light in order its shadow camera fit the object

Parameters:

Name	Type	Description
`offset`	number	distance from the bounding sphere of the object to the light
`phi`	number	phi of spherical coord in radian
`theta`	number	theta of spherical coord in radian
`obj`	THREE.Object3D	the object to fit inside the projection plane of the shadow camera
`dirLight`	THREE.DirectionalLight	the light with the shadow camera

Source: THREEUtil.js, line 159

cameraFitRectangle(camera, min, max, altitude)

Move camera transform so the rectangle define by min & max (in the xy plane) fit the entire screen

Parameters:

Name	Type	Description
`camera`	THREE.PerspectiveCamera	camera to update
`min`	THREE.Vector2	min coord of the rectangle
`max`	THREE.Vector2	max coord of the rectangle
`altitude`	number	altitude of the rectangle

Source: THREEUtil.js, line 241
To Do: rectangle is not force to be in xy plane

checkParentChild(child, parent) → {boolean}

Check if an html element belong to another one recursively

Parameters:

Name	Type	Description
`child`	HTMLElement	html child
`parent`	HTMLElement	html parent

Source: html.js, line 10

Returns:

true if child belong to parent

Type:: boolean

computeFileNameFromPath(path) → {string}

Parameters:

Name	Type	Description
`path`	string	path of file

Source: file.js, line 107

Returns:

name of file

Type:: string

Example

console.log(computeFilename("./some_folder/another_folder/filename.whatever"))// log filename

computeNearFarCamera(camera, min, max)

Compute near and far of camera in order to wrap a box define by a min and max value

Parameters:

Name	Type	Description
`camera`	THREE.PerspectiveCamera	camera to compute near and far
`min`	THREE.Vector3	min coord of box
`max`	THREE.Vector3	max coord of box

Source: THREEUtil.js, line 201

createDateIntervalInput(labelText) → {Object}

Parameters:

Name	Type	Description
`labelText`	string	text of the label

Source: html.js, line 80

Returns:

date interval object

Type:: Object

createDisplayable(label) → {Object}

Create a button to toggle visibility of the content in a container

Parameters:

Name	Type	Description
`label`	string	label of the container

Source: html.js, line 31

Returns:

parent is the element to add container is the element to fill

Type:: Object

createLabelInput(labelText, inputType) → {Object}

Parameters:

Name	Type	Description
`labelText`	string	label text
`inputType`	string	input type

Source: html.js, line 58

Returns:

parent is the element to add input is the input element

Type:: Object

createSpriteFromString(string, optionsopt) → {THREE.Sprite}

Generates a sprite with text from a given string

Parameters:

Name	Type	Attributes	Description
`string`	string		The string displayed in the sprite
`options`	SpriteStringOptions	<optional>	Options of generation

Source: THREEUtil.js, line 408

Returns:

three's Sprite

Type:: THREE.Sprite

downloadImageOnDisk(url, filename)

Download an image on the local disk

Parameters:

Name	Type	Description
`url`	string	url of the image to download
`filename`	string	name of the file on disk

Source: file.js, line 162

downloadObjectAsJson(exportObj, exportName)

Download on the local disk an object as .json

Parameters:

Name	Type	Description
`exportObj`	object	object to download
`exportName`	string	name of file

Source: file.js, line 13

fetchC3DTileFeatureWithNodeText(itownsView, batchTableKey, batchTableValue) → {object}

fetchC3DTileFeatureWithNodeText takes a parameter batchTableKey and returns a feature from a 3DTileslayer if the batch table content of the feature contains a given batchTableValue string in the given key. Returns an object containing the first matching feature and its layer.

Parameters:

Name	Type	Description
`itownsView`	itowns.PlanarView	view
`batchTableKey`	string	a given batch table key
`batchTableValue`	string	a given batch table value

Source: itownsUtil.js, line 129

Returns:

containting the feature and the layer containing the feature

Type:: object

focusC3DTilesLayer(itownsView, layer) → {Promise|null}

Focus a C3DTiles Layer

Parameters:

Name	Type	Description
`itownsView`	itowns.PlanarView	view
`layer`	itowns.C3DTilesLayer	layer to focus

Source: itownsUtil.js, line 97
To Do: this function is used by widget should be contributed or removed

Returns:

Promise of the camera focusing on C3DTiles

Type:: Promise | null

focusCameraOn(view, controls, targetPos, optionsopt) → {Promise}

Makes the camera move to focus on the target position.

Parameters:

Name	Type	Attributes	Description
`view`	itowns.PlanarView		The iTowns view.
`controls`	itowns.PlanarControls		The camera controls.
`targetPos`	THREE.Vector3		The target position.
`options`	*	<optional>	Optional parameters for the travel. Accepted entries are : `duration` : the duration of the movement, in seconds. The promise will resolve after this value. If not specified, the value `auto` is used for the movement (see the `PlanarControls.initateTravel` method), and the promise resolves imediatly. `verticalDistance` : Desired height of the camera relative to the target position. `horizontalDistance` : Desired distance of the camera from the target position.

Source: itownsUtil.js, line 49
To Do: this function is used by widget should be contributed or removed

Returns:

Promise of the camera focusing on target

Type:: Promise

getUriLocalname(uri) → {string}

Return the localname of a URI

Parameters:

Name	Type	Description
`uri`	string	The URI

Source: url.js, line 76

Returns:

the localname of the URI

Type:: string

getUriNamespace(uri) → {string}

Return the namespace of a URI

Parameters:

Name	Type	Description
`uri`	string	The URI

Source: url.js, line 87

Returns:

the namespace of the URI

Type:: string

initRenderer(renderer, skyColor, clear)

Initialize the webgl renderer with default values

Parameters:

Name	Type	Description
`renderer`	THREE.WebGLRenderer	the renderer to init
`skyColor`	THREE.Color	clear color of the scene
`clear`	boolean	autoclear, default is false

Source: THREEUtil.js, line 138

initScene(camera, renderer, scene, config, object3D) → {THREE.DirectionalLight}

Init scene 3D with SceneConfig

Parameters:

Name	Type	Description
`camera`	THREE.PerspectiveCamera	camera rendering scene
`renderer`	THREE.WebGLRenderer	webgl renderer
`scene`	THREE.Scene	scene
`config`	SceneConfig \| null	config
`object3D`	THREE.Object3D \| null	object to focus with shadow map

Source: THREEUtil.js, line 49

Returns:

directional light created

Type:: THREE.DirectionalLight

loadJSON(url) → {Promise}

Request a json file on a distant server

Parameters:

Name	Type	Description
`url`	string	on the distant server

Source: file.js, line 31

Returns:

promise resolving when .json loaded and pass it as first param

Type:: Promise

loadMultipleJSON(urlArray) → {Promise}

Load multiples .json files

Parameters:

Name	Type	Description
`urlArray`	Array.<string>	path of .json files to loaded

Source: file.js, line 77

Returns:

promise reolving when .json files loaded, each .json file can be access by the filename

Type:: Promise

Example

loadMultipleJSON(["./some_folder/filename1.json","./another_folder/filename2.json"])
 .then((configs)=>{
   const contentFilename1 = configs["filename1"]
   const contentFilename2 = configs["filename2"]
})

loadTextFile(url) → {Promise}

Request a text file on a distant server

Parameters:

Name	Type	Description
`url`	string	on the distant server

Source: file.js, line 51

Returns:

promise resolving when file loaded and pass it as first param

Type:: Promise

localStorageSetMatrix4(matrix4, key) → {boolean}

If there was a matrix4 recorded in localStorage restore it matrix4 + when tab is closing record current matrix4 /!\ calling this function make window reference the matrix4 avoiding it to be GC and could cause memory leak

Parameters:

Name	Type	Description
`matrix4`	THREE.Matrix4	matrix4 to track
`key`	string	key of the item in localstorage

Source: localStorage.js, line 17

Returns:

true if matrix4 has been setted with localStorage

Type:: boolean

localStorageSetVector3(vector3, key) → {boolean}

If there was a vector 3 recorded in localStorage within the key passed copy values in vector3 + when tab is closing record current vector3 values /!\ calling this function make window reference the vector3 avoiding it to be GC and could cause memory leak

Parameters:

Name	Type	Description
`vector3`	THREE.Vector3	vector 3 to track
`key`	string	key of the item in localstorage

Source: localStorage.js, line 59

Returns:

true if vector3 has been setted with localStorage

Type:: boolean

readFileAsGltf(e) → {Promise}

change callback of an input file reading gltf

Parameters:

Name	Type	Description
`e`	object	input of type file argument when 'change'

Source: file.js, line 179

Returns:

promise resolving with the gltf loaded

Type:: Promise

readSingleFileAsDataUrl(e, onLoad)

To be used with an input of type file

Parameters:

Name	Type	Description
`e`	object	input of type file argument when 'change'
`onLoad`	FileReaderCallback	callback when file loaded

Source: file.js, line 143

readSingleFileAsText(e, onLoad)

To be used with an input of type file

Parameters:

Name	Type	Description
`e`	object	input of type file argument when 'change'
`onLoad`	FileReaderCallback \| null	callback when file loaded

Source: file.js, line 124

tokenizeURI(uri) → {Object}

Tokenize a URI into a namespace and localname A uri is typically composed of a [namespace]#[localname] e.g. http://site.io/test#example_1 here the namespace is 'http://site.io/test#' and the localname is 'example_1'

Parameters:

Name	Type	Description
`uri`	string	The URI to be tokenized

Source: url.js, line 54

Returns:

object of the URI tokenized

Type:: Object

Type Definitions

FileReaderCallback(event)

Parameters:

Name	Type	Description
`event`	ProgressEvent.<FileReader>	file reader event

Source: file.js, line 113

SceneConfig

Properties

Name Type Description

cameraFov

number

default camera fov

shadowMapSize

number

size of shadow map

sky

object

sky property

Properties

Name	Type	Description
`color`	Object	rgb color (value are between [0,1])
`sun_position`	Object	position of the sun in sheprical coord (phi theta) + an offset `THREEUtil.bindLightTransform`

Source: THREEUtil.js, line 4

SpriteStringOptions

Type:

object

Properties

Name	Type	Description
`baseHeight`	number	height of the canvas and the the font size
`baseWidth`	number	width of the canvas
`borderSize`	number	border size of the canvas
`font`	string	string of font description css style-like

Source: THREEUtil.js, line 392

cbTickAnimationFrame(dt)

Parameters:

Name	Type	Description
`dt`	number	Delta time between ticks

Source: RequestAnimationFrame.js, line 35

Members

(constant) colorSpace

(constant) createLocalStorageCheckbox

(constant) createLocalStorageDetails

(constant) createLocalStorageNumberInput

(constant) createLocalStorageSlider

(constant) defaultConfigScene :SceneConfig

Methods

RequestService()

URLSetCameraMatrix(camera) → {boolean}

addCubeTexture(paths, scene)

addLights(scene) → {Object}

appendCameraMatrixToURL(url, camera) → {URL}

appendWireframeByGeometryAttributeToObject3D(object3D, nameOfGeometryAttribute, threshOldAngle)

appendWireframeToObject3D(object3D, threshOldAngle)

autoDurationTravel(controls, targetPos) → {number}

bindLightTransform(offset, phi, theta, obj, dirLight)

cameraFitRectangle(camera, min, max, altitude)

checkParentChild(child, parent) → {boolean}

computeFileNameFromPath(path) → {string}

computeNearFarCamera(camera, min, max)

createDateIntervalInput(labelText) → {Object}

createDisplayable(label) → {Object}

createLabelInput(labelText, inputType) → {Object}

createSpriteFromString(string, optionsopt) → {THREE.Sprite}

downloadImageOnDisk(url, filename)

downloadObjectAsJson(exportObj, exportName)

fetchC3DTileFeatureWithNodeText(itownsView, batchTableKey, batchTableValue) → {object}

focusC3DTilesLayer(itownsView, layer) → {Promise|null}

focusCameraOn(view, controls, targetPos, optionsopt) → {Promise}

getUriLocalname(uri) → {string}

getUriNamespace(uri) → {string}

initRenderer(renderer, skyColor, clear)

initScene(camera, renderer, scene, config, object3D) → {THREE.DirectionalLight}

loadJSON(url) → {Promise}

loadMultipleJSON(urlArray) → {Promise}

loadTextFile(url) → {Promise}

localStorageSetMatrix4(matrix4, key) → {boolean}

localStorageSetVector3(vector3, key) → {boolean}

readFileAsGltf(e) → {Promise}

readSingleFileAsDataUrl(e, onLoad)

readSingleFileAsText(e, onLoad)

tokenizeURI(uri) → {Object}

Type Definitions

FileReaderCallback(event)

SceneConfig

Properties

SpriteStringOptions

cbTickAnimationFrame(dt)