Class Index | File Index

Classes


Class HomePreviewComponent


Defined in: viewHome.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
HomePreviewComponent(canvasId, homeUrl, onError, onprogression, params)
Creates a component that loads and displays a home in a 3D canvas.
Method Summary
Method Attributes Method Name and Description
 
Stops animation, removes listeners bound to global objects and clears this component.
 
Returns the component 3D that displays the home of this component.
 
Returns the controller that manages changes in the home bound to this component.
 
Returns the home displayed by this component.
 
Returns the user preferences used by this component.
 
startRotationAnimation(roundsPerMinute)
Starts rotation animation.
 
Stops the running rotation animation.
Class Detail
HomePreviewComponent(canvasId, homeUrl, onError, onprogression, params)
Creates a component that loads and displays a home in a 3D canvas.
Author: Emmanuel Puybaret.
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.
Method Detail
dispose()
Stops animation, removes listeners bound to global objects and clears this component. This method should be called to free resources in the browser when this component is not needed anymore.

{HomeComponent3D} getComponent3D()
Returns the component 3D that displays the home of this component.
Returns:
{HomeComponent3D}

{HomeController3D} getController()
Returns the controller that manages changes in the home bound to this component.
Returns:
{HomeController3D}

{Home} getHome()
Returns the home displayed by this component.
Returns:
{Home}

{UserPreferences} getUserPreferences()
Returns the user preferences used by this component.
Returns:
{UserPreferences}

startRotationAnimation(roundsPerMinute)
Starts rotation animation.
Parameters:
{number} roundsPerMinute Optional
the rotation speed in rounds per minute, 1rpm if missing

stopRotationAnimation()
Stops the running rotation animation.

© Copyrights 2017 Emmanuel PUYBARET / eTeks
Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Oct 25 2017 16:36:09 GMT+0200 (CEST)