com.eteks.sweethome3d.model

Class HomeLight

java.lang.Object

com.eteks.sweethome3d.model.HomeObject

com.eteks.sweethome3d.model.HomePieceOfFurniture

com.eteks.sweethome3d.model.HomeLight

All Implemented Interfaces:

Elevatable, Light, PieceOfFurniture, Selectable, java.io.Serializable, java.lang.Cloneable

public class HomeLight
extends HomePieceOfFurniture
implements Light

A light in home.

Since:

1.7

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HomeLight.Property The properties of a light that may change.

Nested classes/interfaces inherited from class com.eteks.sweethome3d.model.HomePieceOfFurniture

HomePieceOfFurniture.SortableProperty

Field Summary

Fields inherited from class com.eteks.sweethome3d.model.HomePieceOfFurniture

EMPTY_PROPERTY_ARRAY

Fields inherited from interface com.eteks.sweethome3d.model.PieceOfFurniture

DEFAULT_CUT_OUT_SHAPE, HIDE_EDGE_COLOR_MATERIAL, IDENTITY_ROTATION, SHOW_BACK_FACE

Constructor Summary

Constructors

Constructor and Description
HomeLight(Light light) Creates a home light from an existing one.
HomeLight(Light light, java.lang.String[] copiedProperties) Creates a home light from an existing one.
HomeLight(java.lang.String id, Light light) Creates a home light from an existing one.
HomeLight(java.lang.String id, Light light, java.lang.String[] copiedProperties) Creates a home light from an existing one.

Method Summary

Modifier and Type	Method and Description
HomeLight	clone() Returns a clone of this light.
java.lang.String[]	getLightSourceMaterialNames() Returns the material names of the light sources in the 3D model managed by this light.
LightSource[]	getLightSources() Returns the sources managed by this light.
float	getPower() Returns the power of this light.
void	setLightSourceMaterialNames(java.lang.String[] lightSourceMaterialNames) Sets the material names of the light sources in the 3D model managed by this light.
void	setLightSources(LightSource[] lightSources) Sets the sources managed by this light.
void	setPower(float power) Sets the power of this light.

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

containsPoint, getAngle, getCatalogId, getColor, getCreator, getCurrency, getDepth, getDepthInPlan, getDescription, getDropOnTopElevation, getElevation, getFurnitureComparator, getGroundElevation, getHeight, getHeightInPlan, getIcon, getInformation, getLevel, getLicense, getModel, getModelFlags, getModelMaterials, getModelRotation, getModelSize, getModelTransformations, getName, getNameAngle, getNameStyle, getNameXOffset, getNameYOffset, getPitch, getPlanIcon, getPoints, getPrice, getPriceValueAddedTaxIncluded, getRoll, getShininess, getStaircaseCutOutShape, getTexture, getValueAddedTax, getValueAddedTaxPercentage, getWidth, getWidthInPlan, getX, getY, intersectsRectangle, isAtLevel, isBackFaceShown, isBottomLeftPointAt, isBottomRightPointAt, isDeformable, isDoorOrWindow, isHorizontallyRotatable, isHorizontallyRotated, isModelCenteredAtOrigin, isModelMirrored, isMovable, isNameCenterPointAt, isNameVisible, isParallelToWall, isPointAt, isResizable, isTexturable, isTopLeftPointAt, isTopRightPointAt, isVisible, isWidthDepthDeformable, move, scale, setAngle, setBackFaceShown, setCatalogId, setColor, setCreator, setCurrency, setDepth, setDepthInPlan, setDescription, setElevation, setHeight, setHeightInPlan, setIcon, setInformation, setLevel, setLicense, setModel, setModelCenteredAtOrigin, setModelFlags, setModelMaterials, setModelMirrored, setModelRotation, setModelSize, setModelTransformations, setMovable, setName, setNameAngle, setNameStyle, setNameVisible, setNameXOffset, setNameYOffset, setPitch, setPlanIcon, setPrice, setRoll, setShininess, setStaircaseCutOutShape, setTexture, setValueAddedTaxPercentage, setVisible, setWidth, setWidthInPlan, setX, setY

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

Methods inherited from interface com.eteks.sweethome3d.model.PieceOfFurniture

getColor, getContentProperty, getCreator, getCurrency, getDepth, getDescription, getDropOnTopElevation, getElevation, getHeight, getIcon, getInformation, getLicense, getModel, getModelFlags, getModelRotation, getModelSize, getName, getPlanIcon, getPrice, getProperty, getPropertyNames, getStaircaseCutOutShape, getValueAddedTaxPercentage, getWidth, isBackFaceShown, isContentProperty, isDeformable, isDoorOrWindow, isHorizontallyRotatable, isMovable, isResizable, isTexturable, isWidthDepthDeformable

Constructor Detail

HomeLight

public HomeLight(Light light)

Creates a home light from an existing one. No additional properties will be copied.

Parameters:

light - the light from which data are copied

HomeLight

public HomeLight(Light light,
                 java.lang.String[] copiedProperties)

Creates a home light from an existing one. No additional properties will be copied.

Parameters:

light - the light from which data are copied

copiedProperties - the names of the additional properties which should be copied from the existing piece or null if all properties should be copied.

Since:

7.2

HomeLight

public HomeLight(java.lang.String id,
                 Light light)

Creates a home light from an existing one. No additional properties will be copied.

Parameters:

id - the ID of the light

light - the light from which data are copied

Since:

6.4

HomeLight

public HomeLight(java.lang.String id,
                 Light light,
                 java.lang.String[] copiedProperties)

Creates a home light from an existing one. No additional properties will be copied.

Parameters:

id - the ID of the light

light - the light from which data are copied

copiedProperties - the names of the additional properties which should be copied from the existing piece or null if all properties should be copied.

Since:

7.2

Method Detail

getLightSources

public LightSource[] getLightSources()

Returns the sources managed by this light. Each light source point is a percentage of the width, the depth and the height of this light. with the abscissa origin at the left side of the piece, the ordinate origin at the front side of the piece and the elevation origin at the bottom side of the piece.

Specified by:

getLightSources in interface Light

Returns:

a copy of light sources array.

setLightSources

public void setLightSources(LightSource[] lightSources)

Sets the sources managed by this light. Once this light is updated, listeners added to this light will receive a change notification.

Parameters:

lightSources - sources of the light

Since:

6.5

getLightSourceMaterialNames

public java.lang.String[] getLightSourceMaterialNames()

Returns the material names of the light sources in the 3D model managed by this light.

Specified by:

getLightSourceMaterialNames in interface Light

Returns:

a copy of light source material names array.

Since:

7.0

setLightSourceMaterialNames

public void setLightSourceMaterialNames(java.lang.String[] lightSourceMaterialNames)

Sets the material names of the light sources in the 3D model managed by this light. Once this light is updated, listeners added to this light will receive a change notification.

Parameters:

lightSourceMaterialNames - material names of the light sources

Since:

7.0

getPower

public float getPower()

Returns the power of this light.

Since:

3.0

setPower

public void setPower(float power)

Sets the power of this light. Once this light is updated, listeners added to this light will receive a change notification.

Parameters:

power - power of the light

Since:

3.0

clone

public HomeLight clone()

Returns a clone of this light.

Specified by:

clone in interface Selectable

Overrides:

clone in class HomePieceOfFurniture