Class Index | File Index

Classes


Class Home3DAttributesController


Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Home3DAttributesController(home, preferences, viewFactory, contentManager, undoSupport)
Creates the controller of 3D view with undo support.
Method Summary
Method Attributes Method Name and Description
 
addPropertyChangeListener(property, listener)
Adds the property change listener in parameter to this controller.
 
displayView(parentView)
Displays the view controlled by this controller.
 
Returns the edited ground color.
 
Returns whether the ground is colored or textured.
 
Returns the texture controller of the ground.
 
Returns the edited light color.
 
Returns the edited sky color.
 
Returns whether the sky is colored or textured.
 
Returns the texture controller of the sky.
 
Returns the view associated with this controller.
 
Returns the edited walls transparency alpha.
 
Returns true if the background image should be displayed on the ground in 3D.
 
Controls the modification of the 3D attributes of the edited home.
 
removePropertyChangeListener(property, listener)
Removes the property change listener in parameter from this controller.
 
setBackgroundImageVisibleOnGround3D(backgroundImageVisibleOnGround3D)
Sets whether the background image should be displayed on the ground in 3D.
 
setGroundColor(groundColor)
Sets the edited ground color.
 
setGroundPaint(groundPaint)
Sets whether the ground is colored or textured.
 
setLightColor(lightColor)
Sets the edited light color.
 
setSkyColor(skyColor)
Sets the edited sky color.
 
setSkyPaint(skyPaint)
Sets whether the sky is colored or textured.
 
setWallsAlpha(wallsAlpha)
Sets the edited walls transparency alpha.
 
Updates edited properties from the 3D attributes of the home edited by this controller.
Class Detail
Home3DAttributesController(home, preferences, viewFactory, contentManager, undoSupport)
Creates the controller of 3D view with undo support.
Author: Emmanuel Puybaret.
Parameters:
{Home} home
{UserPreferences} preferences
{Object} viewFactory
{Object} contentManager
{javax.swing.undo.UndoableEditSupport} undoSupport
Method Detail
addPropertyChangeListener(property, listener)
Adds the property change listener in parameter to this controller.
Parameters:
{string} property
{PropertyChangeListener} listener

displayView(parentView)
Displays the view controlled by this controller.
Parameters:
{Object} parentView

{number} getGroundColor()
Returns the edited ground color.
Returns:
{number}

{Home3DAttributesController.EnvironmentPaint} getGroundPaint()
Returns whether the ground is colored or textured.
Returns:
{Home3DAttributesController.EnvironmentPaint}

{TextureChoiceController} getGroundTextureController()
Returns the texture controller of the ground.
Returns:
{TextureChoiceController}

{number} getLightColor()
Returns the edited light color.
Returns:
{number}

{number} getSkyColor()
Returns the edited sky color.
Returns:
{number}

{Home3DAttributesController.EnvironmentPaint} getSkyPaint()
Returns whether the sky is colored or textured.
Returns:
{Home3DAttributesController.EnvironmentPaint}

{TextureChoiceController} getSkyTextureController()
Returns the texture controller of the sky.
Returns:
{TextureChoiceController}

{Object} getView()
Returns the view associated with this controller.
Returns:
{Object}

{number} getWallsAlpha()
Returns the edited walls transparency alpha.
Returns:
{number}

{boolean} isBackgroundImageVisibleOnGround3D()
Returns true if the background image should be displayed on the ground in 3D.
Returns:
{boolean}

modify3DAttributes()
Controls the modification of the 3D attributes of the edited home.

removePropertyChangeListener(property, listener)
Removes the property change listener in parameter from this controller.
Parameters:
{string} property
{PropertyChangeListener} listener

setBackgroundImageVisibleOnGround3D(backgroundImageVisibleOnGround3D)
Sets whether the background image should be displayed on the ground in 3D.
Parameters:
{boolean} backgroundImageVisibleOnGround3D

setGroundColor(groundColor)
Sets the edited ground color.
Parameters:
{number} groundColor

setGroundPaint(groundPaint)
Sets whether the ground is colored or textured.
Parameters:
{Home3DAttributesController.EnvironmentPaint} groundPaint

setLightColor(lightColor)
Sets the edited light color.
Parameters:
{number} lightColor

setSkyColor(skyColor)
Sets the edited sky color.
Parameters:
{number} skyColor

setSkyPaint(skyPaint)
Sets whether the sky is colored or textured.
Parameters:
{Home3DAttributesController.EnvironmentPaint} skyPaint

setWallsAlpha(wallsAlpha)
Sets the edited walls transparency alpha.
Parameters:
{number} wallsAlpha

updateProperties()
Updates edited properties from the 3D attributes of the home edited by this controller.

© Copyright 2021 Emmanuel PUYBARET / eTeks
Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Tue Mar 02 2021 19:55:52 GMT+0100 (CET)