HomeEnvironment (Sweet Home 3D 7.5 API)

java.lang.Object
- com.eteks.sweethome3d.model.HomeObject
- - com.eteks.sweethome3d.model.HomeEnvironment

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class HomeEnvironment
extends HomeObject
implements java.io.Serializable, java.lang.Cloneable
```
The environment attributes of a home.

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HomeEnvironment.DrawingMode` The various modes used to draw home in 3D.
`static class`	`HomeEnvironment.Property` The environment properties that may change.

Constructor Summary

Constructors
Constructor and Description
`HomeEnvironment()` Creates default environment.
`HomeEnvironment(int groundColor, HomeTexture groundTexture, int skyColor, HomeTexture skyTexture, int lightColor, float wallsAlpha)` Creates home environment from parameters.
`HomeEnvironment(int groundColor, HomeTexture groundTexture, int skyColor, int lightColor, float wallsAlpha)` Creates home environment from parameters.
`HomeEnvironment(java.lang.String id)` Creates default environment.
`HomeEnvironment(java.lang.String id, int groundColor, HomeTexture groundTexture, int skyColor, HomeTexture skyTexture, int lightColor, float wallsAlpha)` Creates home environment from parameters.

Method Summary

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

Methods inherited from class com.eteks.sweethome3d.model.HomeObject
addPropertyChangeListener, addPropertyChangeListener, createId, duplicate, firePropertyChange, getContentProperty, getId, getProperty, getPropertyNames, isContentProperty, removePropertyChangeListener, removePropertyChangeListener, setProperty, setProperty

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HomeEnvironment
```
public HomeEnvironment()
```
    Creates default environment.
  - HomeEnvironment
```
public HomeEnvironment(java.lang.String id)
```
    Creates default environment.
    
    Since:
    
    6.4
  - HomeEnvironment
```
public HomeEnvironment(int groundColor,
                       HomeTexture groundTexture,
                       int skyColor,
                       int lightColor,
                       float wallsAlpha)
```
    Creates home environment from parameters.
  - HomeEnvironment
```
public HomeEnvironment(int groundColor,
                       HomeTexture groundTexture,
                       int skyColor,
                       HomeTexture skyTexture,
                       int lightColor,
                       float wallsAlpha)
```
    Creates home environment from parameters.
    
    Since:
    
    2.2
  - HomeEnvironment
```
public HomeEnvironment(java.lang.String id,
                       int groundColor,
                       HomeTexture groundTexture,
                       int skyColor,
                       HomeTexture skyTexture,
                       int lightColor,
                       float wallsAlpha)
```
    Creates home environment from parameters.
    
    Since:
    
    6.4
- Method Detail
  - addPropertyChangeListener
```
public void addPropertyChangeListener(HomeEnvironment.Property property,
                                      java.beans.PropertyChangeListener listener)
```
    Adds the property change listener in parameter to this environment. Properties change will be notified with an event of PropertyChangeEvent class which property name will be equal to the value returned by Enum.name() call.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(HomeEnvironment.Property property,
                                         java.beans.PropertyChangeListener listener)
```
    Removes the property change listener in parameter from this environment.
  - isObserverCameraElevationAdjusted
```
public boolean isObserverCameraElevationAdjusted()
```
    Returns true if the observer elevation should be adjusted according to the elevation of the selected level.
    
    Since:
    
    3.5
  - setObserverCameraElevationAdjusted
```
public void setObserverCameraElevationAdjusted(boolean observerCameraElevationAdjusted)
```
    Sets whether the observer elevation should be adjusted according to the elevation of the selected level and fires a PropertyChangeEvent.
    
    Since:
    
    3.5
  - getGroundColor
```
public int getGroundColor()
```
    Returns the ground color of this environment.
  - setGroundColor
```
public void setGroundColor(int groundColor)
```
    Sets the ground color of this environment and fires a PropertyChangeEvent.
  - getGroundTexture
```
public HomeTexture getGroundTexture()
```
    Returns the ground texture of this environment.
  - setGroundTexture
```
public void setGroundTexture(HomeTexture groundTexture)
```
    Sets the ground texture of this environment and fires a PropertyChangeEvent.
  - isBackgroundImageVisibleOnGround3D
```
public boolean isBackgroundImageVisibleOnGround3D()
```
    Returns true if the background image should be displayed on the ground in 3D.
    
    Since:
    
    6.0
  - setBackgroundImageVisibleOnGround3D
```
public void setBackgroundImageVisibleOnGround3D(boolean backgroundImageVisibleOnGround3D)
```
    Sets whether the background image should be displayed on the ground in 3D and fires a PropertyChangeEvent.
    
    Since:
    
    6.0
  - getSkyColor
```
public int getSkyColor()
```
    Returns the sky color of this environment.
  - setSkyColor
```
public void setSkyColor(int skyColor)
```
    Sets the sky color of this environment and fires a PropertyChangeEvent.
  - getSkyTexture
```
public HomeTexture getSkyTexture()
```
    Returns the sky texture of this environment.
  - setSkyTexture
```
public void setSkyTexture(HomeTexture skyTexture)
```
    Sets the sky texture of this environment and fires a PropertyChangeEvent.
  - getLightColor
```
public int getLightColor()
```
    Returns the light color of this environment.
  - setLightColor
```
public void setLightColor(int lightColor)
```
    Sets the color that lights this environment and fires a PropertyChangeEvent.
  - getCeillingLightColor
```
public int getCeillingLightColor()
```
    Returns the color of ceiling lights.
  - setCeillingLightColor
```
public void setCeillingLightColor(int ceilingLightColor)
```
    Sets the color of ceiling lights and fires a PropertyChangeEvent.
  - getWallsAlpha
```
public float getWallsAlpha()
```
    Returns the walls transparency alpha factor of this environment.
  - setWallsAlpha
```
public void setWallsAlpha(float wallsAlpha)
```
    Sets the walls transparency alpha of this environment and fires a PropertyChangeEvent.
    
    Parameters:
    
    wallsAlpha - a value between 0 and 1, 0 meaning opaque and 1 invisible.
  - getDrawingMode
```
public HomeEnvironment.DrawingMode getDrawingMode()
```
    Returns the drawing mode of this environment.
  - setDrawingMode
```
public void setDrawingMode(HomeEnvironment.DrawingMode drawingMode)
```
    Sets the drawing mode of this environment and fires a PropertyChangeEvent.
  - getSubpartSizeUnderLight
```
public float getSubpartSizeUnderLight()
```
    Returns the size of subparts under home lights in this environment.
    
    Returns:
    
    a size in centimeters or 0 if home lights don't illuminate home.
    
    Since:
    
    3.7
  - setSubpartSizeUnderLight
```
public void setSubpartSizeUnderLight(float subpartSizeUnderLight)
```
    Sets the size of subparts under home lights of this environment and fires a PropertyChangeEvent.
    
    Since:
    
    3.7
  - isAllLevelsVisible
```
public boolean isAllLevelsVisible()
```
    Returns whether all levels should be visible or not.
  - setAllLevelsVisible
```
public void setAllLevelsVisible(boolean allLevelsVisible)
```
    Sets whether all levels should be visible or not and fires a PropertyChangeEvent.
  - getPhotoWidth
```
public int getPhotoWidth()
```
    Returns the preferred photo width.
    
    Since:
    
    2.0
  - setPhotoWidth
```
public void setPhotoWidth(int photoWidth)
```
    Sets the preferred photo width, and notifies listeners of this change.
    
    Since:
    
    2.0
  - getPhotoHeight
```
public int getPhotoHeight()
```
    Returns the preferred photo height.
    
    Since:
    
    2.0
  - setPhotoHeight
```
public void setPhotoHeight(int photoHeight)
```
    Sets the preferred photo height, and notifies listeners of this change.
    
    Since:
    
    2.0
  - getPhotoAspectRatio
```
public AspectRatio getPhotoAspectRatio()
```
    Returns the preferred photo aspect ratio.
    
    Since:
    
    2.0
  - setPhotoAspectRatio
```
public void setPhotoAspectRatio(AspectRatio photoAspectRatio)
```
    Sets the preferred photo aspect ratio, and notifies listeners of this change.
    
    Since:
    
    2.0
  - getPhotoQuality
```
public int getPhotoQuality()
```
    Returns the preferred photo quality.
    
    Since:
    
    2.0
  - setPhotoQuality
```
public void setPhotoQuality(int photoQuality)
```
    Sets preferred photo quality, and notifies listeners of this change.
    
    Since:
    
    2.0
  - getVideoWidth
```
public int getVideoWidth()
```
    Returns the preferred video width.
    
    Since:
    
    2.3
  - setVideoWidth
```
public void setVideoWidth(int videoWidth)
```
    Sets the preferred video width, and notifies listeners of this change.
    
    Since:
    
    2.3
  - getVideoHeight
```
public int getVideoHeight()
```
    Returns the preferred video height.
    
    Since:
    
    2.3
  - getVideoAspectRatio
```
public AspectRatio getVideoAspectRatio()
```
    Returns the preferred video aspect ratio.
    
    Since:
    
    2.3
  - setVideoAspectRatio
```
public void setVideoAspectRatio(AspectRatio videoAspectRatio)
```
    Sets the preferred video aspect ratio, and notifies listeners of this change.
    
    Since:
    
    2.3
  - getVideoQuality
```
public int getVideoQuality()
```
    Returns preferred video quality.
    
    Since:
    
    2.3
  - setVideoQuality
```
public void setVideoQuality(int videoQuality)
```
    Sets the preferred video quality, and notifies listeners of this change.
    
    Since:
    
    2.3
  - getVideoSpeed
```
public float getVideoSpeed()
```
    Returns the preferred speed of movements in videos in m/s.
    
    Since:
    
    6.0
  - setVideoSpeed
```
public void setVideoSpeed(float videoSpeed)
```
    Sets the preferred speed of movements in videos in m/s.
    
    Since:
    
    6.0
  - getVideoFrameRate
```
public int getVideoFrameRate()
```
    Returns the preferred video frame rate.
    
    Since:
    
    2.3
  - setVideoFrameRate
```
public void setVideoFrameRate(int videoFrameRate)
```
    Sets the preferred video frame rate, and notifies listeners of this change.
    
    Since:
    
    2.3
  - getVideoCameraPath
```
public java.util.List<Camera> getVideoCameraPath()
```
    Returns the preferred video camera path.
    
    Since:
    
    2.3
  - setVideoCameraPath
```
public void setVideoCameraPath(java.util.List<Camera> cameraPath)
```
    Sets the preferred video camera path, and notifies listeners of this change.
    
    Since:
    
    2.3
  - clone
```
public HomeEnvironment clone()
```
    Returns a clone of this environment.
    
    Overrides:
    
    clone in class HomeObject
    
    Since:
    
    2.3

Class HomeEnvironment

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.eteks.sweethome3d.model.HomeObject

Methods inherited from class java.lang.Object

Constructor Detail

HomeEnvironment

HomeEnvironment

HomeEnvironment

HomeEnvironment

HomeEnvironment

Method Detail

addPropertyChangeListener

removePropertyChangeListener

isObserverCameraElevationAdjusted

setObserverCameraElevationAdjusted

getGroundColor

setGroundColor

getGroundTexture

setGroundTexture

isBackgroundImageVisibleOnGround3D

setBackgroundImageVisibleOnGround3D

getSkyColor

setSkyColor

getSkyTexture

setSkyTexture

getLightColor

setLightColor

getCeillingLightColor

setCeillingLightColor

getWallsAlpha

setWallsAlpha

getDrawingMode

setDrawingMode

getSubpartSizeUnderLight

setSubpartSizeUnderLight

isAllLevelsVisible

setAllLevelsVisible

getPhotoWidth

setPhotoWidth

getPhotoHeight

setPhotoHeight

getPhotoAspectRatio

setPhotoAspectRatio

getPhotoQuality

setPhotoQuality

getVideoWidth

setVideoWidth

getVideoHeight

getVideoAspectRatio

setVideoAspectRatio

getVideoQuality

setVideoQuality

getVideoSpeed

setVideoSpeed

getVideoFrameRate

setVideoFrameRate

getVideoCameraPath

setVideoCameraPath

clone