Class Index | File Index

Classes


Class HomeLight


Extends HomePieceOfFurniture.

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
HomeLight(id, light)
Creates a home light from an existing one.
Method Summary
Method Attributes Method Name and Description
 
Returns a clone of this light.
 
Returns the sources managed by this light.
 
Returns the power of 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, getModel, 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, setModel, setModelCenteredAtOrigin, 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, getId, getProperty, getPropertyNames, setProperty
Class Detail
HomeLight(id, light)
Creates a home light from an existing one.
Author: Emmanuel Puybaret.
Parameters:
{string} id
the ID of the light
{Object} light
the light from which data are copied
Method Detail
{HomeLight} clone()
Returns a clone of this light.
Returns:
{HomeLight}

{Array} 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:
{Array} a copy of light sources array.

{number} getPower()
Returns the power of this light.
Returns:
{number}

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:
{Array} 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

© Copyright 2021 Emmanuel PUYBARET / eTeks
Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Tue Mar 02 2021 19:55:52 GMT+0100 (CET)