Sweet Home 3D 3.4

com.eteks.sweethome3d.model
Class HomeEnvironment

java.lang.Object
  extended by com.eteks.sweethome3d.model.HomeEnvironment
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class HomeEnvironment
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

The environment attributes of a home.

Author:
Emmanuel Puybaret
See Also:
Serialized Form

Nested Class Summary
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
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.
 
Method Summary
 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.
 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.
 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 displayed or not.
 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 displayed or not 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 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 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 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 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HomeEnvironment

public HomeEnvironment()
Creates default environment.


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
Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(HomeEnvironment.Property property,
                                      java.beans.PropertyChangeListener listener)
Adds the property change listener in parameter to this environment.


removePropertyChangeListener

public void removePropertyChangeListener(HomeEnvironment.Property property,
                                         java.beans.PropertyChangeListener listener)
Removes the property change listener in parameter from this environment.


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.


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.


isAllLevelsVisible

public boolean isAllLevelsVisible()
Returns whether all levels should be displayed or not.


setAllLevelsVisible

public void setAllLevelsVisible(boolean allLevelsVisible)
Sets whether all levels should be displayed 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

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 java.lang.Object
Since:
2.3

Sweet Home 3D 3.4

? Copyrights 2006-2011 eTeks - All rights reserved
Distributed under GNU General Public License