Class HomeShelfUnit
Extends
HomePieceOfFurniture.
Defined in: SweetHome3D.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
HomeShelfUnit(id, shelfUnit, copiedProperties)
Creates a shelf unit from an existing one.
|
| Method Attributes | Method Name and Description |
|---|---|
|
clone()
Returns a clone of this shelf unit.
|
|
|
Returns the coordinates of the shelf box(es) in which other objects can be placed in this shelf unit.
|
|
|
Returns the elevation(s) at which other objects can be placed on this shelf unit.
|
|
|
setShelfBoxes(shelfElevations, shelfBoxes)
Sets the coordinates of the shelf box(es) in which other objects can be placed in this shelf.
|
|
|
setShelfElevations(shelfElevations)
Sets the elevation(s) at which other objects can be placed on this shelf unit.
|
- 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
HomeShelfUnit(id, shelfUnit, copiedProperties)
Creates a shelf unit from an existing one.
No additional properties will be copied.
Author: Emmanuel Puybaret.
Author: Emmanuel Puybaret.
- Parameters:
- {string} id
- the ID of the shelfUnit
- {Object} shelfUnit
- the shelfUnit 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
{HomeShelfUnit}
clone()
Returns a clone of this shelf unit.
- Returns:
- {HomeShelfUnit}
{com.eteks.sweethome3d.model.BoxBounds[]}
getShelfBoxes()
Returns the coordinates of the shelf box(es) in which other objects can be placed in this shelf unit.
- Returns:
- {com.eteks.sweethome3d.model.BoxBounds[]}
{float[]}
getShelfElevations()
Returns the elevation(s) at which other objects can be placed on this shelf unit.
- Returns:
- {float[]}
setShelfBoxes(shelfElevations, shelfBoxes)
Sets the coordinates of the shelf box(es) in which other objects can be placed in this shelf.
Once this light is updated, listeners added to this light will receive a change notification.
- Parameters:
- shelfElevations
- elevation of the shelves
- {com.eteks.sweethome3d.model.BoxBounds[]} shelfBoxes
setShelfElevations(shelfElevations)
Sets the elevation(s) at which other objects can be placed on this shelf unit.
Once this light is updated, listeners added to this light will receive a change notification.
- Parameters:
- {float[]} shelfElevations
- elevation of the shelves
