Sweet Home 3D 3.4

com.eteks.sweethome3d.model
Class CatalogLight

java.lang.Object
  extended by com.eteks.sweethome3d.model.CatalogPieceOfFurniture
      extended by com.eteks.sweethome3d.model.CatalogLight
All Implemented Interfaces:
Light, PieceOfFurniture, java.lang.Comparable<CatalogPieceOfFurniture>

public class CatalogLight
extends CatalogPieceOfFurniture
implements Light

A light of the catalog.

Since:
1.7
Author:
Emmanuel Puybaret

Constructor Summary
CatalogLight(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, LightSource[] lightSources, float[][] modelRotation, java.lang.String creator, boolean resizable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage)
          Creates an unmodifiable catalog light of the default catalog.
CatalogLight(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, LightSource[] lightSources, float[][] modelRotation, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage)
          Creates an unmodifiable catalog light of the default catalog.
CatalogLight(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, LightSource[] lightSources, java.lang.String staircaseCutOutShape, 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 light of the default catalog.
CatalogLight(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, LightSource[] lightSources, float[][] modelRotation, java.lang.String creator, boolean resizable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage)
          Creates an unmodifiable catalog light of the default catalog.
 
Method Summary
 LightSource[] getLightSources()
          Returns the sources managed by this light.
 
Methods inherited from class com.eteks.sweethome3d.model.CatalogPieceOfFurniture
compareTo, equals, getCategory, getColor, getCreator, getCurrency, getDepth, getDescription, getElevation, getHeight, getIcon, getIconYaw, getId, getModel, getModelRotation, getName, getPlanIcon, getPrice, getStaircaseCutOutShape, getValueAddedTaxPercentage, getWidth, hashCode, isBackFaceShown, isDeformable, isDoorOrWindow, isModifiable, isMovable, isProportional, isResizable, isTexturable
 
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, getCurrency, getDepth, getDescription, getElevation, getHeight, getIcon, getModel, getModelRotation, getName, getPlanIcon, getPrice, getStaircaseCutOutShape, getValueAddedTaxPercentage, getWidth, isBackFaceShown, isDeformable, isDoorOrWindow, isMovable, isResizable, isTexturable
 

Constructor Detail

CatalogLight

public CatalogLight(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,
                    LightSource[] lightSources,
                    float[][] modelRotation,
                    java.lang.String creator,
                    boolean resizable,
                    java.math.BigDecimal price,
                    java.math.BigDecimal valueAddedTaxPercentage)
Creates an unmodifiable catalog light of the default catalog.

Parameters:
id - the id of the new light, or null
name - the name of the new light
description - the description of the new light
icon - content of the icon of the new light
model - content of the 3D model of the new light
width - the width in centimeters of the new light
depth - the depth in centimeters of the new light
height - the height in centimeters of the new light
elevation - the elevation in centimeters of the new light
movable - if true, the new light is movable
lightSources - the light sources of the new light
modelRotation - the rotation 3 by 3 matrix applied to the light model
creator - the creator of the model
resizable - if true, the size of the new light may be edited
price - the price of the new light, or null
valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new light or null

CatalogLight

public CatalogLight(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,
                    LightSource[] lightSources,
                    float[][] modelRotation,
                    java.lang.String creator,
                    boolean resizable,
                    java.math.BigDecimal price,
                    java.math.BigDecimal valueAddedTaxPercentage)
Creates an unmodifiable catalog light of the default catalog.

Parameters:
id - the id of the new light, or null
name - the name of the new light
description - the description of the new light
icon - content of the icon of the new light
planIcon - content of the icon of the new piece displayed in plan
model - content of the 3D model of the new light
width - the width in centimeters of the new light
depth - the depth in centimeters of the new light
height - the height in centimeters of the new light
elevation - the elevation in centimeters of the new light
movable - if true, the new light is movable
lightSources - the light sources of the new light
modelRotation - the rotation 3 by 3 matrix applied to the light model
creator - the creator of the model
resizable - if true, the size of the new light may be edited
price - the price of the new light, or null
valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new light or null
Since:
2.2

CatalogLight

public CatalogLight(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,
                    LightSource[] lightSources,
                    float[][] modelRotation,
                    java.lang.String creator,
                    boolean resizable,
                    boolean deformable,
                    boolean texturable,
                    java.math.BigDecimal price,
                    java.math.BigDecimal valueAddedTaxPercentage)
Creates an unmodifiable catalog light of the default catalog.

Parameters:
id - the id of the new light, or null
name - the name of the new light
description - the description of the new light
icon - content of the icon of the new light
planIcon - content of the icon of the new piece displayed in plan
model - content of the 3D model of the new light
width - the width in centimeters of the new light
depth - the depth in centimeters of the new light
height - the height in centimeters of the new light
elevation - the elevation in centimeters of the new light
movable - if true, the new light is movable
lightSources - the light sources of the new light
modelRotation - the rotation 3 by 3 matrix applied to the light model
creator - the creator of the model
resizable - if true, the size of the new light 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 light, or null
valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new light or null
Since:
3.0

CatalogLight

public CatalogLight(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,
                    LightSource[] lightSources,
                    java.lang.String staircaseCutOutShape,
                    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 light of the default catalog.

Parameters:
id - the id of the new light, or null
name - the name of the new light
description - the description of the new light
icon - content of the icon of the new light
planIcon - content of the icon of the new piece displayed in plan
model - content of the 3D model of the new light
width - the width in centimeters of the new light
depth - the depth in centimeters of the new light
height - the height in centimeters of the new light
elevation - the elevation in centimeters of the new light
movable - if true, the new light is movable
lightSources - the light sources of the new light
staircaseCutOutShape - the shape used to cut out upper levels when they intersect with the piece like a staircase
modelRotation - the rotation 3 by 3 matrix applied to the light model
creator - the creator of the model
resizable - if true, the size of the new light 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 light, or null
valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new light or null
currency - the price currency, noted with ISO 4217 code, or null
Since:
3.4
Method Detail

getLightSources

public LightSource[] getLightSources()
Returns the sources managed by this light. Each light source point is a percentage of the width, the depth and the height of this light, with the abscissa origin at the left side of the piece, the ordinate origin at the front side of the piece and the elevation origin at the bottom side of the piece.

Specified by:
getLightSources in interface Light
Returns:
a copy of light sources array.

Sweet Home 3D 3.4

? Copyrights 2006-2011 eTeks - All rights reserved
Distributed under GNU General Public License