Sweet Home 3D 4.1

com.eteks.sweethome3d.io
Enum DefaultFurnitureCatalog.PropertyKey

java.lang.Object
  extended by java.lang.Enum<DefaultFurnitureCatalog.PropertyKey>
      extended by com.eteks.sweethome3d.io.DefaultFurnitureCatalog.PropertyKey
All Implemented Interfaces:
Serializable, Comparable<DefaultFurnitureCatalog.PropertyKey>
Enclosing class:
DefaultFurnitureCatalog

public static enum DefaultFurnitureCatalog.PropertyKey
extends Enum<DefaultFurnitureCatalog.PropertyKey>

The keys of the properties values read in .properties files.


Enum Constant Summary
CATEGORY
          The key for the category's name of a piece of furniture (mandatory).
CREATION_DATE
          The key for the creation 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_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_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).
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).
ICON
          The key for the icon file of a piece of furniture (mandatory).
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).
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 color(s) of light sources in 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_ROTATION
          The key for the transformation matrix values applied to 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).
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).
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 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
 String getKey(int pieceIndex)
          Returns the key for the piece property of the given index.
static DefaultFurnitureCatalog.PropertyKey valueOf(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.


TAGS

public static final DefaultFurnitureCatalog.PropertyKey TAGS
The key for the tags 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 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.


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.


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.


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_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_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 color(s) of light sources in 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).


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.


CREATOR

public static final DefaultFurnitureCatalog.PropertyKey CREATOR
The key for the creator of a piece of furniture (optional). By default, creator is eTeks.


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.


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(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getKey

public String getKey(int pieceIndex)
Returns the key for the piece property of the given index.


Sweet Home 3D 4.1

© Copyrights 2006-2013 eTeks - All rights reserved
Distributed under GNU General Public License