PieceOfFurniture (Sweet Home 3D 7.5 API)

All Known Subinterfaces:

DoorOrWindow, Light, ShelfUnit

All Known Implementing Classes:

CatalogDoorOrWindow, CatalogLight, CatalogPieceOfFurniture, CatalogShelfUnit, HomeDoorOrWindow, HomeFurnitureGroup, HomeLight, HomePieceOfFurniture, HomeShelfUnit
```
public interface PieceOfFurniture
```
A piece of furniture.

Author:

Emmanuel Puybaret

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_CUT_OUT_SHAPE` The default cut out shape that covers a 1 unit wide square.
`static int`	`HIDE_EDGE_COLOR_MATERIAL` The flag used to specify that the shapes of a 3D model which uses a material prefixed by "edge_color" should be hidden.
`static float[][]`	`IDENTITY_ROTATION` Identity model rotation matrix.
`static int`	`SHOW_BACK_FACE` The flag used to specify that the back faces of a 3D model should be shown.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.Integer`	`getColor()` Returns the color of this piece of furniture.
`Content`	`getContentProperty(java.lang.String name)` Returns the value of an additional content `name` associated to this piece.
`java.lang.String`	`getCreator()` Returns the creator of this piece or `null`.
`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.
`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 this piece of furniture.
`float`	`getHeight()` Returns the height of this piece of furniture.
`Content`	`getIcon()` Returns the icon of this piece of furniture.
`java.lang.String`	`getInformation()` Returns the additional information associated to this piece, or `null`.
`java.lang.String`	`getLicense()` Returns the license of this piece of furniture.
`Content`	`getModel()` Returns the 3D model of this piece of furniture.
`int`	`getModelFlags()` Returns flags that should apply on the 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 or `null` if not known.
`java.lang.String`	`getName()` Returns the name of this piece of furniture.
`Content`	`getPlanIcon()` Returns the icon of this piece of furniture displayed in plan or `null`.
`java.math.BigDecimal`	`getPrice()` Returns the price of this piece of furniture or `null`.
`java.lang.String`	`getProperty(java.lang.String name)` Returns the value of an additional property `name` of this piece.
`java.util.Collection<java.lang.String>`	`getPropertyNames()` Returns the names of the additional properties of this piece.
`java.lang.String`	`getStaircaseCutOutShape()` Returns the shape used to cut out upper levels when they intersect with the piece like a staircase.
`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.
`boolean`	`isBackFaceShown()` Returns `true` if the back face of the piece of furniture model should be displayed.
`boolean`	`isContentProperty(java.lang.String name)` Returns `true` if the type of given additional property is a content.
`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`	`isMovable()` Returns `true` if this piece of furniture is movable.
`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`	`isWidthDepthDeformable()` Returns `true` if the width and depth of this piece may be changed independently from each other.

- Field Detail
  - DEFAULT_CUT_OUT_SHAPE
```
static final java.lang.String DEFAULT_CUT_OUT_SHAPE
```
    The default cut out shape that covers a 1 unit wide square.
    
    See Also:
    
    Constant Field Values
  - IDENTITY_ROTATION
```
static final float[][] IDENTITY_ROTATION
```
    Identity model rotation matrix.
  - SHOW_BACK_FACE
```
static final int SHOW_BACK_FACE
```
    The flag used to specify that the back faces of a 3D model should be shown.
    
    See Also:
    
    Constant Field Values
  - HIDE_EDGE_COLOR_MATERIAL
```
static final int HIDE_EDGE_COLOR_MATERIAL
```
    The flag used to specify that the shapes of a 3D model which uses a material prefixed by "edge_color" should be hidden.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns the name of this piece of furniture.
  - getDescription
```
java.lang.String getDescription()
```
    Returns the description of this piece of furniture.
  - getInformation
```
java.lang.String getInformation()
```
    Returns the additional information associated to this piece, or null.
    
    Since:
    
    4.2
  - getLicense
```
java.lang.String getLicense()
```
    Returns the license of this piece of furniture.
    
    Since:
    
    7.2
  - getDepth
```
float getDepth()
```
    Returns the depth of this piece of furniture.
  - getHeight
```
float getHeight()
```
    Returns the height of this piece of furniture.
  - getWidth
```
float getWidth()
```
    Returns the width of this piece of furniture.
  - getElevation
```
float getElevation()
```
    Returns the elevation of this piece of furniture.
  - getDropOnTopElevation
```
float getDropOnTopElevation()
```
    Returns the elevation at which should be placed an object dropped on this piece.
    
    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
  - isMovable
```
boolean isMovable()
```
    Returns true if this piece of furniture is movable.
  - isDoorOrWindow
```
boolean isDoorOrWindow()
```
    Returns true if this piece of furniture is a door or a window. As this method existed before DoorOrWindow interface, you shouldn't rely on the value returned by this method to guess if a piece is an instance of DoorOrWindow class.
  - getIcon
```
Content getIcon()
```
    Returns the icon of this piece of furniture.
  - getPlanIcon
```
Content getPlanIcon()
```
    Returns the icon of this piece of furniture displayed in plan or null.
    
    Since:
    
    2.2
  - getModel
```
Content getModel()
```
    Returns the 3D model of this piece of furniture.
  - getModelFlags
```
int getModelFlags()
```
    Returns flags that should apply on the model of this piece of furniture.
    
    Since:
    
    7.0
  - getModelSize
```
java.lang.Long getModelSize()
```
    Returns the size of the 3D model of this piece of furniture or null if not known.
    
    Since:
    
    5.5
  - getModelRotation
```
float[][] getModelRotation()
```
    Returns the rotation 3 by 3 matrix of this piece of furniture that ensures its model is correctly oriented.
  - getStaircaseCutOutShape
```
java.lang.String getStaircaseCutOutShape()
```
    Returns the shape used to cut out upper levels when they intersect with the piece like a staircase.
    
    Since:
    
    3.4
  - getCreator
```
java.lang.String getCreator()
```
    Returns the creator of this piece or null.
    
    Since:
    
    4.2
  - isBackFaceShown
```
boolean isBackFaceShown()
```
    Returns true if the back face of the piece of furniture model should be displayed.
  - getColor
```
java.lang.Integer getColor()
```
    Returns the color of this piece of furniture.
  - isResizable
```
boolean isResizable()
```
    Returns true if this piece is resizable.
  - isDeformable
```
boolean isDeformable()
```
    Returns true if this piece is deformable. The width, depth and height of a deformable piece may change independently from each other.
    
    Since:
    
    3.0
  - isWidthDepthDeformable
```
boolean isWidthDepthDeformable()
```
    Returns true if the width and depth of this piece may be changed independently from each other.
    
    Since:
    
    5.5
  - isTexturable
```
boolean isTexturable()
```
    Returns false if this piece should always keep the same color or texture.
    
    Since:
    
    3.0
  - isHorizontallyRotatable
```
boolean isHorizontallyRotatable()
```
    Returns false if this piece should not rotate around an horizontal axis.
    
    Since:
    
    5.5
  - getPrice
```
java.math.BigDecimal getPrice()
```
    Returns the price of this piece of furniture or null.
  - getValueAddedTaxPercentage
```
java.math.BigDecimal getValueAddedTaxPercentage()
```
    Returns the Value Added Tax percentage applied to the price of this piece of furniture.
  - getCurrency
```
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.
    
    Since:
    
    3.4
  - getProperty
```
java.lang.String getProperty(java.lang.String name)
```
    Returns the value of an additional property name of this piece.
    
    Returns:
    
    the value of the property or null if it doesn't exist or if it's not a string.
    
    Since:
    
    7.2
  - getPropertyNames
```
java.util.Collection<java.lang.String> getPropertyNames()
```
    Returns the names of the additional properties of this piece.
    
    Returns:
    
    a collection of all the names of the properties
    
    Since:
    
    7.2
  - getContentProperty
```
Content getContentProperty(java.lang.String name)
```
    Returns the value of an additional content name associated to this piece.
    
    Returns:
    
    the value of the content or null if it doesn't exist or if it's not a content.
    
    Since:
    
    7.2
  - isContentProperty
```
boolean isContentProperty(java.lang.String name)
```
    Returns true if the type of given additional property is a content.
    
    Since:
    
    7.2

Interface PieceOfFurniture

Field Summary

Method Summary

Field Detail

DEFAULT_CUT_OUT_SHAPE

IDENTITY_ROTATION

SHOW_BACK_FACE

HIDE_EDGE_COLOR_MATERIAL

Method Detail

getName

getDescription

getInformation

getLicense

getDepth

getHeight

getWidth

getElevation

getDropOnTopElevation

isMovable

isDoorOrWindow

getIcon

getPlanIcon

getModel

getModelFlags

getModelSize

getModelRotation

getStaircaseCutOutShape

getCreator

isBackFaceShown

getColor

isResizable

isDeformable

isWidthDepthDeformable

isTexturable

isHorizontallyRotatable

getPrice

getValueAddedTaxPercentage

getCurrency

getProperty

getPropertyNames

getContentProperty

isContentProperty