Class HomeEnvironment

Extends HomeObject.

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	HomeEnvironment(id, groundColor, groundTexture, skyColor, skyTexture, lightColor, wallsAlpha) Creates home environment from parameters.

Method Summary
Method Attributes	Method Name and Description
	clone() Returns a clone of this environment.
	getCeillingLightColor() Returns the color of ceiling lights.
	getDrawingMode() Returns the drawing mode of this environment.
	getGroundColor() Returns the ground color of this environment.
	getGroundTexture() Returns the ground texture of this environment.
	getLightColor() Returns the light color of this environment.
	getPhotoAspectRatio() Returns the preferred photo aspect ratio.
	getPhotoHeight() Returns the preferred photo height.
	getPhotoQuality() Returns the preferred photo quality.
	getPhotoWidth() Returns the preferred photo width.
	getSkyColor() Returns the sky color of this environment.
	getSkyTexture() Returns the sky texture of this environment.
	getSubpartSizeUnderLight() Returns the size of subparts under home lights in this environment.
	getVideoAspectRatio() Returns the preferred video aspect ratio.
	getVideoCameraPath() Returns the preferred video camera path.
	getVideoFrameRate() Returns the preferred video frame rate.
	getVideoHeight() Returns the preferred video height.
	getVideoQuality() Returns preferred video quality.
	getVideoSpeed() Returns the preferred speed of movements in videos in m/s.
	getVideoWidth() Returns the preferred video width.
	getWallsAlpha() Returns the walls transparency alpha factor of this environment.
	isAllLevelsVisible() Returns whether all levels should be visible or not.
	isBackgroundImageVisibleOnGround3D() Returns `true` if the background image should be displayed on the ground in 3D.
	isObserverCameraElevationAdjusted() Returns `true` if the observer elevation should be adjusted according to the elevation of the selected level.
	setAllLevelsVisible(allLevelsVisible) Sets whether all levels should be visible or not and fires a `PropertyChangeEvent`.
	setBackgroundImageVisibleOnGround3D(backgroundImageVisibleOnGround3D) Sets whether the background image should be displayed on the ground in 3D and fires a `PropertyChangeEvent`.
	setCeillingLightColor(ceilingLightColor) Sets the color of ceiling lights and fires a `PropertyChangeEvent`.
	setDrawingMode(drawingMode) Sets the drawing mode of this environment and fires a `PropertyChangeEvent`.
	setGroundColor(groundColor) Sets the ground color of this environment and fires a `PropertyChangeEvent`.
	setGroundTexture(groundTexture) Sets the ground texture of this environment and fires a `PropertyChangeEvent`.
	setLightColor(lightColor) Sets the color that lights this environment and fires a `PropertyChangeEvent`.
	setObserverCameraElevationAdjusted(observerCameraElevationAdjusted) Sets whether the observer elevation should be adjusted according to the elevation of the selected level and fires a `PropertyChangeEvent`.
	setPhotoAspectRatio(photoAspectRatio) Sets the preferred photo aspect ratio, and notifies listeners of this change.
	setPhotoHeight(photoHeight) Sets the preferred photo height, and notifies listeners of this change.
	setPhotoQuality(photoQuality) Sets preferred photo quality, and notifies listeners of this change.
	setPhotoWidth(photoWidth) Sets the preferred photo width, and notifies listeners of this change.
	setSkyColor(skyColor) Sets the sky color of this environment and fires a `PropertyChangeEvent`.
	setSkyTexture(skyTexture) Sets the sky texture of this environment and fires a `PropertyChangeEvent`.
	setSubpartSizeUnderLight(subpartSizeUnderLight) Sets the size of subparts under home lights of this environment and fires a `PropertyChangeEvent`.
	setVideoAspectRatio(videoAspectRatio) Sets the preferred video aspect ratio, and notifies listeners of this change.
	setVideoCameraPath(cameraPath) Sets the preferred video camera path, and notifies listeners of this change.
	setVideoFrameRate(videoFrameRate) Sets the preferred video frame rate, and notifies listeners of this change.
	setVideoQuality(videoQuality) Sets the preferred video quality, and notifies listeners of this change.
	setVideoSpeed(videoSpeed) Sets the preferred speed of movements in videos in m/s.
	setVideoWidth(videoWidth) Sets the preferred video width, and notifies listeners of this change.
	setWallsAlpha(wallsAlpha) Sets the walls transparency alpha of this environment and fires a `PropertyChangeEvent`.

Methods borrowed from class HomeObject:: duplicate, firePropertyChange, getContentProperty, getId, getProperty, getPropertyNames, isContentProperty, setProperty

Class Detail

HomeEnvironment(id, groundColor, groundTexture, skyColor, skyTexture, lightColor, wallsAlpha)

Creates home environment from parameters.
Author: Emmanuel Puybaret.

Parameters:
{string} id
{number} groundColor
{HomeTexture} groundTexture
{number} skyColor
{HomeTexture} skyTexture
{number} lightColor
{number} wallsAlpha

Method Detail

{HomeEnvironment} clone()

Returns a clone of this environment.

Returns:: {HomeEnvironment}

{number} getCeillingLightColor()

Returns the color of ceiling lights.

Returns:: {number}

{HomeEnvironment.DrawingMode} getDrawingMode()

Returns the drawing mode of this environment.

Returns:: {HomeEnvironment.DrawingMode}

{number} getGroundColor()

Returns the ground color of this environment.

Returns:: {number}

{HomeTexture} getGroundTexture()

Returns the ground texture of this environment.

Returns:: {HomeTexture}

{number} getLightColor()

Returns the light color of this environment.

Returns:: {number}

{AspectRatio} getPhotoAspectRatio()

Returns the preferred photo aspect ratio.

Returns:: {AspectRatio}

{number} getPhotoHeight()

Returns the preferred photo height.

Returns:: {number}

{number} getPhotoQuality()

Returns the preferred photo quality.

Returns:: {number}

{number} getPhotoWidth()

Returns the preferred photo width.

Returns:: {number}

{number} getSkyColor()

Returns the sky color of this environment.

Returns:: {number}

{HomeTexture} getSkyTexture()

Returns the sky texture of this environment.

Returns:: {HomeTexture}

{number} getSubpartSizeUnderLight()

Returns the size of subparts under home lights in this environment.

Returns:: {number} a size in centimeters or 0 if home lights don't illuminate home.

{AspectRatio} getVideoAspectRatio()

Returns the preferred video aspect ratio.

Returns:: {AspectRatio}

{Camera[]} getVideoCameraPath()

Returns the preferred video camera path.

Returns:: {Camera[]}

{number} getVideoFrameRate()

Returns the preferred video frame rate.

Returns:: {number}

{number} getVideoHeight()

Returns the preferred video height.

Returns:: {number}

{number} getVideoQuality()

Returns preferred video quality.

Returns:: {number}

{number} getVideoSpeed()

Returns the preferred speed of movements in videos in m/s.

Returns:: {number}

{number} getVideoWidth()

Returns the preferred video width.

Returns:: {number}

{number} getWallsAlpha()

Returns the walls transparency alpha factor of this environment.

Returns:: {number}

{boolean} isAllLevelsVisible()

Returns whether all levels should be visible or not.

Returns:: {boolean}

{boolean} isBackgroundImageVisibleOnGround3D()

Returns true if the background image should be displayed on the ground in 3D.

Returns:: {boolean}

{boolean} isObserverCameraElevationAdjusted()

Returns true if the observer elevation should be adjusted according to the elevation of the selected level.

Returns:: {boolean}

setAllLevelsVisible(allLevelsVisible)

Sets whether all levels should be visible or not and fires a PropertyChangeEvent.

Parameters:
{boolean} allLevelsVisible

setBackgroundImageVisibleOnGround3D(backgroundImageVisibleOnGround3D)

Sets whether the background image should be displayed on the ground in 3D and fires a PropertyChangeEvent.

Parameters:
{boolean} backgroundImageVisibleOnGround3D

setCeillingLightColor(ceilingLightColor)

Sets the color of ceiling lights and fires a PropertyChangeEvent.

Parameters:
{number} ceilingLightColor

setDrawingMode(drawingMode)

Sets the drawing mode of this environment and fires a PropertyChangeEvent.

Parameters:
{HomeEnvironment.DrawingMode} drawingMode

setGroundColor(groundColor)

Sets the ground color of this environment and fires a PropertyChangeEvent.

Parameters:
{number} groundColor

setGroundTexture(groundTexture)

Sets the ground texture of this environment and fires a PropertyChangeEvent.

Parameters:
{HomeTexture} groundTexture

setLightColor(lightColor)

Sets the color that lights this environment and fires a PropertyChangeEvent.

Parameters:
{number} lightColor

setObserverCameraElevationAdjusted(observerCameraElevationAdjusted)

Sets whether the observer elevation should be adjusted according to the elevation of the selected level and fires a PropertyChangeEvent.

Parameters:
{boolean} observerCameraElevationAdjusted

setPhotoAspectRatio(photoAspectRatio)

Sets the preferred photo aspect ratio, and notifies listeners of this change.

Parameters:
{AspectRatio} photoAspectRatio

setPhotoHeight(photoHeight)

Sets the preferred photo height, and notifies listeners of this change.

Parameters:
{number} photoHeight

setPhotoQuality(photoQuality)

Sets preferred photo quality, and notifies listeners of this change.

Parameters:
{number} photoQuality

setPhotoWidth(photoWidth)

Sets the preferred photo width, and notifies listeners of this change.

Parameters:
{number} photoWidth

setSkyColor(skyColor)

Sets the sky color of this environment and fires a PropertyChangeEvent.

Parameters:
{number} skyColor

setSkyTexture(skyTexture)

Sets the sky texture of this environment and fires a PropertyChangeEvent.

Parameters:
{HomeTexture} skyTexture

setSubpartSizeUnderLight(subpartSizeUnderLight)

Sets the size of subparts under home lights of this environment and fires a PropertyChangeEvent.

Parameters:
{number} subpartSizeUnderLight

setVideoAspectRatio(videoAspectRatio)

Sets the preferred video aspect ratio, and notifies listeners of this change.

Parameters:
{AspectRatio} videoAspectRatio

setVideoCameraPath(cameraPath)

Sets the preferred video camera path, and notifies listeners of this change.

Parameters:
{Camera[]} cameraPath

setVideoFrameRate(videoFrameRate)

Sets the preferred video frame rate, and notifies listeners of this change.

Parameters:
{number} videoFrameRate

setVideoQuality(videoQuality)

Sets the preferred video quality, and notifies listeners of this change.

Parameters:
{number} videoQuality

setVideoSpeed(videoSpeed)

Sets the preferred speed of movements in videos in m/s.

Parameters:
{number} videoSpeed

setVideoWidth(videoWidth)

Sets the preferred video width, and notifies listeners of this change.

Parameters:
{number} videoWidth

setWallsAlpha(wallsAlpha)

Sets the walls transparency alpha of this environment and fires a PropertyChangeEvent.

Parameters:
{number} wallsAlpha: a value between 0 and 1, 0 meaning opaque and 1 invisible.

	© Copyright 2024 Space Mushrooms Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Aug 21 2024 17:43:23 GMT+0200 (CEST)

Classes

Class HomeEnvironment