WorldProvider

WorldProvider

This provider (singleton) takes care of settings, status changes (e.g. also change of camera view) of the 3D scene.

Constructor

new WorldProvider()

Source:

Extends

  • EventTarget

Members

activeExhibit

Description:

  • Getter

Source:

Getter

(nullable) activeExhibit_ :Object

Description:

  • If the viewer is currently in an activation zone of an exhibit, its model id and the corresponding artwork model id are stored here for later assignment.

Source:

If the viewer is currently in an activation zone of an exhibit, its model id and the corresponding artwork model id are stored here for later assignment.

Type:
  • Object

intersectables :Array.<THREE.Object3D>

Description:

  • List of THREE objects that could interact with the THREE raycaster (e.g. for collision detection).

Source:

List of THREE objects that could interact with the THREE raycaster (e.g. for collision detection).

Type:
  • Array.<THREE.Object3D>

isExhibitView

Description:

  • Getter

Source:

Getter

(private) isExhibitView_ :boolean

Description:

  • If the scene is currently being viewed from an exhibit view (e.g. from an exhibit orbit view)

Source:

If the scene is currently being viewed from an exhibit view (e.g. from an exhibit orbit view)

Type:
  • boolean

isMobileDevice :boolean

Description:

  • Checks if the device is a mobile device.

Source:

Checks if the device is a mobile device.

Type:
  • boolean

isSwitchingView :boolean

Description:

  • Indicates whether the transition of a view change (e.g. animation from the visitor view to the top view) takes place at the moment.

Source:

Indicates whether the transition of a view change (e.g. animation from the visitor view to the top view) takes place at the moment.

Type:
  • boolean

isTopView

Description:

  • Getter

Source:

Getter

(private) isTopView_ :boolean

Description:

  • If the scene is currently viewed from the top view

Source:

If the scene is currently viewed from the top view

Type:
  • boolean

loadProgress

Description:

  • Getter

Source:

Getter

(private) loadProgress_ :number

Description:

  • Main loading progress of the 3D scene

Source:

Main loading progress of the 3D scene

Type:
  • number

physicIsEnabled :boolean

Description:

  • Is Cannon physics calculation enabled for the 3D Scene

Source:

Is Cannon physics calculation enabled for the 3D Scene

Type:
  • boolean

settings :Object

Description:
Source:

General settings object to set properties in the 3D and address them globally. So these values are also more easily updateable via a GUI https://github.com/dataarts/dat.gui/blob/master/API.md.

Type:
  • Object

state

Description:

  • Getter

Source:

Getter

(private) state_ :string

Description:
Source:

Current WorldState

Type:
  • string

Methods

activate()

Description:
Source:

activateExhibit(exhibitId, elementId)

Description:

  • Sets the current active exhibit and fires the WorldEventType ACTIVATE_EXHIBIT event

Source:
Parameters:
Name Type Description
exhibitId number

Exhibit model id
elementId number

Artwork model id

build()

Description:
Source:

changeMuting()

Description:
Source:

deactivateExhibit()

Description:

  • Sets the active exhibit to null and fires the WorldEventType DEACTIVATE_EXHIBIT event

Source:

getMoveSettings(key) → {number}

Description:

  • Returns individual settings values that are adjusted taking into account the currently used control.

Source:
Parameters:
Name Type Description
key string
Returns:
Type
number

loaded()

Description:
Source:

pauseRendering()

Description:
Source:

showNoSupportMessage()

Description:
Source:

startRendering()

Description:
Source:

switchExhibitView()

Description:

  • Toggles the normal and exhibit/orbit view state value and fires the WorldEventType SWITCH_EXHIBIT_VIEW event

Source:

switchWorldView()

Description:

  • Toggles the normal and top view state value and fires the WorldEventType SWITCH_WORLD_VIEW event

Source:

updateControlling()

Description:
Source:

updateLoadProgress(progress)

Description:

  • Updates the loading progress and fires the WorldEventType LOAD_PROGRESS event

Source:
Parameters:
Name Type Description
progress number