Class HomeLight
Extends
HomePieceOfFurniture.
Defined in: SweetHome3D.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
HomeLight(id, light, copiedProperties)
Creates a home light from an existing one.
|
| Method Attributes | Method Name and Description |
|---|---|
|
clone()
Returns a clone of this light.
|
|
|
Returns the material names of the light sources in the 3D model managed by this light.
|
|
|
Returns the sources managed by this light.
|
|
|
getPower()
Returns the power of this light.
|
|
|
setLightSourceMaterialNames(lightSourceMaterialNames)
Sets the material names of the light sources in the 3D model managed by this light.
|
|
|
setLightSources(lightSources)
Sets the sources managed by this light.
|
|
|
setPower(power)
Sets the power of this light.
|
- Methods borrowed from class HomePieceOfFurniture:
- containsPoint, getAngle, getCatalogId, getColor, getCreator, getCurrency, getDepth, getDepthInPlan, getDescription, getDropOnTopElevation, getElevation, 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 borrowed from class HomeObject:
- duplicate, firePropertyChange, getContentProperty, getId, getProperty, getPropertyNames, isContentProperty, setProperty
Class Detail
HomeLight(id, light, copiedProperties)
Creates a home light from an existing one.
No additional properties will be copied.
Author: Emmanuel Puybaret.
Author: Emmanuel Puybaret.
- Parameters:
- {string} id
- the ID of the light
- {Object} light
- the light from which data are copied
- {java.lang.String[]} copiedProperties
- the names of the additional properties which should be copied from the existing piece
or
nullif all properties should be copied.
Method Detail
{HomeLight}
clone()
Returns a clone of this light.
- Returns:
- {HomeLight}
{java.lang.String[]}
getLightSourceMaterialNames()
Returns the material names of the light sources in the 3D model managed by this light.
- Returns:
- {java.lang.String[]} a copy of light source material names array.
{com.eteks.sweethome3d.model.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.
- Returns:
- {com.eteks.sweethome3d.model.LightSource[]} a copy of light sources array.
{number}
getPower()
Returns the power of this light.
- Returns:
- {number}
setLightSourceMaterialNames(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:
- {java.lang.String[]} lightSourceMaterialNames
- material names of the light sources
setLightSources(lightSources)
Sets the sources managed by this light. Once this light is updated,
listeners added to this light will receive a change notification.
- Parameters:
- {com.eteks.sweethome3d.model.LightSource[]} lightSources
- sources of the light
setPower(power)
Sets the power of this light. Once this light is updated,
listeners added to this light will receive a change notification.
- Parameters:
- {number} power
- power of the light
