Class FurnitureCategory
Defined in: SweetHome3D.js.
Constructor Attributes | Constructor Name and Description |
---|---|
FurnitureCategory(name)
Create a category.
|
Method Attributes | Method Name and Description |
---|---|
compareTo(category)
Compares the names of this category and the one in parameter.
|
|
equals(obj)
Returns
true if this category and the one in parameter have the same name. |
|
Returns the furniture list of this category sorted by name.
|
|
Returns the count of furniture in this category.
|
|
getIndexOfPieceOfFurniture(piece)
Returns the index of the given
piece of furniture. |
|
getName()
Returns the name of this category.
|
|
getPieceOfFurniture(index)
Returns the piece of furniture at a given
index . |
|
hashCode()
|
Class Detail
FurnitureCategory(name)
Create a category.
Author: Emmanuel Puybaret.
Author: Emmanuel Puybaret.
- Parameters:
- {string} name
- the name of the category.
Method Detail
{number}
compareTo(category)
Compares the names of this category and the one in parameter.
- Parameters:
- {FurnitureCategory} category
- Returns:
- {number}
{boolean}
equals(obj)
Returns
true
if this category and the one in parameter have the same name.
- Parameters:
- {Object} obj
- Returns:
- {boolean}
{CatalogPieceOfFurniture[]}
getFurniture()
Returns the furniture list of this category sorted by name.
- Returns:
- {CatalogPieceOfFurniture[]} a list of furniture.
{number}
getFurnitureCount()
Returns the count of furniture in this category.
- Returns:
- {number}
{number}
getIndexOfPieceOfFurniture(piece)
Returns the index of the given
piece
of furniture.
- Parameters:
- {CatalogPieceOfFurniture} piece
- Returns:
- {number}
{string}
getName()
Returns the name of this category.
- Returns:
- {string}
{CatalogPieceOfFurniture}
getPieceOfFurniture(index)
Returns the piece of furniture at a given
index
.
- Parameters:
- {number} index
- Returns:
- {CatalogPieceOfFurniture}
{number}
hashCode()
- Returns:
- {number}