com.eteks.sweethome3d.model

Class CatalogDoorOrWindow

java.lang.Object

com.eteks.sweethome3d.model.CatalogPieceOfFurniture

com.eteks.sweethome3d.model.CatalogDoorOrWindow

All Implemented Interfaces:

DoorOrWindow, PieceOfFurniture, java.lang.Comparable<CatalogPieceOfFurniture>

public class CatalogDoorOrWindow
extends CatalogPieceOfFurniture
implements DoorOrWindow

A door or a window of the catalog.

Since:

1.7

Author:

Emmanuel Puybaret

Constructor Summary

Constructors

Constructor and Description
CatalogDoorOrWindow(java.lang.String name, Content icon, Content model, float width, float depth, float height, float elevation, boolean movable, float wallThickness, float wallDistance, Sash[] sashes, java.lang.Integer color, float[][] modelRotation, boolean backFaceShown, float iconYaw, boolean proportional) Creates a modifiable catalog door or window with all its values.
CatalogDoorOrWindow(java.lang.String id, java.lang.String name, java.lang.String description, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, boolean movable, float wallThickness, float wallDistance, Sash[] sashes, float[][] modelRotation, java.lang.String creator, boolean resizable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage) Creates an unmodifiable catalog door or window of the default catalog.
CatalogDoorOrWindow(java.lang.String id, java.lang.String name, java.lang.String description, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, boolean movable, float wallThickness, float wallDistance, Sash[] sashes, float[][] modelRotation, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage) Creates an unmodifiable catalog door or window of the default catalog.
CatalogDoorOrWindow(java.lang.String id, java.lang.String name, java.lang.String description, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, boolean movable, float wallThickness, float wallDistance, Sash[] sashes, float[][] modelRotation, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage, java.lang.String currency) Creates an unmodifiable catalog door or window of the default catalog.
CatalogDoorOrWindow(java.lang.String id, java.lang.String name, java.lang.String description, Content icon, Content model, float width, float depth, float height, float elevation, boolean movable, float wallThickness, float wallDistance, Sash[] sashes, float[][] modelRotation, java.lang.String creator, boolean resizable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage) Creates an unmodifiable catalog door or window of the default catalog.
CatalogDoorOrWindow(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.String information, java.lang.String[] tags, java.lang.Long creationDate, java.lang.Float grade, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, boolean movable, float wallThickness, float wallDistance, Sash[] sashes, float[][] modelRotation, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage, java.lang.String currency) Creates an unmodifiable catalog door or window of the default catalog.
CatalogDoorOrWindow(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.String information, java.lang.String[] tags, java.lang.Long creationDate, java.lang.Float grade, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, boolean movable, java.lang.String cutOutShape, float wallThickness, float wallDistance, Sash[] sashes, float[][] modelRotation, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage, java.lang.String currency) Creates an unmodifiable catalog door or window of the default catalog.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCutOutShape() Returns the shape used to cut out walls that intersect this new door or window.
Sash[]	getSashes() Returns a copy of the sashes attached to this door or window.
float	getWallDistance() Returns the default distance that should lie at the back side of this door or window.
float	getWallThickness() Returns the default thickness of the wall in which this door or window should be placed.
boolean	isDoorOrWindow() Returns always true.

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

compareTo, equals, getCategory, getColor, getCreationDate, getCreator, getCurrency, getDepth, getDescription, getElevation, getGrade, getHeight, getIcon, getIconYaw, getId, getInformation, getModel, getModelRotation, getName, getPlanIcon, getPrice, getStaircaseCutOutShape, getTags, getValueAddedTaxPercentage, getWidth, hashCode, isBackFaceShown, isDeformable, isModifiable, isMovable, isProportional, isResizable, isTexturable, matchesFilter

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

getColor, getCreator, getCurrency, getDepth, getDescription, getElevation, getHeight, getIcon, getInformation, getModel, getModelRotation, getName, getPlanIcon, getPrice, getStaircaseCutOutShape, getValueAddedTaxPercentage, getWidth, isBackFaceShown, isDeformable, isMovable, isResizable, isTexturable

Constructor Detail

CatalogDoorOrWindow

public CatalogDoorOrWindow(java.lang.String id,
                   java.lang.String name,
                   java.lang.String description,
                   Content icon,
                   Content model,
                   float width,
                   float depth,
                   float height,
                   float elevation,
                   boolean movable,
                   float wallThickness,
                   float wallDistance,
                   Sash[] sashes,
                   float[][] modelRotation,
                   java.lang.String creator,
                   boolean resizable,
                   java.math.BigDecimal price,
                   java.math.BigDecimal valueAddedTaxPercentage)

Creates an unmodifiable catalog door or window of the default catalog.

Parameters:

id - the id of the new door or window, or null

name - the name of the new door or window

description - the description of the new door or window

icon - content of the icon of the new door or window

model - content of the 3D model of the new door or window

width - the width in centimeters of the new door or window

depth - the depth in centimeters of the new door or window

height - the height in centimeters of the new door or window

elevation - the elevation in centimeters of the new door or window

movable - if true, the new door or window is movable

wallThickness - a value in percentage of the depth of the new door or window

wallDistance - a distance in percentage of the depth of the new door or window

sashes - the sashes attached to the new door or window

modelRotation - the rotation 3 by 3 matrix applied to the door or window model

creator - the creator of the model

resizable - if true, the size of the new door or window may be edited

price - the price of the new door or window, or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new door or window or null

CatalogDoorOrWindow

public CatalogDoorOrWindow(java.lang.String id,
                   java.lang.String name,
                   java.lang.String description,
                   Content icon,
                   Content planIcon,
                   Content model,
                   float width,
                   float depth,
                   float height,
                   float elevation,
                   boolean movable,
                   float wallThickness,
                   float wallDistance,
                   Sash[] sashes,
                   float[][] modelRotation,
                   java.lang.String creator,
                   boolean resizable,
                   java.math.BigDecimal price,
                   java.math.BigDecimal valueAddedTaxPercentage)

Creates an unmodifiable catalog door or window of the default catalog.

Parameters:

id - the id of the new door or window, or null

name - the name of the new door or window

description - the description of the new door or window

icon - content of the icon of the new door or window

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new door or window

width - the width in centimeters of the new door or window

depth - the depth in centimeters of the new door or window

height - the height in centimeters of the new door or window

elevation - the elevation in centimeters of the new door or window

movable - if true, the new door or window is movable

wallThickness - a value in percentage of the depth of the new door or window

wallDistance - a distance in percentage of the depth of the new door or window

sashes - the sashes attached to the new door or window

modelRotation - the rotation 3 by 3 matrix applied to the door or window model

creator - the creator of the model

resizable - if true, the size of the new door or window may be edited

price - the price of the new door or window, or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new door or window or null

Since:

2.2

CatalogDoorOrWindow

public CatalogDoorOrWindow(java.lang.String id,
                   java.lang.String name,
                   java.lang.String description,
                   Content icon,
                   Content planIcon,
                   Content model,
                   float width,
                   float depth,
                   float height,
                   float elevation,
                   boolean movable,
                   float wallThickness,
                   float wallDistance,
                   Sash[] sashes,
                   float[][] modelRotation,
                   java.lang.String creator,
                   boolean resizable,
                   boolean deformable,
                   boolean texturable,
                   java.math.BigDecimal price,
                   java.math.BigDecimal valueAddedTaxPercentage)

Creates an unmodifiable catalog door or window of the default catalog.

Parameters:

id - the id of the new door or window, or null

name - the name of the new door or window

description - the description of the new door or window

icon - content of the icon of the new door or window

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new door or window

width - the width in centimeters of the new door or window

depth - the depth in centimeters of the new door or window

height - the height in centimeters of the new door or window

elevation - the elevation in centimeters of the new door or window

movable - if true, the new door or window is movable

wallThickness - a value in percentage of the depth of the new door or window

wallDistance - a distance in percentage of the depth of the new door or window

sashes - the sashes attached to the new door or window

modelRotation - the rotation 3 by 3 matrix applied to the door or window model

creator - the creator of the model

resizable - if true, the size of the new door or window may be edited

deformable - if true, the width, depth and height of the new piece may change independently from each other

texturable - if false this piece should always keep the same color or texture.

price - the price of the new door or window, or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new door or window or null

Since:

3.0

CatalogDoorOrWindow

public CatalogDoorOrWindow(java.lang.String id,
                   java.lang.String name,
                   java.lang.String description,
                   Content icon,
                   Content planIcon,
                   Content model,
                   float width,
                   float depth,
                   float height,
                   float elevation,
                   boolean movable,
                   float wallThickness,
                   float wallDistance,
                   Sash[] sashes,
                   float[][] modelRotation,
                   java.lang.String creator,
                   boolean resizable,
                   boolean deformable,
                   boolean texturable,
                   java.math.BigDecimal price,
                   java.math.BigDecimal valueAddedTaxPercentage,
                   java.lang.String currency)

Creates an unmodifiable catalog door or window of the default catalog.

Parameters:

id - the id of the new door or window, or null

name - the name of the new door or window

description - the description of the new door or window

icon - content of the icon of the new door or window

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new door or window

width - the width in centimeters of the new door or window

depth - the depth in centimeters of the new door or window

height - the height in centimeters of the new door or window

elevation - the elevation in centimeters of the new door or window

movable - if true, the new door or window is movable

wallThickness - a value in percentage of the depth of the new door or window

wallDistance - a distance in percentage of the depth of the new door or window

sashes - the sashes attached to the new door or window

modelRotation - the rotation 3 by 3 matrix applied to the door or window model

creator - the creator of the model

resizable - if true, the size of the new door or window may be edited

deformable - if true, the width, depth and height of the new piece may change independently from each other

texturable - if false this piece should always keep the same color or texture.

price - the price of the new door or window, or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new door or window or null

currency - the price currency, noted with ISO 4217 code, or null

Since:

3.4

CatalogDoorOrWindow

public CatalogDoorOrWindow(java.lang.String id,
                   java.lang.String name,
                   java.lang.String description,
                   java.lang.String information,
                   java.lang.String[] tags,
                   java.lang.Long creationDate,
                   java.lang.Float grade,
                   Content icon,
                   Content planIcon,
                   Content model,
                   float width,
                   float depth,
                   float height,
                   float elevation,
                   boolean movable,
                   float wallThickness,
                   float wallDistance,
                   Sash[] sashes,
                   float[][] modelRotation,
                   java.lang.String creator,
                   boolean resizable,
                   boolean deformable,
                   boolean texturable,
                   java.math.BigDecimal price,
                   java.math.BigDecimal valueAddedTaxPercentage,
                   java.lang.String currency)

Creates an unmodifiable catalog door or window of the default catalog.

Parameters:

id - the id of the new door or window, or null

name - the name of the new door or window

description - the description of the new door or window

information - additional information associated to the new door or window

tags - tags associated to the new door or window

creationDate - creation date of the new door or window in milliseconds since the epoch

grade - grade of the new door or window or null

icon - content of the icon of the new door or window

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new door or window

width - the width in centimeters of the new door or window

depth - the depth in centimeters of the new door or window

height - the height in centimeters of the new door or window

elevation - the elevation in centimeters of the new door or window

movable - if true, the new door or window is movable

wallThickness - a value in percentage of the depth of the new door or window

wallDistance - a distance in percentage of the depth of the new door or window

sashes - the sashes attached to the new door or window

modelRotation - the rotation 3 by 3 matrix applied to the door or window model

creator - the creator of the model

resizable - if true, the size of the new door or window may be edited

deformable - if true, the width, depth and height of the new piece may change independently from each other

texturable - if false this piece should always keep the same color or texture.

price - the price of the new door or window, or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new door or window or null

currency - the price currency, noted with ISO 4217 code, or null

Since:

3.6

CatalogDoorOrWindow

public CatalogDoorOrWindow(java.lang.String id,
                   java.lang.String name,
                   java.lang.String description,
                   java.lang.String information,
                   java.lang.String[] tags,
                   java.lang.Long creationDate,
                   java.lang.Float grade,
                   Content icon,
                   Content planIcon,
                   Content model,
                   float width,
                   float depth,
                   float height,
                   float elevation,
                   boolean movable,
                   java.lang.String cutOutShape,
                   float wallThickness,
                   float wallDistance,
                   Sash[] sashes,
                   float[][] modelRotation,
                   java.lang.String creator,
                   boolean resizable,
                   boolean deformable,
                   boolean texturable,
                   java.math.BigDecimal price,
                   java.math.BigDecimal valueAddedTaxPercentage,
                   java.lang.String currency)

Creates an unmodifiable catalog door or window of the default catalog.

Parameters:

id - the id of the new door or window, or null

name - the name of the new door or window

description - the description of the new door or window

information - additional information associated to the new door or window

tags - tags associated to the new door or window

creationDate - creation date of the new door or window in milliseconds since the epoch

grade - grade of the new door or window or null

icon - content of the icon of the new door or window

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new door or window

width - the width in centimeters of the new door or window

depth - the depth in centimeters of the new door or window

height - the height in centimeters of the new door or window

elevation - the elevation in centimeters of the new door or window

movable - if true, the new door or window is movable

cutOutShape - the shape used to cut out walls that intersect the new door or window

wallThickness - a value in percentage of the depth of the new door or window

wallDistance - a distance in percentage of the depth of the new door or window

sashes - the sashes attached to the new door or window

modelRotation - the rotation 3 by 3 matrix applied to the door or window model

creator - the creator of the model

resizable - if true, the size of the new door or window may be edited

deformable - if true, the width, depth and height of the new piece may change independently from each other

texturable - if false this piece should always keep the same color or texture.

price - the price of the new door or window, or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new door or window or null

currency - the price currency, noted with ISO 4217 code, or null

Since:

4.2

CatalogDoorOrWindow

public CatalogDoorOrWindow(java.lang.String name,
                   Content icon,
                   Content model,
                   float width,
                   float depth,
                   float height,
                   float elevation,
                   boolean movable,
                   float wallThickness,
                   float wallDistance,
                   Sash[] sashes,
                   java.lang.Integer color,
                   float[][] modelRotation,
                   boolean backFaceShown,
                   float iconYaw,
                   boolean proportional)

Creates a modifiable catalog door or window with all its values.

Parameters:

name - the name of the new door or window

icon - content of the icon of the new door or window

model - content of the 3D model of the new door or window

width - the width in centimeters of the new door or window

depth - the depth in centimeters of the new door or window

height - the height in centimeters of the new door or window

elevation - the elevation in centimeters of the new door or window

movable - if true, the new door or window is movable

wallThickness - a value in percentage of the depth of the new door or window

wallDistance - a distance in percentage of the depth of the new door or window

sashes - the sashes attached to the new door or window

color - the color of the door or window as RGB code or null if door or window color is unchanged

modelRotation - the rotation 3 by 3 matrix applied to the door or window model

backFaceShown - true if back face should be shown

iconYaw - the yaw angle used to create the door or window icon

proportional - if true, size proportions will be kept

Method Detail

getWallThickness

public float getWallThickness()

Returns the default thickness of the wall in which this door or window should be placed.

Specified by:

getWallThickness in interface DoorOrWindow

Returns:

a value in percentage of the depth of the door or the window.

getWallDistance

public float getWallDistance()

Returns the default distance that should lie at the back side of this door or window.

Specified by:

getWallDistance in interface DoorOrWindow

Returns:

a distance in percentage of the depth of the door or the window.

getSashes

public Sash[] getSashes()

Returns a copy of the sashes attached to this door or window. If no sash is defined an empty array is returned.

Specified by:

getSashes in interface DoorOrWindow

getCutOutShape

public java.lang.String getCutOutShape()

Returns the shape used to cut out walls that intersect this new door or window.

Specified by:

getCutOutShape in interface DoorOrWindow

Returns:

null or a shape defined with the syntax of the d attribute of a SVG path element that fits in a square spreading from (0, 0) to (1, 1) which will be scaled afterwards to the real size of this door or window.

isDoorOrWindow

public boolean isDoorOrWindow()

Returns always true.

Specified by:

isDoorOrWindow in interface PieceOfFurniture

Overrides:

isDoorOrWindow in class CatalogPieceOfFurniture