DefaultFurnitureCatalog.PropertyKey (Sweet Home 3D 7.5 API)

java.lang.Object
- java.lang.Enum<DefaultFurnitureCatalog.PropertyKey>
- - com.eteks.sweethome3d.io.DefaultFurnitureCatalog.PropertyKey

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DefaultFurnitureCatalog.PropertyKey>

Enclosing class:

DefaultFurnitureCatalog
```
public static enum DefaultFurnitureCatalog.PropertyKey
extends java.lang.Enum<DefaultFurnitureCatalog.PropertyKey>
```
The keys of the properties values read in .properties files.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CATEGORY` The key for the category's name of a piece of furniture (mandatory).
`CREATION_DATE` The key for the creation or publication date of a piece of furniture at `yyyy-MM-dd` format (optional).
`CREATOR` The key for the creator of a piece of furniture (optional).
`CURRENCY` The key for the currency ISO 4217 code of the price of a piece of furniture (optional).
`DEFORMABLE` The key for the deformability of a piece of furniture (optional, `true` by default).
`DEPTH` The key for the depth in centimeters of a piece of furniture (mandatory).
`DESCRIPTION` The key for the description of a piece of furniture (optional).
`DOOR_OR_WINDOW` The key for the door or window type of a piece of furniture (mandatory).
`DOOR_OR_WINDOW_CUT_OUT_SHAPE` The key for the shape of a door or window used to cut out walls when they intersect it (optional).
`DOOR_OR_WINDOW_SASH_END_ANGLE` The key for the sash end angle(s) of a door or a window (mandatory if sash axis distance along X axis is defined).
`DOOR_OR_WINDOW_SASH_START_ANGLE` The key for the sash start angle(s) of a door or a window (mandatory if sash axis distance along X axis is defined).
`DOOR_OR_WINDOW_SASH_WIDTH` The key for the sash width(s) of a door or a window (mandatory if sash axis distance along X axis is defined).
`DOOR_OR_WINDOW_SASH_X_AXIS` The key for the sash axis distance(s) of a door or a window along X axis (optional).
`DOOR_OR_WINDOW_SASH_Y_AXIS` The key for the sash axis distance(s) of a door or a window along Y axis (mandatory if sash axis distance along X axis is defined).
`DOOR_OR_WINDOW_WALL_CUT_OUT_ON_BOTH_SIDES` The key for the wall cut out rule of a door or a window (optional, `true` by default).
`DOOR_OR_WINDOW_WALL_DISTANCE` The key for the distance in centimeters of a door or a window to its wall (optional).
`DOOR_OR_WINDOW_WALL_THICKNESS` The key for the wall thickness in centimeters of a door or a window (optional).
`DOOR_OR_WINDOW_WIDTH_DEPTH_DEFORMABLE` The key for the width/depth deformability of a door or a window (optional, `true` by default).
`DROP_ON_TOP_ELEVATION` The key for the preferred elevation (from the bottom of a piece) at which should be placed an object dropped on a piece (optional).
`ELEVATION` The key for the elevation in centimeters of a piece of furniture (optional).
`GRADE` The key for the grade of a piece of furniture (optional).
`HEIGHT` The key for the height in centimeters of a piece of furniture (mandatory).
`HORIZONTALLY_ROTATABLE` The key for the ability of a piece of furniture to rotate around a horizontal axis (optional, `true` by default).
`ICON` The key for the icon file of a piece of furniture (mandatory).
`ICON_DIGEST` The key for the SHA-1 digest of the icon file of a piece of furniture (optional).
`ID` The key for the ID of a piece of furniture (optional).
`INFORMATION` The key for some additional information associated to a piece of furniture (optional).
`LICENSE` The key for the license associated to a piece of furniture (optional).
`LIGHT_SOURCE_COLOR` The key for the color(s) of light sources in a light (mandatory if light source abscissa is defined).
`LIGHT_SOURCE_DIAMETER` The key for the diameter(s) of light sources in a light (optional).
`LIGHT_SOURCE_MATERIAL_NAME` The key for the material name(s) of light source shapes in the 3D model of a light (optional).
`LIGHT_SOURCE_X` The key for the abscissa(s) of light sources in a light (optional).
`LIGHT_SOURCE_Y` The key for the ordinate(s) of light sources in a light (mandatory if light source abscissa is defined).
`LIGHT_SOURCE_Z` The key for the elevation(s) of light sources in a light (mandatory if light source abscissa is defined).
`MODEL` The key for the 3D model file of a piece of furniture (mandatory).
`MODEL_DIGEST` The key for the SHA-1 digest of the 3D model file of a piece of furniture (optional).
`MODEL_FLAGS` The key for the model flags applied to a piece of furniture (optional).
`MODEL_ROTATION` The key for the transformation matrix values applied to a piece of furniture (optional).
`MODEL_SIZE` The key for the size of the 3D model of a piece of furniture (optional).
`MOVABLE` The key for the movability of a piece of furniture (mandatory).
`MULTI_PART_MODEL` The key for a piece of furniture with multiple parts (optional).
`NAME` The key for the name of a piece of furniture (mandatory).
`PLAN_ICON` The key for the plan icon file of a piece of furniture (optional).
`PLAN_ICON_DIGEST` The key for the SHA-1 digest of the plan icon file of a piece of furniture (optional).
`PRICE` The key for the price of a piece of furniture (optional).
`RESIZABLE` The key for the resizability of a piece of furniture (optional, `true` by default).
`SHELF_BOXES` The key for the shelf box(es) in which other objects can be placed in a piece of furniture (optional).
`SHELF_ELEVATIONS` The key for the shelf elevation(s) at which other objects can be placed on a piece of furniture from its bottom (optional).
`STAIRCASE_CUT_OUT_SHAPE` The key for the shape used to cut out upper levels when they intersect with a piece like a staircase (optional).
`TAGS` The key for the tags or keywords associated to a piece of furniture (optional).
`TEXTURABLE` The key for the texturable capability of a piece of furniture (optional, `true` by default).
`VALUE_ADDED_TAX_PERCENTAGE` The key for the VAT percentage of a piece of furniture (optional).
`WIDTH` The key for the width in centimeters of a piece of furniture (mandatory).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DefaultFurnitureCatalog.PropertyKey`	`fromPrefix(java.lang.String keyPrefix)` Returns the `PropertyKey` instance matching the given key prefix.
`java.lang.String`	`getKey(int pieceIndex)` Returns the key for the piece property of the given index.
`java.lang.String`	`getKeyPrefix()` Returns the key prefix for the piece property.
`static DefaultFurnitureCatalog.PropertyKey`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static DefaultFurnitureCatalog.PropertyKey[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ID
```
public static final DefaultFurnitureCatalog.PropertyKey ID
```
    The key for the ID of a piece of furniture (optional). Two pieces of furniture read in a furniture catalog can't have the same ID and the second one will be ignored.
  - NAME
```
public static final DefaultFurnitureCatalog.PropertyKey NAME
```
    The key for the name of a piece of furniture (mandatory).
  - DESCRIPTION
```
public static final DefaultFurnitureCatalog.PropertyKey DESCRIPTION
```
    The key for the description of a piece of furniture (optional). This may give detailed information about a piece of furniture.
  - INFORMATION
```
public static final DefaultFurnitureCatalog.PropertyKey INFORMATION
```
    The key for some additional information associated to a piece of furniture (optional). This information may contain some HTML code or a link to an external web site.
  - LICENSE
```
public static final DefaultFurnitureCatalog.PropertyKey LICENSE
```
    The key for the license associated to a piece of furniture (optional).
  - TAGS
```
public static final DefaultFurnitureCatalog.PropertyKey TAGS
```
    The key for the tags or keywords associated to a piece of furniture (optional). Tags are separated by commas with possible heading or trailing spaces.
  - CREATION_DATE
```
public static final DefaultFurnitureCatalog.PropertyKey CREATION_DATE
```
    The key for the creation or publication date of a piece of furniture at yyyy-MM-dd format (optional).
  - GRADE
```
public static final DefaultFurnitureCatalog.PropertyKey GRADE
```
    The key for the grade of a piece of furniture (optional).
  - CATEGORY
```
public static final DefaultFurnitureCatalog.PropertyKey CATEGORY
```
    The key for the category's name of a piece of furniture (mandatory). A new category with this name will be created if it doesn't exist.
  - ICON
```
public static final DefaultFurnitureCatalog.PropertyKey ICON
```
    The key for the icon file of a piece of furniture (mandatory). This icon file can be either the path to an image relative to classpath or an absolute URL. It should be encoded in application/x-www-form-urlencoded format if needed.
  - ICON_DIGEST
```
public static final DefaultFurnitureCatalog.PropertyKey ICON_DIGEST
```
    The key for the SHA-1 digest of the icon file of a piece of furniture (optional). This property is used to compare faster catalog resources with the ones of a read home, and should be encoded in Base64.
  - PLAN_ICON
```
public static final DefaultFurnitureCatalog.PropertyKey PLAN_ICON
```
    The key for the plan icon file of a piece of furniture (optional). This icon file can be either the path to an image relative to classpath or an absolute URL. It should be encoded in application/x-www-form-urlencoded format if needed.
  - PLAN_ICON_DIGEST
```
public static final DefaultFurnitureCatalog.PropertyKey PLAN_ICON_DIGEST
```
    The key for the SHA-1 digest of the plan icon file of a piece of furniture (optional). This property is used to compare faster catalog resources with the ones of a read home, and should be encoded in Base64.
  - MODEL
```
public static final DefaultFurnitureCatalog.PropertyKey MODEL
```
    The key for the 3D model file of a piece of furniture (mandatory). The 3D model file can be either a path relative to classpath or an absolute URL. It should be encoded in application/x-www-form-urlencoded format if needed.
  - MODEL_SIZE
```
public static final DefaultFurnitureCatalog.PropertyKey MODEL_SIZE
```
    The key for the size of the 3D model of a piece of furniture (optional). If model content is a file this should contain the file size.
  - MODEL_DIGEST
```
public static final DefaultFurnitureCatalog.PropertyKey MODEL_DIGEST
```
    The key for the SHA-1 digest of the 3D model file of a piece of furniture (optional). This property is used to compare faster catalog resources with the ones of a read home, and should be encoded in Base64.
  - MULTI_PART_MODEL
```
public static final DefaultFurnitureCatalog.PropertyKey MULTI_PART_MODEL
```
    The key for a piece of furniture with multiple parts (optional). If the value of this key is true, all the files stored in the same folder as the 3D model file (MTL, texture files...) will be considered as being necessary to view correctly the 3D model.
  - WIDTH
```
public static final DefaultFurnitureCatalog.PropertyKey WIDTH
```
    The key for the width in centimeters of a piece of furniture (mandatory).
  - DEPTH
```
public static final DefaultFurnitureCatalog.PropertyKey DEPTH
```
    The key for the depth in centimeters of a piece of furniture (mandatory).
  - HEIGHT
```
public static final DefaultFurnitureCatalog.PropertyKey HEIGHT
```
    The key for the height in centimeters of a piece of furniture (mandatory).
  - MOVABLE
```
public static final DefaultFurnitureCatalog.PropertyKey MOVABLE
```
    The key for the movability of a piece of furniture (mandatory). If the value of this key is true, the piece of furniture will be considered as a movable piece.
  - DOOR_OR_WINDOW
```
public static final DefaultFurnitureCatalog.PropertyKey DOOR_OR_WINDOW
```
    The key for the door or window type of a piece of furniture (mandatory). If the value of this key is true, the piece of furniture will be considered as a door or a window.
  - DOOR_OR_WINDOW_CUT_OUT_SHAPE
```
public static final DefaultFurnitureCatalog.PropertyKey DOOR_OR_WINDOW_CUT_OUT_SHAPE
```
    The key for the shape of a door or window used to cut out walls when they intersect it (optional). This shape should be defined with the syntax of the d attribute of a SVG path element and should fit in a square spreading from (0, 0) to (1, 1) which will be scaled afterwards to the real size of the piece. If not specified, then this shape will be automatically computed from the actual shape of the model.
  - DOOR_OR_WINDOW_WALL_THICKNESS
```
public static final DefaultFurnitureCatalog.PropertyKey DOOR_OR_WINDOW_WALL_THICKNESS
```
    The key for the wall thickness in centimeters of a door or a window (optional). By default, a door or a window has the same depth as the wall it belongs to.
  - DOOR_OR_WINDOW_WALL_DISTANCE
```
public static final DefaultFurnitureCatalog.PropertyKey DOOR_OR_WINDOW_WALL_DISTANCE
```
    The key for the distance in centimeters of a door or a window to its wall (optional). By default, this distance is zero.
  - DOOR_OR_WINDOW_WALL_CUT_OUT_ON_BOTH_SIDES
```
public static final DefaultFurnitureCatalog.PropertyKey DOOR_OR_WINDOW_WALL_CUT_OUT_ON_BOTH_SIDES
```
    The key for the wall cut out rule of a door or a window (optional, true by default). By default, a door or a window placed on a wall and parallel to it will cut out the both sides of that wall even if its depth is smaller than the wall thickness or if it intersects only one side of the wall. If the value of this key is false, a door or a window will only dig the wall at its intersection, and will cut the both sides of a wall only if it intersects both of them.
  - DOOR_OR_WINDOW_WIDTH_DEPTH_DEFORMABLE
```
public static final DefaultFurnitureCatalog.PropertyKey DOOR_OR_WINDOW_WIDTH_DEPTH_DEFORMABLE
```
    The key for the width/depth deformability of a door or a window (optional, true by default). By default, the depth of a door or a window can be changed and adapted to the wall thickness where it's placed regardless of its width. To avoid this deformation in the case of open doors, the value of this key can be set to false. Doors and windows with their width/depth deformability set to false and their bouldToWall flag set to true will also make a hole in the wall when they are placed whatever their depth.
  - DOOR_OR_WINDOW_SASH_X_AXIS
```
public static final DefaultFurnitureCatalog.PropertyKey DOOR_OR_WINDOW_SASH_X_AXIS
```
    The key for the sash axis distance(s) of a door or a window along X axis (optional). If a door or a window has more than one sash, the values of each sash should be separated by spaces.
  - DOOR_OR_WINDOW_SASH_Y_AXIS
```
public static final DefaultFurnitureCatalog.PropertyKey DOOR_OR_WINDOW_SASH_Y_AXIS
```
    The key for the sash axis distance(s) of a door or a window along Y axis (mandatory if sash axis distance along X axis is defined).
  - DOOR_OR_WINDOW_SASH_WIDTH
```
public static final DefaultFurnitureCatalog.PropertyKey DOOR_OR_WINDOW_SASH_WIDTH
```
    The key for the sash width(s) of a door or a window (mandatory if sash axis distance along X axis is defined).
  - DOOR_OR_WINDOW_SASH_START_ANGLE
```
public static final DefaultFurnitureCatalog.PropertyKey DOOR_OR_WINDOW_SASH_START_ANGLE
```
    The key for the sash start angle(s) of a door or a window (mandatory if sash axis distance along X axis is defined).
  - DOOR_OR_WINDOW_SASH_END_ANGLE
```
public static final DefaultFurnitureCatalog.PropertyKey DOOR_OR_WINDOW_SASH_END_ANGLE
```
    The key for the sash end angle(s) of a door or a window (mandatory if sash axis distance along X axis is defined).
  - LIGHT_SOURCE_X
```
public static final DefaultFurnitureCatalog.PropertyKey LIGHT_SOURCE_X
```
    The key for the abscissa(s) of light sources in a light (optional). If a light has more than one light source, the values of each light source should be separated by spaces.
  - LIGHT_SOURCE_Y
```
public static final DefaultFurnitureCatalog.PropertyKey LIGHT_SOURCE_Y
```
    The key for the ordinate(s) of light sources in a light (mandatory if light source abscissa is defined).
  - LIGHT_SOURCE_Z
```
public static final DefaultFurnitureCatalog.PropertyKey LIGHT_SOURCE_Z
```
    The key for the elevation(s) of light sources in a light (mandatory if light source abscissa is defined).
  - LIGHT_SOURCE_COLOR
```
public static final DefaultFurnitureCatalog.PropertyKey LIGHT_SOURCE_COLOR
```
    The key for the color(s) of light sources in a light (mandatory if light source abscissa is defined).
  - LIGHT_SOURCE_DIAMETER
```
public static final DefaultFurnitureCatalog.PropertyKey LIGHT_SOURCE_DIAMETER
```
    The key for the diameter(s) of light sources in a light (optional).
  - LIGHT_SOURCE_MATERIAL_NAME
```
public static final DefaultFurnitureCatalog.PropertyKey LIGHT_SOURCE_MATERIAL_NAME
```
    The key for the material name(s) of light source shapes in the 3D model of a light (optional).
  - STAIRCASE_CUT_OUT_SHAPE
```
public static final DefaultFurnitureCatalog.PropertyKey STAIRCASE_CUT_OUT_SHAPE
```
    The key for the shape used to cut out upper levels when they intersect with a piece like a staircase (optional). This shape should be defined with the syntax of the d attribute of a SVG path element and should fit in a square spreading from (0, 0) to (1, 1) which will be scaled afterwards to the real size of the piece.
  - ELEVATION
```
public static final DefaultFurnitureCatalog.PropertyKey ELEVATION
```
    The key for the elevation in centimeters of a piece of furniture (optional).
  - DROP_ON_TOP_ELEVATION
```
public static final DefaultFurnitureCatalog.PropertyKey DROP_ON_TOP_ELEVATION
```
    The key for the preferred elevation (from the bottom of a piece) at which should be placed an object dropped on a piece (optional). A negative value means that the piece should be ignored when an object is dropped on it. By default, this elevation is equal to its height.
  - SHELF_ELEVATIONS
```
public static final DefaultFurnitureCatalog.PropertyKey SHELF_ELEVATIONS
```
    The key for the shelf elevation(s) at which other objects can be placed on a piece of furniture from its bottom (optional).
  - SHELF_BOXES
```
public static final DefaultFurnitureCatalog.PropertyKey SHELF_BOXES
```
    The key for the shelf box(es) in which other objects can be placed in a piece of furniture (optional). Each box is defined by the 6 values of the x, y, z coordinates of its left front bottom corner and its right back top corner.
  - MODEL_ROTATION
```
public static final DefaultFurnitureCatalog.PropertyKey MODEL_ROTATION
```
    The key for the transformation matrix values applied to a piece of furniture (optional). If the 3D model of a piece of furniture isn't correctly oriented, the value of this key should give the 9 values of the transformation matrix that will orient it correctly.
  - MODEL_FLAGS
```
public static final DefaultFurnitureCatalog.PropertyKey MODEL_FLAGS
```
    The key for the model flags applied to a piece of furniture (optional). May be a combination of PieceOfFurniture.SHOW_BACK_FACE and PieceOfFurniture.HIDE_EDGE_COLOR_MATERIAL flags.
  - CREATOR
```
public static final DefaultFurnitureCatalog.PropertyKey CREATOR
```
    The key for the creator of a piece of furniture (optional).
  - RESIZABLE
```
public static final DefaultFurnitureCatalog.PropertyKey RESIZABLE
```
    The key for the resizability of a piece of furniture (optional, true by default). If the value of this key is false, the piece of furniture will be considered as a piece with a fixed size.
  - DEFORMABLE
```
public static final DefaultFurnitureCatalog.PropertyKey DEFORMABLE
```
    The key for the deformability of a piece of furniture (optional, true by default). If the value of this key is false, the piece of furniture will be considered as a piece that should always keep its proportions when resized.
  - TEXTURABLE
```
public static final DefaultFurnitureCatalog.PropertyKey TEXTURABLE
```
    The key for the texturable capability of a piece of furniture (optional, true by default). If the value of this key is false, the piece of furniture will be considered as a piece that will always keep the same color or texture.
  - HORIZONTALLY_ROTATABLE
```
public static final DefaultFurnitureCatalog.PropertyKey HORIZONTALLY_ROTATABLE
```
    The key for the ability of a piece of furniture to rotate around a horizontal axis (optional, true by default). If the value of this key is false, the piece of furniture will be considered as a piece that can't be horizontally rotated.
  - PRICE
```
public static final DefaultFurnitureCatalog.PropertyKey PRICE
```
    The key for the price of a piece of furniture (optional).
  - VALUE_ADDED_TAX_PERCENTAGE
```
public static final DefaultFurnitureCatalog.PropertyKey VALUE_ADDED_TAX_PERCENTAGE
```
    The key for the VAT percentage of a piece of furniture (optional).
  - CURRENCY
```
public static final DefaultFurnitureCatalog.PropertyKey CURRENCY
```
    The key for the currency ISO 4217 code of the price of a piece of furniture (optional).
- Method Detail
  - values
```
public static DefaultFurnitureCatalog.PropertyKey[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (DefaultFurnitureCatalog.PropertyKey c : DefaultFurnitureCatalog.PropertyKey.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DefaultFurnitureCatalog.PropertyKey valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getKeyPrefix
```
public java.lang.String getKeyPrefix()
```
    Returns the key prefix for the piece property.
  - getKey
```
public java.lang.String getKey(int pieceIndex)
```
    Returns the key for the piece property of the given index.
  - fromPrefix
```
public static DefaultFurnitureCatalog.PropertyKey fromPrefix(java.lang.String keyPrefix)
```
    Returns the PropertyKey instance matching the given key prefix.

Enum DefaultFurnitureCatalog.PropertyKey

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ID

NAME

DESCRIPTION

INFORMATION

LICENSE

TAGS

CREATION_DATE

GRADE

CATEGORY

ICON

ICON_DIGEST

PLAN_ICON

PLAN_ICON_DIGEST

MODEL

MODEL_SIZE

MODEL_DIGEST

MULTI_PART_MODEL

WIDTH

DEPTH

HEIGHT

MOVABLE

DOOR_OR_WINDOW

DOOR_OR_WINDOW_CUT_OUT_SHAPE

DOOR_OR_WINDOW_WALL_THICKNESS

DOOR_OR_WINDOW_WALL_DISTANCE

DOOR_OR_WINDOW_WALL_CUT_OUT_ON_BOTH_SIDES

DOOR_OR_WINDOW_WIDTH_DEPTH_DEFORMABLE

DOOR_OR_WINDOW_SASH_X_AXIS

DOOR_OR_WINDOW_SASH_Y_AXIS

DOOR_OR_WINDOW_SASH_WIDTH

DOOR_OR_WINDOW_SASH_START_ANGLE

DOOR_OR_WINDOW_SASH_END_ANGLE

LIGHT_SOURCE_X

LIGHT_SOURCE_Y

LIGHT_SOURCE_Z

LIGHT_SOURCE_COLOR

LIGHT_SOURCE_DIAMETER

LIGHT_SOURCE_MATERIAL_NAME

STAIRCASE_CUT_OUT_SHAPE

ELEVATION

DROP_ON_TOP_ELEVATION

SHELF_ELEVATIONS

SHELF_BOXES

MODEL_ROTATION

MODEL_FLAGS

CREATOR

RESIZABLE

DEFORMABLE

TEXTURABLE

HORIZONTALLY_ROTATABLE

PRICE

VALUE_ADDED_TAX_PERCENTAGE

CURRENCY

Method Detail

values

valueOf

getKeyPrefix

getKey

fromPrefix