Built-In Namespace _global_
| Method Attributes | Method Name and Description |
|---|---|
|
viewHome(canvasId, homeUrl, onerror, onprogression, params)
Loads the home from the given URL and displays it in the 3D canvas with
canvasId. |
|
|
viewHomeInOverlay(homeUrl, params)
Loads the home from the given URL and displays it in an overlay.
|
|
|
viewModelInOverlay(modelUrl, modelRotation)
Loads the model at given URL and displays it in a 3D canvas.
|
Method Detail
{HomePreviewComponent}
viewHome(canvasId, homeUrl, onerror, onprogression, params)
Loads the home from the given URL and displays it in the 3D canvas with
Defined in: viewHome.js.
canvasId.
params.navigationPanel may be equal to "none", "default"
or an HTML string which content will replace the default navigation panel.
Defined in: viewHome.js.
- Parameters:
- {string} canvasId
- the value of the id attribute of the 3D canvas
- {string} homeUrl
- the URL of the home to load and display
- onerror
- callback called in case of error with an exception as parameter
- onprogression
- callback with (part, info, percentage) parameters called during the download of the home and the 3D models it displays.
- {{roundsPerMinute: number|navigationPanel: string|aerialViewButtonId: string|virtualVisitButtonId: string|levelsAndCamerasListId: string|level: string|selectableLevels: string[]|camera: string|selectableCameras: string[]|activateCameraSwitchKey: boolean}} params Optional
- the ids of the buttons and other information displayed in the user interface. If not provided, controls won't be managed if any, no animation and navigation arrows won't be displayed.
- Returns:
- {HomePreviewComponent} the returned object gives access to the loaded Home instance, the HomeComponent3D instance that displays it, the HomeController3D instance that manages camera changes and the UserPreferences in use.
viewHomeInOverlay(homeUrl, params)
Loads the home from the given URL and displays it in an overlay.
Canvas size ratio is 4 / 3 by default.
Defined in: viewHome.js.
params.navigationPanel may be equal to "none", "default"
or an HTML string which content will replace the default navigation panel.
If needed, the id of the created canvas is viewerCanvas and its homePreviewComponent
property returns the instance of HomePreviewComponent associated to it.
Defined in: viewHome.js.
- Parameters:
- {string} homeUrl
- the URL of the home to display
- {{roundsPerMinute: number|widthByHeightRatio: number|navigationPanel: string|aerialViewButtonText: string|virtualVisitButtonText: string|level: string|selectableLevels: string[]|camera: string|selectableCameras: string[]|activateCameraSwitchKey: boolean|viewerControlsAdditionalHTML: string|readingHomeText: string|readingModelText: string|noWebGLSupportError: string|missingHomeXmlEntryError: string}} params Optional
- the texts and other information displayed in the user interface. If not provided, there will be no controls, no animation and canvas size ratio will be 4/3 with no navigation panel.
viewModelInOverlay(modelUrl, modelRotation)
Loads the model at given URL and displays it in a 3D canvas.
Defined in: viewModel.js.
Defined in: viewModel.js.
- Parameters:
- {string} modelUrl
- the URL of the model to load
- {string} modelRotation
- the 9 values of a 3x3 matrix
