Class Index | File Index

Classes


Class HomeComponent3D


Defined in: HomeComponent3D.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
HomeComponent3D(canvasId, home, preferences, object3dFactory, controller)
Creates a 3D component that displays home walls, rooms and furniture.
Method Summary
Method Attributes Method Name and Description
 
Frees listeners and canvas data.
 
Returns the action map of this component.
 
Returns the closest home item displayed at client coordinates (x, y).
 
Returns the input map of this component.
 
groundChangeListener(ev)
Class Detail
HomeComponent3D(canvasId, home, preferences, object3dFactory, controller)
Creates a 3D component that displays home walls, rooms and furniture.
Author: Emmanuel Puybaret.
Parameters:
{string} canvasId
the id of the HTML canvas associated to this component
{Home} home
the home to display in this component
{UserPreferences} preferences
user preferences
{Object3DBranchFactory} object3dFactory
a factory able to create 3D objects from home items or null to use default one. The createObject3D method of this factory is expected to return an instance of Object3DBranch in current implementation.
{HomeController3D} controller
the controller that manages modifications in home (optional).
Method Detail
dispose()
Frees listeners and canvas data.

getActionMap()
Returns the action map of this component.

{Object} getClosestItemAt(x, y)
Returns the closest home item displayed at client coordinates (x, y).
Parameters:
{number} x
{number} y
Since:
1.1
Returns:
{Object}

getInputMap()
Returns the input map of this component.

groundChangeListener(ev)
Parameters:
ev

© 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:08 GMT+0200 (CEST)