com.eteks.sweethome3d.model

Class HomeShelfUnit

java.lang.Object

com.eteks.sweethome3d.model.HomeObject

com.eteks.sweethome3d.model.HomePieceOfFurniture

com.eteks.sweethome3d.model.HomeShelfUnit

All Implemented Interfaces:

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

public class HomeShelfUnit
extends HomePieceOfFurniture
implements ShelfUnit

A shelf unit in home.

Since:

7.2

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HomeShelfUnit.Property The properties of a shelf unit 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
HomeShelfUnit(ShelfUnit shelfUnit) Creates a shelf unit from an existing one.
HomeShelfUnit(ShelfUnit shelfUnit, java.lang.String[] copiedProperties) Creates a shelf unit from an existing one.
HomeShelfUnit(java.lang.String id, ShelfUnit shelfUnit) Creates a shelf unit from an existing one.
HomeShelfUnit(java.lang.String id, ShelfUnit shelfUnit, java.lang.String[] copiedProperties) Creates a shelf unit from an existing one.

Method Summary

Modifier and Type	Method and Description
HomeShelfUnit	clone() Returns a clone of this shelf unit.
BoxBounds[]	getShelfBoxes() Returns the coordinates of the shelf box(es) in which other objects can be placed in this shelf unit.
float[]	getShelfElevations() Returns the elevation(s) at which other objects can be placed on this shelf unit.
void	setShelfBoxes(BoxBounds[] shelfBoxes) Sets the coordinates of the shelf box(es) in which other objects can be placed in this shelf.
void	setShelfElevations(float[] shelfElevations) Sets the elevation(s) at which other objects can be placed on this shelf unit.

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

HomeShelfUnit

public HomeShelfUnit(ShelfUnit shelfUnit)

Creates a shelf unit from an existing one. No additional properties will be copied.

Parameters:

shelfUnit - the shelfUnit from which data are copied

HomeShelfUnit

public HomeShelfUnit(ShelfUnit shelfUnit,
                     java.lang.String[] copiedProperties)

Creates a shelf unit from an existing one. No additional properties will be copied.

Parameters:

shelfUnit - the shelfUnit 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.

HomeShelfUnit

public HomeShelfUnit(java.lang.String id,
                     ShelfUnit shelfUnit)

Creates a shelf unit from an existing one. No additional properties will be copied.

Parameters:

id - the ID of the shelfUnit

shelfUnit - the shelfUnit from which data are copied

HomeShelfUnit

public HomeShelfUnit(java.lang.String id,
                     ShelfUnit shelfUnit,
                     java.lang.String[] copiedProperties)

Creates a shelf unit from an existing one. No additional properties will be copied.

Parameters:

id - the ID of the shelfUnit

shelfUnit - the shelfUnit 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.

Method Detail

getShelfElevations

public float[] getShelfElevations()

Returns the elevation(s) at which other objects can be placed on this shelf unit.

Specified by:

getShelfElevations in interface ShelfUnit

setShelfElevations

public void setShelfElevations(float[] 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:

shelfElevations - elevation of the shelves

getShelfBoxes

public BoxBounds[] getShelfBoxes()

Returns the coordinates of the shelf box(es) in which other objects can be placed in this shelf unit.

Specified by:

getShelfBoxes in interface ShelfUnit

setShelfBoxes

public void setShelfBoxes(BoxBounds[] 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

clone

public HomeShelfUnit clone()

Returns a clone of this shelf unit.

Specified by:

clone in interface Selectable

Overrides:

clone in class HomePieceOfFurniture