HomePieceOfFurniture (Sweet Home 3D 7.5 API)

java.lang.Object
- com.eteks.sweethome3d.model.HomeObject
- - com.eteks.sweethome3d.model.HomePieceOfFurniture

All Implemented Interfaces:

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

Direct Known Subclasses:

HomeDoorOrWindow, HomeFurnitureGroup, HomeLight, HomeShelfUnit
```
public class HomePieceOfFurniture
extends HomeObject
implements PieceOfFurniture, Selectable, Elevatable
```
A piece of furniture in home.

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HomePieceOfFurniture.Property` The properties of a piece of furniture that may change.
`static class`	`HomePieceOfFurniture.SortableProperty` The properties on which home furniture may be sorted.

Field Summary

Fields
Modifier and Type Field and Description

protected static java.lang.String[] 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

Fields
Modifier and Type	Field and Description
`protected static java.lang.String[]`	`EMPTY_PROPERTY_ARRAY`

Constructor Summary

Constructors
Constructor and Description
`HomePieceOfFurniture(PieceOfFurniture piece)` Creates a home piece of furniture from an existing piece.
`HomePieceOfFurniture(PieceOfFurniture piece, java.lang.String[] copiedProperties)` Creates a home piece of furniture from an existing piece.
`HomePieceOfFurniture(java.lang.String id, PieceOfFurniture piece)` Creates a home piece of furniture from an existing piece.
`HomePieceOfFurniture(java.lang.String id, PieceOfFurniture piece, java.lang.String[] copiedProperties)` Creates a home piece of furniture from an existing piece.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`HomePieceOfFurniture`	`clone()` Returns a clone of this piece.
`boolean`	`containsPoint(float x, float y, float margin)` Returns `true` if this piece contains the point at (`x`, `y`) with a given `margin`.
`float`	`getAngle()` Returns the angle in radians of this piece around vertical axis.
`java.lang.String`	`getCatalogId()` Returns the catalog ID of this piece of furniture or `null` if it doesn't exist.
`java.lang.Integer`	`getColor()` Returns the color of this piece of furniture.
`java.lang.String`	`getCreator()` Returns the creator of this piece.
`java.lang.String`	`getCurrency()` Returns the price currency, noted with ISO 4217 code, or `null` if it has no price or default currency should be used.
`float`	`getDepth()` Returns the depth of this piece of furniture.
`float`	`getDepthInPlan()` Returns the depth of this piece of furniture in the horizontal plan (after pitch or roll is applied to it).
`java.lang.String`	`getDescription()` Returns the description of this piece of furniture.
`float`	`getDropOnTopElevation()` Returns the elevation at which should be placed an object dropped on this piece.
`float`	`getElevation()` Returns the elevation of the bottom of this piece of furniture on its level.
`static java.util.Comparator<HomePieceOfFurniture>`	`getFurnitureComparator(HomePieceOfFurniture.SortableProperty property)` Returns a comparator which compares furniture on a given `property` in ascending order.
`float`	`getGroundElevation()` Returns the elevation of the bottom of this piece of furniture from the ground according to the elevation of its level.
`float`	`getHeight()` Returns the height of this piece of furniture.
`float`	`getHeightInPlan()` Returns the height of this piece of furniture from the horizontal plan (after pitch or roll is applied to it).
`Content`	`getIcon()` Returns the icon of this piece of furniture.
`java.lang.String`	`getInformation()` Returns the additional information associated to this piece, or `null`.
`Level`	`getLevel()` Returns the level which this piece belongs to.
`java.lang.String`	`getLicense()` Returns the license of this piece, or `null`.
`Content`	`getModel()` Returns the 3D model of this piece of furniture.
`int`	`getModelFlags()` Returns the flags applied to the piece of furniture model.
`HomeMaterial[]`	`getModelMaterials()` Returns the materials applied to the 3D model of this piece of furniture.
`float[][]`	`getModelRotation()` Returns the rotation 3 by 3 matrix of this piece of furniture that ensures its model is correctly oriented.
`java.lang.Long`	`getModelSize()` Returns the size of the 3D model of this piece of furniture.
`Transformation[]`	`getModelTransformations()` Returns the transformations applied to the 3D model of this piece of furniture.
`java.lang.String`	`getName()` Returns the name of this piece of furniture.
`float`	`getNameAngle()` Returns the angle in radians used to display the piece name.
`TextStyle`	`getNameStyle()` Returns the text style used to display piece name.
`float`	`getNameXOffset()` Returns the distance along x axis applied to piece abscissa to display piece name.
`float`	`getNameYOffset()` Returns the distance along y axis applied to piece ordinate to display piece name.
`float`	`getPitch()` Returns the pitch angle in radians of this piece of furniture.
`Content`	`getPlanIcon()` Returns the icon of this piece of furniture displayed in plan or `null`.
`float[][]`	`getPoints()` Returns the points of each corner of a piece.
`java.math.BigDecimal`	`getPrice()` Returns the price of this piece of furniture or `null`.
`java.math.BigDecimal`	`getPriceValueAddedTaxIncluded()` Returns the price of this piece of furniture, Value Added Tax included.
`float`	`getRoll()` Returns the roll angle in radians of this piece of furniture.
`java.lang.Float`	`getShininess()` Returns the shininess of this piece of furniture.
`java.lang.String`	`getStaircaseCutOutShape()` Returns the shape used to cut out upper levels when they intersect with the piece like a staircase.
`HomeTexture`	`getTexture()` Returns the texture of this piece of furniture.
`java.math.BigDecimal`	`getValueAddedTax()` Returns the Value Added Tax applied to the price of this piece of furniture.
`java.math.BigDecimal`	`getValueAddedTaxPercentage()` Returns the Value Added Tax percentage applied to the price of this piece of furniture.
`float`	`getWidth()` Returns the width of this piece of furniture.
`float`	`getWidthInPlan()` Returns the width of this piece of furniture in the horizontal plan (after pitch or roll is applied to it).
`float`	`getX()` Returns the abscissa of the center of this piece of furniture.
`float`	`getY()` Returns the ordinate of the center of this piece of furniture.
`boolean`	`intersectsRectangle(float x0, float y0, float x1, float y1)` Returns `true` if this piece intersects with the horizontal rectangle which opposite corners are at points (`x0`, `y0`) and (`x1`, `y1`).
`boolean`	`isAtLevel(Level level)` Returns `true` if this piece is at the given `level` or at a level with the same elevation and a smaller elevation index or if the elevation of its highest point is higher than `level` elevation.
`boolean`	`isBackFaceShown()` Returns `true` if the back face of the piece of furniture model should be displayed.
`boolean`	`isBottomLeftPointAt(float x, float y, float margin)` Returns `true` if the bottom left point of this piece is the point at (`x`, `y`) with a given `margin`, and if that point is closer to bottom left point than to top left and bottom right points.
`boolean`	`isBottomRightPointAt(float x, float y, float margin)` Returns `true` if the bottom right point of this piece is the point at (`x`, `y`) with a given `margin`, and if that point is closer to top left point than to top right and bottom left points.
`boolean`	`isDeformable()` Returns `true` if this piece is deformable.
`boolean`	`isDoorOrWindow()` Returns `true` if this piece of furniture is a door or a window.
`boolean`	`isHorizontallyRotatable()` Returns `false` if this piece should not rotate around an horizontal axis.
`boolean`	`isHorizontallyRotated()` Returns `true` if the pitch or roll angle of this piece is different from 0.
`boolean`	`isModelCenteredAtOrigin()` Returns `true` if model center should be always centered at the origin when model rotation isn't `null`.
`boolean`	`isModelMirrored()` Returns `true` if the model of this piece should be mirrored.
`boolean`	`isMovable()` Returns `true` if this piece of furniture is movable.
`boolean`	`isNameCenterPointAt(float x, float y, float margin)` Returns `true` if the center point at which is displayed the name of this piece is equal to the point at (`x`, `y`) with a given `margin`.
`boolean`	`isNameVisible()` Returns whether the name of this piece should be drawn or not.
`boolean`	`isParallelToWall(Wall wall)` Returns `true` if the front side of this piece is parallel to the given `wall` with a margin.
`boolean`	`isPointAt(float x, float y, float margin)` Returns `true` if one of the corner of this piece is the point at (`x`, `y`) with a given `margin`.
`boolean`	`isResizable()` Returns `true` if this piece is resizable.
`boolean`	`isTexturable()` Returns `false` if this piece should always keep the same color or texture.
`boolean`	`isTopLeftPointAt(float x, float y, float margin)` Returns `true` if the top left point of this piece is the point at (`x`, `y`) with a given `margin`, and if that point is closer to top left point than to top right and bottom left points.
`boolean`	`isTopRightPointAt(float x, float y, float margin)` Returns `true` if the top right point of this piece is the point at (`x`, `y`) with a given `margin`, and if that point is closer to top right point than to top left and bottom right points.
`boolean`	`isVisible()` Returns `true` if this piece of furniture is visible.
`boolean`	`isWidthDepthDeformable()` Returns `true` if this piece is deformable.
`void`	`move(float dx, float dy)` Moves this piece of (`dx`, `dy`) units.
`void`	`scale(float scale)` Scales this piece of furniture with the given `scale`.
`void`	`setAngle(float angle)` Sets the angle of this piece around vertical axis.
`void`	`setBackFaceShown(boolean backFaceShown)` Deprecated. Prefer use `setModelFlags(int)` with `PieceOfFurniture.SHOW_BACK_FACE` flag.
`void`	`setCatalogId(java.lang.String catalogId)` Sets the catalog ID of this piece of furniture.
`void`	`setColor(java.lang.Integer color)` Sets the color of this piece of furniture.
`void`	`setCreator(java.lang.String creator)` Sets the creator of this piece.
`void`	`setCurrency(java.lang.String currency)` Sets the price currency, noted with ISO 4217 code.
`void`	`setDepth(float depth)` Sets the depth of this piece of furniture.
`void`	`setDepthInPlan(float depthInPlan)` Sets the depth of this piece of furniture in the horizontal plan (after pitch or roll is applied to it).
`void`	`setDescription(java.lang.String description)` Sets the description of this piece of furniture.
`void`	`setElevation(float elevation)` Sets the elevation of this piece of furniture on its level.
`void`	`setHeight(float height)` Sets the height of this piece of furniture.
`void`	`setHeightInPlan(float heightInPlan)` Sets the height of this piece of furniture from the horizontal plan (after pitch or roll is applied to it).
`void`	`setIcon(Content icon)` Sets the icon of this piece of furniture.
`void`	`setInformation(java.lang.String information)` Sets the additional information associated to this piece .
`void`	`setLevel(Level level)` Sets the level of this piece of furniture.
`void`	`setLicense(java.lang.String license)` Sets the the license of this piece .
`void`	`setModel(Content model)` Sets the 3D model of this piece of furniture.
`void`	`setModelCenteredAtOrigin(boolean modelCenteredAtOrigin)` Sets whether model center should be always centered at the origin when model rotation isn't `null`.
`void`	`setModelFlags(int modelFlags)` Sets the flags applied to the piece of furniture model.
`void`	`setModelMaterials(HomeMaterial[] modelMaterials)` Sets the materials of the 3D model of this piece of furniture.
`void`	`setModelMirrored(boolean modelMirrored)` Sets whether the model of this piece of furniture is mirrored or not.
`void`	`setModelRotation(float[][] modelRotation)` Sets the rotation 3 by 3 matrix of this piece of furniture and notifies listeners of this change.
`void`	`setModelSize(java.lang.Long modelSize)` Sets the size of the 3D model of this piece of furniture.
`void`	`setModelTransformations(Transformation[] modelTransformations)` Sets the transformations applied to some parts of the 3D model of this piece of furniture.
`void`	`setMovable(boolean movable)` Sets whether this piece is movable or not.
`void`	`setName(java.lang.String name)` Sets the name of this piece of furniture.
`void`	`setNameAngle(float nameAngle)` Sets the angle in radians used to display the piece name.
`void`	`setNameStyle(TextStyle nameStyle)` Sets the text style used to display piece name.
`void`	`setNameVisible(boolean nameVisible)` Sets whether the name of this piece is visible or not.
`void`	`setNameXOffset(float nameXOffset)` Sets the distance along x axis applied to piece abscissa to display piece name.
`void`	`setNameYOffset(float nameYOffset)` Sets the distance along y axis applied to piece ordinate to display piece name.
`void`	`setPitch(float pitch)` Sets the pitch angle in radians of this piece and notifies listeners of this change.
`void`	`setPlanIcon(Content planIcon)` Sets the plan icon of this piece of furniture.
`void`	`setPrice(java.math.BigDecimal price)` Sets the price of this piece of furniture.
`void`	`setRoll(float roll)` Sets the roll angle in radians of this piece and notifies listeners of this change.
`void`	`setShininess(java.lang.Float shininess)` Sets the shininess of this piece of furniture or `null` if piece shininess is unchanged.
`void`	`setStaircaseCutOutShape(java.lang.String staircaseCutOutShape)` Sets the shape used to cut out upper levels when they intersect with the piece like a staircase.
`void`	`setTexture(HomeTexture texture)` Sets the texture of this piece of furniture.
`void`	`setValueAddedTaxPercentage(java.math.BigDecimal valueAddedTaxPercentage)` Sets the Value Added Tax percentage applied to prices.
`void`	`setVisible(boolean visible)` Sets whether this piece of furniture is visible or not.
`void`	`setWidth(float width)` Sets the width of this piece of furniture.
`void`	`setWidthInPlan(float widthInPlan)` Sets the width of this piece of furniture in the horizontal plan (after pitch or roll is applied to it).
`void`	`setX(float x)` Sets the abscissa of the center of this piece.
`void`	`setY(float y)` Sets the ordinate of the center of this piece.

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
getContentProperty, getProperty, getPropertyNames, isContentProperty

- Field Detail
  - EMPTY_PROPERTY_ARRAY
```
protected static final java.lang.String[] EMPTY_PROPERTY_ARRAY
```
- Constructor Detail
  - HomePieceOfFurniture
```
public HomePieceOfFurniture(PieceOfFurniture piece)
```
    Creates a home piece of furniture from an existing piece. No additional properties will be copied.
    
    Parameters:
    
    piece - the piece from which data are copied
  - HomePieceOfFurniture
```
public HomePieceOfFurniture(PieceOfFurniture piece,
                            java.lang.String[] copiedProperties)
```
    Creates a home piece of furniture from an existing piece.
    
    Parameters:
    
    piece - the piece 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
  - HomePieceOfFurniture
```
public HomePieceOfFurniture(java.lang.String id,
                            PieceOfFurniture piece)
```
    Creates a home piece of furniture from an existing piece. No additional properties will be copied.
    
    Parameters:
    
    id - the ID of the piece
    
    piece - the piece from which data are copied
    
    Since:
    
    6.4
  - HomePieceOfFurniture
```
public HomePieceOfFurniture(java.lang.String id,
                            PieceOfFurniture piece,
                            java.lang.String[] copiedProperties)
```
    Creates a home piece of furniture from an existing piece.
    
    Parameters:
    
    id - the ID of the piece
    
    piece - the piece 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
  - getCatalogId
```
public java.lang.String getCatalogId()
```
    Returns the catalog ID of this piece of furniture or null if it doesn't exist.
  - setCatalogId
```
public void setCatalogId(java.lang.String catalogId)
```
    Sets the catalog ID of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    6.5
  - getName
```
public java.lang.String getName()
```
    Returns the name of this piece of furniture.
    
    Specified by:
    
    getName in interface PieceOfFurniture
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
  - isNameVisible
```
public boolean isNameVisible()
```
    Returns whether the name of this piece should be drawn or not.
  - setNameVisible
```
public void setNameVisible(boolean nameVisible)
```
    Sets whether the name of this piece is visible or not. Once this piece of furniture is updated, listeners added to this piece will receive a change notification.
  - getNameXOffset
```
public float getNameXOffset()
```
    Returns the distance along x axis applied to piece abscissa to display piece name.
  - setNameXOffset
```
public void setNameXOffset(float nameXOffset)
```
    Sets the distance along x axis applied to piece abscissa to display piece name. Once this piece is updated, listeners added to this piece will receive a change notification.
  - getNameYOffset
```
public float getNameYOffset()
```
    Returns the distance along y axis applied to piece ordinate to display piece name.
  - setNameYOffset
```
public void setNameYOffset(float nameYOffset)
```
    Sets the distance along y axis applied to piece ordinate to display piece name. Once this piece is updated, listeners added to this piece will receive a change notification.
  - getNameStyle
```
public TextStyle getNameStyle()
```
    Returns the text style used to display piece name.
  - setNameStyle
```
public void setNameStyle(TextStyle nameStyle)
```
    Sets the text style used to display piece name. Once this piece is updated, listeners added to this piece will receive a change notification.
  - getNameAngle
```
public float getNameAngle()
```
    Returns the angle in radians used to display the piece name.
    
    Since:
    
    3.6
  - setNameAngle
```
public void setNameAngle(float nameAngle)
```
    Sets the angle in radians used to display the piece name. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    3.6
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the description of this piece of furniture. The returned value may be null.
    
    Specified by:
    
    getDescription in interface PieceOfFurniture
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the description of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
  - getInformation
```
public java.lang.String getInformation()
```
    Returns the additional information associated to this piece, or null.
    
    Specified by:
    
    getInformation in interface PieceOfFurniture
    
    Since:
    
    4.2
  - setInformation
```
public void setInformation(java.lang.String information)
```
    Sets the additional information associated to this piece . Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    6.5
  - getCreator
```
public java.lang.String getCreator()
```
    Returns the creator of this piece.
    
    Specified by:
    
    getCreator in interface PieceOfFurniture
    
    Since:
    
    4.2
  - setCreator
```
public void setCreator(java.lang.String creator)
```
    Sets the creator of this piece. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    6.5
  - getLicense
```
public java.lang.String getLicense()
```
    Returns the license of this piece, or null.
    
    Specified by:
    
    getLicense in interface PieceOfFurniture
    
    Since:
    
    7.2
  - setLicense
```
public void setLicense(java.lang.String license)
```
    Sets the the license of this piece . Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    7.2
  - getDepth
```
public float getDepth()
```
    Returns the depth of this piece of furniture.
    
    Specified by:
    
    getDepth in interface PieceOfFurniture
  - setDepth
```
public void setDepth(float depth)
```
    Sets the depth of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Throws:
    
    java.lang.IllegalStateException - if this piece of furniture isn't resizable
  - getDepthInPlan
```
public float getDepthInPlan()
```
    Returns the depth of this piece of furniture in the horizontal plan (after pitch or roll is applied to it).
    
    Since:
    
    5.5
  - setDepthInPlan
```
public void setDepthInPlan(float depthInPlan)
```
    Sets the depth of this piece of furniture in the horizontal plan (after pitch or roll is applied to it). listeners added to this piece will receive a change notification.
    
    Since:
    
    5.5
  - getHeight
```
public float getHeight()
```
    Returns the height of this piece of furniture.
    
    Specified by:
    
    getHeight in interface PieceOfFurniture
  - setHeight
```
public void setHeight(float height)
```
    Sets the height of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Throws:
    
    java.lang.IllegalStateException - if this piece of furniture isn't resizable
  - getHeightInPlan
```
public float getHeightInPlan()
```
    Returns the height of this piece of furniture from the horizontal plan (after pitch or roll is applied to it).
    
    Since:
    
    5.5
  - setHeightInPlan
```
public void setHeightInPlan(float heightInPlan)
```
    Sets the height of this piece of furniture from the horizontal plan (after pitch or roll is applied to it). Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    5.5
  - getWidth
```
public float getWidth()
```
    Returns the width of this piece of furniture.
    
    Specified by:
    
    getWidth in interface PieceOfFurniture
  - setWidth
```
public void setWidth(float width)
```
    Sets the width of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Throws:
    
    java.lang.IllegalStateException - if this piece of furniture isn't resizable
  - getWidthInPlan
```
public float getWidthInPlan()
```
    Returns the width of this piece of furniture in the horizontal plan (after pitch or roll is applied to it).
    
    Since:
    
    5.5
  - setWidthInPlan
```
public void setWidthInPlan(float widthInPlan)
```
    Sets the width of this piece of furniture in the horizontal plan (after pitch or roll is applied to it). Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    5.5
  - scale
```
public void scale(float scale)
```
    Scales this piece of furniture with the given scale. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    5.5
  - getElevation
```
public float getElevation()
```
    Returns the elevation of the bottom of this piece of furniture on its level.
    
    Specified by:
    
    getElevation in interface PieceOfFurniture
  - getDropOnTopElevation
```
public float getDropOnTopElevation()
```
    Returns the elevation at which should be placed an object dropped on this piece.
    
    Specified by:
    
    getDropOnTopElevation in interface PieceOfFurniture
    
    Returns:
    
    a percentage of the height of this piece. A negative value means that the piece should be ignored when an object is dropped on it.
    
    Since:
    
    4.4
  - getGroundElevation
```
public float getGroundElevation()
```
    Returns the elevation of the bottom of this piece of furniture from the ground according to the elevation of its level.
    
    Since:
    
    3.4
  - setElevation
```
public void setElevation(float elevation)
```
    Sets the elevation of this piece of furniture on its level. Once this piece is updated, listeners added to this piece will receive a change notification.
  - isMovable
```
public boolean isMovable()
```
    Returns true if this piece of furniture is movable.
    
    Specified by:
    
    isMovable in interface PieceOfFurniture
  - setMovable
```
public void setMovable(boolean movable)
```
    Sets whether this piece is movable or not.
    
    Since:
    
    3.0
  - isDoorOrWindow
```
public boolean isDoorOrWindow()
```
    Returns true if this piece of furniture is a door or a window. As this method existed before HomeDoorOrWindow class, you shouldn't rely on the value returned by this method to guess if a piece is an instance of DoorOrWindow class.
    
    Specified by:
    
    isDoorOrWindow in interface PieceOfFurniture
  - getIcon
```
public Content getIcon()
```
    Returns the icon of this piece of furniture.
    
    Specified by:
    
    getIcon in interface PieceOfFurniture
  - setIcon
```
public void setIcon(Content icon)
```
    Sets the icon of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    6.5
  - getPlanIcon
```
public Content getPlanIcon()
```
    Returns the icon of this piece of furniture displayed in plan or null.
    
    Specified by:
    
    getPlanIcon in interface PieceOfFurniture
    
    Since:
    
    2.2
  - setPlanIcon
```
public void setPlanIcon(Content planIcon)
```
    Sets the plan icon of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    6.5
  - getModel
```
public Content getModel()
```
    Returns the 3D model of this piece of furniture.
    
    Specified by:
    
    getModel in interface PieceOfFurniture
  - setModel
```
public void setModel(Content model)
```
    Sets the 3D model of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    6.5
  - getModelSize
```
public java.lang.Long getModelSize()
```
    Returns the size of the 3D model of this piece of furniture.
    
    Specified by:
    
    getModelSize in interface PieceOfFurniture
    
    Since:
    
    5.5
  - setModelSize
```
public void setModelSize(java.lang.Long modelSize)
```
    Sets the size of the 3D model of this piece of furniture. This method should be called only to update a piece created with an older version.
    
    Since:
    
    5.5
  - getModelMaterials
```
public HomeMaterial[] getModelMaterials()
```
    Returns the materials applied to the 3D model of this piece of furniture.
    
    Returns:
    
    the materials of the 3D model or null if the individual materials of the 3D model are not modified.
    
    Since:
    
    4.0
  - setModelMaterials
```
public void setModelMaterials(HomeMaterial[] modelMaterials)
```
    Sets the materials of the 3D model of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Parameters:
    
    modelMaterials - the materials of the 3D model or null if they shouldn't be changed
    
    Throws:
    
    java.lang.IllegalStateException - if this piece of furniture isn't texturable
    
    Since:
    
    4.0
  - getColor
```
public java.lang.Integer getColor()
```
    Returns the color of this piece of furniture.
    
    Specified by:
    
    getColor in interface PieceOfFurniture
    
    Returns:
    
    the color of the piece as RGB code or null if piece color is unchanged.
  - setColor
```
public void setColor(java.lang.Integer color)
```
    Sets the color of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Parameters:
    
    color - the color of this piece of furniture or null if piece color is the default one
    
    Throws:
    
    java.lang.IllegalStateException - if this piece of furniture isn't texturable
  - getTexture
```
public HomeTexture getTexture()
```
    Returns the texture of this piece of furniture.
    
    Returns:
    
    the texture of the piece or null if piece texture is unchanged.
    
    Since:
    
    2.3
  - setTexture
```
public void setTexture(HomeTexture texture)
```
    Sets the texture of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Parameters:
    
    texture - the texture of this piece of furniture or null if piece texture is the default one
    
    Throws:
    
    java.lang.IllegalStateException - if this piece of furniture isn't texturable
    
    Since:
    
    2.3
  - getShininess
```
public java.lang.Float getShininess()
```
    Returns the shininess of this piece of furniture.
    
    Returns:
    
    a value between 0 (matt) and 1 (very shiny) or null if piece shininess is unchanged.
    
    Since:
    
    3.0
  - setShininess
```
public void setShininess(java.lang.Float shininess)
```
    Sets the shininess of this piece of furniture or null if piece shininess is unchanged. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Throws:
    
    java.lang.IllegalStateException - if this piece of furniture isn't texturable
    
    Since:
    
    3.0
  - isResizable
```
public boolean isResizable()
```
    Returns true if this piece is resizable.
    
    Specified by:
    
    isResizable in interface PieceOfFurniture
  - isDeformable
```
public boolean isDeformable()
```
    Returns true if this piece is deformable.
    
    Specified by:
    
    isDeformable in interface PieceOfFurniture
    
    Since:
    
    3.0
  - isWidthDepthDeformable
```
public boolean isWidthDepthDeformable()
```
    Returns true if this piece is deformable.
    
    Specified by:
    
    isWidthDepthDeformable in interface PieceOfFurniture
    
    Since:
    
    5.5
  - isTexturable
```
public boolean isTexturable()
```
    Returns false if this piece should always keep the same color or texture.
    
    Specified by:
    
    isTexturable in interface PieceOfFurniture
    
    Since:
    
    3.0
  - isHorizontallyRotatable
```
public boolean isHorizontallyRotatable()
```
    Returns false if this piece should not rotate around an horizontal axis.
    
    Specified by:
    
    isHorizontallyRotatable in interface PieceOfFurniture
    
    Since:
    
    5.5
  - getPrice
```
public java.math.BigDecimal getPrice()
```
    Returns the price of this piece of furniture or null.
    
    Specified by:
    
    getPrice in interface PieceOfFurniture
  - setPrice
```
public void setPrice(java.math.BigDecimal price)
```
    Sets the price of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    4.0
  - getValueAddedTaxPercentage
```
public java.math.BigDecimal getValueAddedTaxPercentage()
```
    Returns the Value Added Tax percentage applied to the price of this piece of furniture.
    
    Specified by:
    
    getValueAddedTaxPercentage in interface PieceOfFurniture
  - setValueAddedTaxPercentage
```
public void setValueAddedTaxPercentage(java.math.BigDecimal valueAddedTaxPercentage)
```
    Sets the Value Added Tax percentage applied to prices.
    
    Since:
    
    6.0
  - getValueAddedTax
```
public java.math.BigDecimal getValueAddedTax()
```
    Returns the Value Added Tax applied to the price of this piece of furniture.
  - getPriceValueAddedTaxIncluded
```
public java.math.BigDecimal getPriceValueAddedTaxIncluded()
```
    Returns the price of this piece of furniture, Value Added Tax included.
  - getCurrency
```
public java.lang.String getCurrency()
```
    Returns the price currency, noted with ISO 4217 code, or null if it has no price or default currency should be used.
    
    Specified by:
    
    getCurrency in interface PieceOfFurniture
    
    Since:
    
    3.4
  - setCurrency
```
public void setCurrency(java.lang.String currency)
```
    Sets the price currency, noted with ISO 4217 code. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    6.0
  - isVisible
```
public boolean isVisible()
```
    Returns true if this piece of furniture is visible.
  - setVisible
```
public void setVisible(boolean visible)
```
    Sets whether this piece of furniture is visible or not. Once this piece is updated, listeners added to this piece will receive a change notification.
  - getX
```
public float getX()
```
    Returns the abscissa of the center of this piece of furniture.
  - setX
```
public void setX(float x)
```
    Sets the abscissa of the center of this piece. Once this piece is updated, listeners added to this piece will receive a change notification.
  - getY
```
public float getY()
```
    Returns the ordinate of the center of this piece of furniture.
  - setY
```
public void setY(float y)
```
    Sets the ordinate of the center of this piece. Once this piece is updated, listeners added to this piece will receive a change notification.
  - getAngle
```
public float getAngle()
```
    Returns the angle in radians of this piece around vertical axis.
  - setAngle
```
public void setAngle(float angle)
```
    Sets the angle of this piece around vertical axis. Once this piece is updated, listeners added to this piece will receive a change notification.
  - getPitch
```
public float getPitch()
```
    Returns the pitch angle in radians of this piece of furniture.
    
    Since:
    
    5.5
  - setPitch
```
public void setPitch(float pitch)
```
    Sets the pitch angle in radians of this piece and notifies listeners of this change. Pitch axis is horizontal lateral (or transverse) axis.
    
    Since:
    
    5.5
  - getRoll
```
public float getRoll()
```
    Returns the roll angle in radians of this piece of furniture.
    
    Since:
    
    5.5
  - setRoll
```
public void setRoll(float roll)
```
    Sets the roll angle in radians of this piece and notifies listeners of this change. Roll axis is horizontal longitudinal axis.
    
    Since:
    
    5.5
  - isHorizontallyRotated
```
public boolean isHorizontallyRotated()
```
    Returns true if the pitch or roll angle of this piece is different from 0.
    
    Since:
    
    5.5
  - getModelRotation
```
public float[][] getModelRotation()
```
    Returns the rotation 3 by 3 matrix of this piece of furniture that ensures its model is correctly oriented.
    
    Specified by:
    
    getModelRotation in interface PieceOfFurniture
  - setModelRotation
```
public void setModelRotation(float[][] modelRotation)
```
    Sets the rotation 3 by 3 matrix of this piece of furniture and notifies listeners of this change.
    
    Since:
    
    6.5
  - isModelMirrored
```
public boolean isModelMirrored()
```
    Returns true if the model of this piece should be mirrored.
  - setModelMirrored
```
public void setModelMirrored(boolean modelMirrored)
```
    Sets whether the model of this piece of furniture is mirrored or not. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Throws:
    
    java.lang.IllegalStateException - if this piece of furniture isn't resizable
  - isModelCenteredAtOrigin
```
public boolean isModelCenteredAtOrigin()
```
    Returns true if model center should be always centered at the origin when model rotation isn't null.
    
    Returns:
    
    false by default if version < 5.5
    
    Since:
    
    5.5
  - setModelCenteredAtOrigin
```
public void setModelCenteredAtOrigin(boolean modelCenteredAtOrigin)
```
    Sets whether model center should be always centered at the origin when model rotation isn't null. This method should be called only to keep unchanged the (wrong) location of a rotated model created with version < 5.5.
    
    Since:
    
    5.5
  - isBackFaceShown
```
public boolean isBackFaceShown()
```
    Returns true if the back face of the piece of furniture model should be displayed.
    
    Specified by:
    
    isBackFaceShown in interface PieceOfFurniture
  - setBackFaceShown
```
public void setBackFaceShown(boolean backFaceShown)
```
    Deprecated. Prefer use setModelFlags(int) with PieceOfFurniture.SHOW_BACK_FACE flag.
    
    Sets whether the back face of the piece of furniture model should be displayed. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    6.5
  - getModelFlags
```
public int getModelFlags()
```
    Returns the flags applied to the piece of furniture model.
    
    Specified by:
    
    getModelFlags in interface PieceOfFurniture
    
    Since:
    
    7.0
  - setModelFlags
```
public void setModelFlags(int modelFlags)
```
    Sets the flags applied to the piece of furniture model. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    7.0
  - getModelTransformations
```
public Transformation[] getModelTransformations()
```
    Returns the transformations applied to the 3D model of this piece of furniture.
    
    Returns:
    
    the transformations of the 3D model or null if the 3D model is not transformed.
    
    Since:
    
    6.0
  - setModelTransformations
```
public void setModelTransformations(Transformation[] modelTransformations)
```
    Sets the transformations applied to some parts of the 3D model of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Parameters:
    
    modelTransformations - the transformations of the 3D model or null if no transformation shouldn't be applied
    
    Since:
    
    6.0
  - getStaircaseCutOutShape
```
public java.lang.String getStaircaseCutOutShape()
```
    Returns the shape used to cut out upper levels when they intersect with the piece like a staircase.
    
    Specified by:
    
    getStaircaseCutOutShape in interface PieceOfFurniture
    
    Since:
    
    3.4
  - setStaircaseCutOutShape
```
public void setStaircaseCutOutShape(java.lang.String staircaseCutOutShape)
```
    Sets the shape used to cut out upper levels when they intersect with the piece like a staircase. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    6.5
  - getLevel
```
public Level getLevel()
```
    Returns the level which this piece belongs to.
    
    Specified by:
    
    getLevel in interface Elevatable
    
    Since:
    
    3.4
  - setLevel
```
public void setLevel(Level level)
```
    Sets the level of this piece of furniture. Once this piece is updated, listeners added to this piece will receive a change notification.
    
    Since:
    
    3.4
  - isAtLevel
```
public boolean isAtLevel(Level level)
```
    Returns true if this piece is at the given level or at a level with the same elevation and a smaller elevation index or if the elevation of its highest point is higher than level elevation.
    
    Specified by:
    
    isAtLevel in interface Elevatable
    
    Since:
    
    3.4
  - getPoints
```
public float[][] getPoints()
```
    Returns the points of each corner of a piece.
    
    Specified by:
    
    getPoints in interface Selectable
    
    Returns:
    
    an array of the 4 (x,y) coordinates of the piece corners.
  - intersectsRectangle
```
public boolean intersectsRectangle(float x0,
                                   float y0,
                                   float x1,
                                   float y1)
```
    Returns true if this piece intersects with the horizontal rectangle which opposite corners are at points (x0, y0) and (x1, y1).
    
    Specified by:
    
    intersectsRectangle in interface Selectable
  - containsPoint
```
public boolean containsPoint(float x,
                             float y,
                             float margin)
```
    Returns true if this piece contains the point at (x, y) with a given margin.
    
    Specified by:
    
    containsPoint in interface Selectable
  - isPointAt
```
public boolean isPointAt(float x,
                         float y,
                         float margin)
```
    Returns true if one of the corner of this piece is the point at (x, y) with a given margin.
  - isTopLeftPointAt
```
public boolean isTopLeftPointAt(float x,
                                float y,
                                float margin)
```
    Returns true if the top left point of this piece is the point at (x, y) with a given margin, and if that point is closer to top left point than to top right and bottom left points.
  - isTopRightPointAt
```
public boolean isTopRightPointAt(float x,
                                 float y,
                                 float margin)
```
    Returns true if the top right point of this piece is the point at (x, y) with a given margin, and if that point is closer to top right point than to top left and bottom right points.
  - isBottomLeftPointAt
```
public boolean isBottomLeftPointAt(float x,
                                   float y,
                                   float margin)
```
    Returns true if the bottom left point of this piece is the point at (x, y) with a given margin, and if that point is closer to bottom left point than to top left and bottom right points.
  - isBottomRightPointAt
```
public boolean isBottomRightPointAt(float x,
                                    float y,
                                    float margin)
```
    Returns true if the bottom right point of this piece is the point at (x, y) with a given margin, and if that point is closer to top left point than to top right and bottom left points.
  - isNameCenterPointAt
```
public boolean isNameCenterPointAt(float x,
                                   float y,
                                   float margin)
```
    Returns true if the center point at which is displayed the name of this piece is equal to the point at (x, y) with a given margin.
  - isParallelToWall
```
public boolean isParallelToWall(Wall wall)
```
    Returns true if the front side of this piece is parallel to the given wall with a margin.
    
    Since:
    
    5.5
  - move
```
public void move(float dx,
                 float dy)
```
    Moves this piece of (dx, dy) units.
    
    Specified by:
    
    move in interface Selectable
  - clone
```
public HomePieceOfFurniture clone()
```
    Returns a clone of this piece.
    
    Specified by:
    
    clone in interface Selectable
    
    Overrides:
    
    clone in class HomeObject
  - getFurnitureComparator
```
public static java.util.Comparator<HomePieceOfFurniture> getFurnitureComparator(HomePieceOfFurniture.SortableProperty property)
```
    Returns a comparator which compares furniture on a given property in ascending order.

Class HomePieceOfFurniture

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_PROPERTY_ARRAY

Constructor Detail

HomePieceOfFurniture

HomePieceOfFurniture

HomePieceOfFurniture

HomePieceOfFurniture

Method Detail

getCatalogId

setCatalogId

getName

setName

isNameVisible

setNameVisible

getNameXOffset

setNameXOffset

getNameYOffset

setNameYOffset

getNameStyle

setNameStyle

getNameAngle

setNameAngle

getDescription

setDescription

getInformation

setInformation

getCreator

setCreator

getLicense

setLicense

getDepth

setDepth

getDepthInPlan

setDepthInPlan

getHeight

setHeight

getHeightInPlan

setHeightInPlan

getWidth

setWidth

getWidthInPlan

setWidthInPlan

scale

getElevation

getDropOnTopElevation

getGroundElevation

setElevation

isMovable

setMovable

isDoorOrWindow

getIcon

setIcon

getPlanIcon

setPlanIcon

getModel

setModel

getModelSize

setModelSize

getModelMaterials

setModelMaterials

getColor

setColor

getTexture

setTexture

getShininess

setShininess

isResizable

isDeformable

isWidthDepthDeformable

isTexturable

isHorizontallyRotatable