Class Home

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Home(wallHeight) Creates a home with no furniture and no walls.

Field Summary
Field Attributes	Field Name and Description
<static>	Home.CURRENT_VERSION The current version of this home.

Method Summary
Method Attributes	Method Name and Description
	addDimensionLine(dimensionLine) Adds the given dimension line to the set of dimension lines of this home.
	addDimensionLinesListener(listener) Adds the dimension line `listener` in parameter to this home.
	addFurnitureListener(listener) Adds the furniture `listener` in parameter to this home.
	addLabel(label) Adds the given label to the set of labels of this home.
	addLabelsListener(listener) Adds the label `listener` in parameter to this home.
	addLevel(level) Adds the given `level` to the list of levels of this home.
	addLevelsListener(listener) Adds the level `listener` in parameter to this home.
	addPieceOfFurniture(piece, index) Adds the `piece` in parameter at a given `index`.
	addPieceOfFurnitureToGroup(piece, group, index) Adds the `piece` in parameter at the `index` in the given `group`.
	addPolyline(polyline, index) Adds a `polyline` at a given `index` of the set of polylines of this home.
	addPolylinesListener(listener) Adds the polyline `listener` in parameter to this home.
	addPropertyChangeListener(propertyName, listener) Adds the property change `listener` in parameter to this home for a specific property name.
	addRoom(room, index) Adds the `room` in parameter at a given `index`.
	addRoomsListener(listener) Adds the room `listener` in parameter to this home.
	addSelectionListener(listener) Adds the selection `listener` in parameter to this home.
	addWall(wall) Adds the given `wall` to the set of walls of this home.
	addWallsListener(listener) Adds the wall `listener` in parameter to this home.
	clone() Returns a clone of this home and the objects it contains.
	deleteDimensionLine(dimensionLine) Removes the given dimension line from the set of dimension lines of this home.
	deleteLabel(label) Removes the given label from the set of labels of this home.
	deleteLevel(level) Removes the given `level` from the set of levels of this home and all the furniture, walls, rooms, dimension lines and labels that belong to this level.
	deletePieceOfFurniture(piece) Deletes the `piece` in parameter from this home.
	deletePolyline(polyline) Removes a given `polyline` from the set of polylines of this home.
	deleteRoom(room) Removes the given `room` from the set of rooms of this home.
	deleteWall(wall) Removes the given `wall` from the set of walls of this home.
	deselectItem(item) Deselects `item` if it's selected and notifies listeners selection change.
<static>	Home.duplicate(items) Returns a deep copy of home selectable `items`.
	getBackgroundImage() Returns the plan background image of this home.
	getCamera() Returns the camera used to display this home.
	getCompass() Returns the compass associated to this home.
	getDimensionLines() Returns a collection of the dimension lines of this home.
<static>	Home.getDimensionLinesSubList(items) Returns a sub list of `items` that contains only dimension lines.
	getEnvironment() Returns the environment attributes of this home.
	getFurniture() Returns a list of the furniture managed by this home.
	getFurnitureAdditionalProperties() Returns the list of furniture additional properties which should be handled in the user interface.
	getFurnitureSortedProperty() Returns the furniture property on which home is sorted or `null` if home furniture isn't sorted.
	getFurnitureSortedPropertyName() Returns the furniture property name on which home is sorted or `null` if home furniture isn't sorted.
<static>	Home.getFurnitureSubList(items) Returns a sub list of `items` that contains only home furniture.
	getFurnitureVisibleProperties() Returns a list of the furniture properties that are visible.
	getFurnitureVisiblePropertyNames() Returns a list of the furniture property names that are visible.
	getHomeObjects() Returns all the mutable objects handled by this home.
	getLabels() Returns a collection of the labels of this home.
<static>	Home.getLabelsSubList(items) Returns a sub list of `items` that contains only labels.
	getLevels() Returns a collection of the levels of this home.
	getName() Returns the name of this home.
	getNumericProperty(name) Returns the numeric value of the property `name` associated with this home.
	getObserverCamera() Returns the camera used to display this home from an observer point of view.
	getPolylines() Returns a collection of the polylines of this home.
<static>	Home.getPolylinesSubList(items) Returns a sub list of `items` that contains only labels.
	getPrint() Returns the print attributes of this home.
	getProperty(name) Returns the value of the property `name` associated with this home.
	getPropertyNames() Returns the property names.
	getRooms() Returns a collection of the rooms of this home.
<static>	Home.getRoomsSubList(items) Returns a sub list of `items` that contains only rooms.
	getSelectableViewableItems() Returns all the selectable and viewable items in this home, except the observer camera.
	getSelectedItems() Returns a list of the selected items in home.
	getSelectedLevel() Returns the selected level in home or `null` if home has no level.
	getStoredCameras() Returns a list of the cameras stored by this home.
<static>	Home.getSubList(items, subListClass) Returns a sub list of `items` that contains only instances of `subListClass`.
	getTopCamera() Returns the camera used to display this home from a top point of view.
	getVersion() Returns the version of this home, the last time it was serialized or or #CURRENT_VERSION if it is not serialized yet or was serialized with Sweet Home 3D 0.x.
	getVisualProperty(name) Returns the value of the visual property `name` associated with this home.
	getWallHeight() Returns the wall height of this home.
	getWalls() Returns a collection of the walls of this home.
<static>	Home.getWallsSubList(items) Returns a sub list of `items` that contains only walls.
	isAllLevelsSelection() Returns `true` if the selected items in this home are from all levels.
	isBasePlanLocked() Returns `true` if the home objects belonging to the base plan (generally walls, rooms, dimension lines and texts) are locked.
	isEmpty() Returns `true` if this home doesn't contain any item i.e.
	isFurnitureDescendingSorted() Returns whether furniture is sorted in ascending or descending order.
	isItemSelected(item) Returns `true` if the given `item` is selected in this home
	isModified() Returns whether the state of this home is modified or not.
	isRecovered() Returns whether this home was recovered or not.
	isRepaired() Returns whether this home was repaired or not.
	removeDimensionLinesListener(listener) Removes the dimension line `listener` in parameter from this home.
	removeFurnitureListener(listener) Removes the furniture `listener` in parameter from this home.
	removeLabelsListener(listener) Removes the label `listener` in parameter from this home.
	removeLevelsListener(listener) Removes the level `listener` in parameter from this home.
	removePolylinesListener(listener) Removes the polyline `listener` in parameter from this home.
	removePropertyChangeListener(propertyName, listener) Removes the property change `listener` in parameter from this object.
	removeRoomsListener(listener) Removes the room `listener` in parameter from this home.
	removeSelectionListener(listener) Removes the selection `listener` in parameter from this home.
	removeWallsListener(listener) Removes the wall `listener` in parameter from this home.
	setAllLevelsSelection(selectionAtAllLevels) Sets whether the selected items in this home are from all levels, and notifies listeners of the change.
	setBackgroundImage(backgroundImage) Sets the plan background image of this home and fires a `PropertyChangeEvent`.
	setBasePlanLocked(basePlanLocked) Sets whether home objects belonging to the base plan (generally walls, rooms, dimension lines and texts) are locked and fires a `PropertyChangeEvent`.
	setCamera(camera) Sets the camera used to display this home and fires a `PropertyChangeEvent`.
	setFurnitureAdditionalProperties(furnitureAdditionalProperties) Sets the list of furniture additional properties which should be handled in the user interface.
	setFurnitureDescendingSorted(furnitureDescendingSorted) Sets the furniture sort order on which home should be sorted and fires a `PropertyChangeEvent`.
	setFurnitureSortedProperty(furnitureSortedProperty) Sets the furniture property on which this home should be sorted and fires a `PropertyChangeEvent`.
	setFurnitureSortedPropertyName(furnitureSortedPropertyName) Sets the furniture property name on which this home should be sorted and fires a `PropertyChangeEvent`.
	setFurnitureVisibleProperties(furnitureVisibleProperties) Sets the furniture properties that are visible and the order in which they are visible, then fires a `PropertyChangeEvent`.
	setFurnitureVisiblePropertyNames(furnitureVisiblePropertyNames) Sets the furniture property names that are visible and the order in which they are visible, then fires a `PropertyChangeEvent`.
	setModified(modified) Sets the modified state of this home and fires a `PropertyChangeEvent`.
	setName(name) Sets the name of this home and fires a `PropertyChangeEvent`.
	setPrint(print) Sets the print attributes of this home and fires a `PropertyChangeEvent`.
	setProperty(name, value) Sets a property associated with this home.
	setRecovered(recovered) Sets whether this home was recovered or not and fires a `PropertyChangeEvent`.
	setRepaired(repaired) Sets whether this home is repaired or not and fires a `PropertyChangeEvent`.
	setSelectedItems(selectedItems) Sets the selected items in home and notifies listeners selection change.
	setSelectedLevel(selectedLevel) Sets the selected level in home and notifies listeners of the change.
	setStoredCameras(storedCameras) Sets the cameras stored by this home and fires a `PropertyChangeEvent`.
	setVersion(version) Sets the version of this home.
	setVisualProperty(name, value) Sets a visual property associated with this home.

Class Detail

Home(wallHeight)

Creates a home with no furniture and no walls.
Author: Emmanuel Puybaret.

Parameters:
{number} wallHeight: default height for home walls

Field Detail

<static> Home.CURRENT_VERSION

The current version of this home. Each time the field list is changed in Home class or in one of the classes that it uses, this number is increased.

Method Detail

addDimensionLine(dimensionLine)

Adds the given dimension line to the set of dimension lines of this home. Once dimensionLine is added, dimension line listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification, with an {@link CollectionEvent#getType() event type} equal to CollectionEvent.Type#ADD.

Parameters:
{DimensionLine} dimensionLine: the dimension line to add

addDimensionLinesListener(listener)

Adds the dimension line listener in parameter to this home.

Parameters:
{Object} listener: the listener to add

addFurnitureListener(listener)

Adds the furniture listener in parameter to this home.

Parameters:
{Object} listener: the listener to add

addLabel(label)

Adds the given label to the set of labels of this home. Once label is added, label listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification, with an {@link CollectionEvent#getType() event type} equal to CollectionEvent.Type#ADD.

Parameters:
{Label} label: the label to add

addLabelsListener(listener)

Adds the label listener in parameter to this home.

Parameters:
{Object} listener: the listener to add

addLevel(level)

Adds the given level to the list of levels of this home. Once the level is added, level listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification, with an {@link CollectionEvent#getType() event type} equal to CollectionEvent.Type#ADD.

Parameters:
{Level} level: the level to add

addLevelsListener(listener)

Adds the level listener in parameter to this home.

Parameters:
{Object} listener: the listener to add

addPieceOfFurniture(piece, index)

Adds the piece in parameter at a given index. Once the piece is added, furniture listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification.

Parameters:
{HomePieceOfFurniture} piece: the piece to add
{number} index: the index at which the piece will be added

addPieceOfFurnitureToGroup(piece, group, index)

Adds the piece in parameter at the index in the given group. Once the piece is added, furniture listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification with an event {@link CollectionEvent#getIndex() index} equal to -1.

Parameters:
{HomePieceOfFurniture} piece: the piece to add
{HomeFurnitureGroup} group: the group to which the piece will be added
{number} index: the index at which the piece will be added

addPolyline(polyline, index)

Adds a polyline at a given index of the set of polylines of this home. Once the polyline is added, polyline listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification, with an {@link CollectionEvent#getType() event type} equal to CollectionEvent.Type#ADD.

Parameters:
{Polyline} polyline: the polyline to add
{number} index: the index at which the polyline will be added

addPolylinesListener(listener)

Adds the polyline listener in parameter to this home.

Parameters:
{Object} listener: the listener to add

addPropertyChangeListener(propertyName, listener)

Adds the property change listener in parameter to this home for a specific property name. Properties set with {@link #setProperty(String, String) setProperty} will be notified with an event of PropertyChangeEvent class which property name will be equal to the property, whereas changes on properties of Property enum will be notified with an event where the property name will be equal to the value returned by Property#name() call.

Parameters:
{string} propertyName
{PropertyChangeListener} listener

addRoom(room, index)

Adds the room in parameter at a given index. Once the room is added, room listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification, with an {@link CollectionEvent#getType() event type} equal to CollectionEvent.Type#ADD.

Parameters:
{Room} room: the room to add
{number} index: the index at which the room will be added

addRoomsListener(listener)

Adds the room listener in parameter to this home.

Parameters:
{Object} listener: the listener to add

addSelectionListener(listener)

Adds the selection listener in parameter to this home.

Parameters:
{Object} listener: the listener to add

addWall(wall)

Adds the given wall to the set of walls of this home. Once the wall is added, wall listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification, with an {@link CollectionEvent#getType() event type} equal to CollectionEvent.Type#ADD.

Parameters:
{Wall} wall: the wall to add

addWallsListener(listener)

Adds the wall listener in parameter to this home.

Parameters:
{Object} listener: the listener to add

{Home} clone()

Returns a clone of this home and the objects it contains. Listeners bound to this home aren't added to the returned home.

Returns:: {Home}

deleteDimensionLine(dimensionLine)

Removes the given dimension line from the set of dimension lines of this home. Once dimensionLine is removed, dimension line listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification, with an {@link CollectionEvent#getType() event type} equal to CollectionEvent.Type#DELETE.

Parameters:
{DimensionLine} dimensionLine: the dimension line to remove

deleteLabel(label)

Removes the given label from the set of labels of this home. Once label is removed, label listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification, with an {@link CollectionEvent#getType() event type} equal to CollectionEvent.Type#DELETE.

Parameters:
{Label} label: the label to remove

deleteLevel(level)

Removes the given level from the set of levels of this home and all the furniture, walls, rooms, dimension lines and labels that belong to this level. Once the level is removed, level listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification, with an {@link CollectionEvent#getType() event type} equal to CollectionEvent.Type#DELETE.

Parameters:
{Level} level: the level to remove

deletePieceOfFurniture(piece)

Deletes the piece in parameter from this home. Once the piece is deleted, furniture listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification. If the removed piece belongs to a group, the {@link CollectionEvent#getIndex() index} of the event will be -1.

Parameters:
{HomePieceOfFurniture} piece: the piece to remove

deletePolyline(polyline)

Removes a given polyline from the set of polylines of this home. Once the polyline is removed, polyline listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification, with an {@link CollectionEvent#getType() event type} equal to CollectionEvent.Type#DELETE.

Parameters:
{Polyline} polyline: the polyline to remove

deleteRoom(room)

Removes the given room from the set of rooms of this home. Once the room is removed, room listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification, with an {@link CollectionEvent#getType() event type} equal to CollectionEvent.Type#DELETE.

Parameters:
{Room} room: the room to remove

deleteWall(wall)

Removes the given wall from the set of walls of this home. Once the wall is removed, wall listeners added to this home will receive a {@link CollectionListener#collectionChanged(CollectionEvent) collectionChanged} notification, with an {@link CollectionEvent#getType() event type} equal to CollectionEvent.Type#DELETE. If any wall is attached to wall they will be detached from it.

Parameters:
{Wall} wall: the wall to remove

deselectItem(item)

Deselects item if it's selected and notifies listeners selection change.

Parameters:
{Object} item: the item to remove from selected items

<static> {*[]} Home.duplicate(items)

Returns a deep copy of home selectable items. Duplicated items are at the same index as their original and use different ids.

Parameters:
{? extends com.eteks.sweethome3d.model.Selectable[]} items: the items to duplicate

Returns:: {*[]}

{BackgroundImage} getBackgroundImage()

Returns the plan background image of this home.

Returns:: {BackgroundImage}

{Camera} getCamera()

Returns the camera used to display this home.

Returns:: {Camera}

{Compass} getCompass()

Returns the compass associated to this home.

Returns:: {Compass}

{DimensionLine[]} getDimensionLines()

Returns a collection of the dimension lines of this home.

Returns:: {DimensionLine[]}

<static> {DimensionLine[]} Home.getDimensionLinesSubList(items)

Returns a sub list of items that contains only dimension lines.

Parameters:
{? extends com.eteks.sweethome3d.model.Selectable[]} items: the items among which the search is done

Returns:: {DimensionLine[]}

{HomeEnvironment} getEnvironment()

Returns the environment attributes of this home.

Returns:: {HomeEnvironment}

{HomePieceOfFurniture[]} getFurniture()

Returns a list of the furniture managed by this home. This furniture in this list is always sorted in the index order they were added to home.

Returns:: {HomePieceOfFurniture[]}

{ObjectProperty[]} getFurnitureAdditionalProperties()

Returns the list of furniture additional properties which should be handled in the user interface.

Returns:: {ObjectProperty[]}

{string} getFurnitureSortedProperty()

Returns the furniture property on which home is sorted or null if home furniture isn't sorted.

Deprecated:
and #setFurnitureSortedProperty(HomePieceOfFurniture.SortableProperty) should be replaced by calls to #getFurnitureSortedPropertyName() and #setFurnitureSortedPropertyName(String) to allow sorting on additional properties.

Returns:: {string}

{string} getFurnitureSortedPropertyName()

Returns the furniture property name on which home is sorted or null if home furniture isn't sorted.

Returns:: {string}

<static> {HomePieceOfFurniture[]} Home.getFurnitureSubList(items)

Returns a sub list of items that contains only home furniture.

Parameters:
{? extends com.eteks.sweethome3d.model.Selectable[]} items: the items among which the search is done

Returns:: {HomePieceOfFurniture[]}

{string[]} getFurnitureVisibleProperties()

Returns a list of the furniture properties that are visible.

Deprecated:
and #setFurnitureVisibleProperties(List) should be replaced by calls to #getFurnitureVisiblePropertyNames() and #setFurnitureSortedPropertyName(List) to allow displaying additional properties.

Returns:: {string[]}

{string[]} getFurnitureVisiblePropertyNames()

Returns a list of the furniture property names that are visible.

Returns:: {string[]}

{HomeObject[]} getHomeObjects()

Returns all the mutable objects handled by this home.

Returns:: {HomeObject[]} a list containing environment, compass, levels, walls, rooms, furniture and their possible children, polylines, dimension lines, labels and cameras.

{Label[]} getLabels()

Returns a collection of the labels of this home.

Returns:: {Label[]}

<static> {Label[]} Home.getLabelsSubList(items)

Returns a sub list of items that contains only labels.

Parameters:
{? extends com.eteks.sweethome3d.model.Selectable[]} items: the items among which the search is done

Returns:: {Label[]}

{Level[]} getLevels()

Returns a collection of the levels of this home.

Returns:: {Level[]}

{string} getName()

Returns the name of this home.

Returns:: {string}

{number} getNumericProperty(name)

Returns the numeric value of the property name associated with this home.

Parameters:
{string} name

Returns:: {number} an instance of Long, Double or null if the property doesn't exist or can't be parsed.

{ObserverCamera} getObserverCamera()

Returns the camera used to display this home from an observer point of view.

Returns:: {ObserverCamera}

{Polyline[]} getPolylines()

Returns a collection of the polylines of this home.

Returns:: {Polyline[]}

<static> {Polyline[]} Home.getPolylinesSubList(items)

Returns a sub list of items that contains only labels.

Parameters:
{? extends com.eteks.sweethome3d.model.Selectable[]} items: the items among which the search is done

Returns:: {Polyline[]}

{HomePrint} getPrint()

Returns the print attributes of this home.

Returns:: {HomePrint}

{string} getProperty(name)

Returns the value of the property name associated with this home.

Parameters:
{string} name

Returns:: {string} the value of the property or null if it doesn't exist.

{string[]} getPropertyNames()

Returns the property names.

Returns:: {string[]} a collection of all the names of the properties set with {@link #setProperty(String, String) setProperty}

{Room[]} getRooms()

Returns a collection of the rooms of this home.

Returns:: {Room[]}

<static> {Room[]} Home.getRoomsSubList(items)

Returns a sub list of items that contains only rooms.

Parameters:
{? extends com.eteks.sweethome3d.model.Selectable[]} items: the items among which the search is done

Returns:: {Room[]}

{*[]} getSelectableViewableItems()

Returns all the selectable and viewable items in this home, except the observer camera.

Returns:: {*[]} a list containing viewable walls, rooms, furniture, dimension lines, polylines, labels and compass.

{*[]} getSelectedItems()

Returns a list of the selected items in home.

Returns:: {*[]}

{Level} getSelectedLevel()

Returns the selected level in home or null if home has no level.

Returns:: {Level}

{Camera[]} getStoredCameras()

Returns a list of the cameras stored by this home.

Returns:: {Camera[]}

<static> {*[]} Home.getSubList(items, subListClass)

Returns a sub list of items that contains only instances of subListClass.

Parameters:
{? extends com.eteks.sweethome3d.model.Selectable[]} items: the items among which the search is done
{Object} subListClass: the class of the searched items

Returns:: {*[]}

{Camera} getTopCamera()

Returns the camera used to display this home from a top point of view.

Returns:: {Camera}

{number} getVersion()

Returns the version of this home, the last time it was serialized or or #CURRENT_VERSION if it is not serialized yet or was serialized with Sweet Home 3D 0.x. Version is useful to know with which Sweet Home 3D version this home was saved and warn user that he may lose information if he saves with current application a home created by a more recent version.

Returns:: {number}

{Object} getVisualProperty(name)

Returns the value of the visual property name associated with this home.

Parameters:
{string} name

Deprecated:
and {@link #setVisualProperty(String, Object)} should be replaced by calls to #getProperty(String) and {@link #setProperty(String, String)} to ensure they can be easily saved and read. Future file format might not save visual properties anymore.

Returns:: {Object}

{number} getWallHeight()

Returns the wall height of this home.

Returns:: {number}

{Wall[]} getWalls()

Returns a collection of the walls of this home.

Returns:: {Wall[]}

<static> {Wall[]} Home.getWallsSubList(items)

Returns a sub list of items that contains only walls.

Parameters:
{? extends com.eteks.sweethome3d.model.Selectable[]} items: the items among which the search is done

Returns:: {Wall[]}

{boolean} isAllLevelsSelection()

Returns true if the selected items in this home are from all levels.

Returns:: {boolean}

{boolean} isBasePlanLocked()

Returns true if the home objects belonging to the base plan (generally walls, rooms, dimension lines and texts) are locked.

Returns:: {boolean}

{boolean} isEmpty()

Returns true if this home doesn't contain any item i.e. no piece of furniture, no wall, no room, no dimension line and no label.

Returns:: {boolean}

{boolean} isFurnitureDescendingSorted()

Returns whether furniture is sorted in ascending or descending order.

Returns:: {boolean}

{boolean} isItemSelected(item)

Returns true if the given item is selected in this home

Parameters:
{Object} item: a selectable item.

Returns:: {boolean}

{boolean} isModified()

Returns whether the state of this home is modified or not.

Returns:: {boolean}

{boolean} isRecovered()

Returns whether this home was recovered or not.

Returns:: {boolean}

{boolean} isRepaired()

Returns whether this home was repaired or not.

Returns:: {boolean}

removeDimensionLinesListener(listener)

Removes the dimension line listener in parameter from this home.

Parameters:
{Object} listener: the listener to remove

removeFurnitureListener(listener)

Removes the furniture listener in parameter from this home.

Parameters:
{Object} listener: the listener to remove

removeLabelsListener(listener)

Removes the label listener in parameter from this home.

Parameters:
{Object} listener: the listener to remove

removeLevelsListener(listener)

Removes the level listener in parameter from this home.

Parameters:
{Object} listener: the listener to remove

removePolylinesListener(listener)

Removes the polyline listener in parameter from this home.

Parameters:
{Object} listener: the listener to remove

removePropertyChangeListener(propertyName, listener)

Removes the property change listener in parameter from this object.

Parameters:
{string} propertyName
{PropertyChangeListener} listener

removeRoomsListener(listener)

Removes the room listener in parameter from this home.

Parameters:
{Object} listener: the listener to remove

removeSelectionListener(listener)

Removes the selection listener in parameter from this home.

Parameters:
{Object} listener: the listener to remove

removeWallsListener(listener)

Removes the wall listener in parameter from this home.

Parameters:
{Object} listener: the listener to remove

setAllLevelsSelection(selectionAtAllLevels)

Sets whether the selected items in this home are from all levels, and notifies listeners of the change.

Parameters:
{boolean} selectionAtAllLevels

setBackgroundImage(backgroundImage)

Sets the plan background image of this home and fires a PropertyChangeEvent.

Parameters:
{BackgroundImage} backgroundImage: the new background image

setBasePlanLocked(basePlanLocked)

Sets whether home objects belonging to the base plan (generally walls, rooms, dimension lines and texts) are locked and fires a PropertyChangeEvent.

Parameters:
{boolean} basePlanLocked

setCamera(camera)

Sets the camera used to display this home and fires a PropertyChangeEvent.

Parameters:
{Camera} camera: the camera to use

setFurnitureAdditionalProperties(furnitureAdditionalProperties)

Sets the list of furniture additional properties which should be handled in the user interface.

Parameters:
{ObjectProperty[]} furnitureAdditionalProperties

setFurnitureDescendingSorted(furnitureDescendingSorted)

Sets the furniture sort order on which home should be sorted and fires a PropertyChangeEvent.

Parameters:
{boolean} furnitureDescendingSorted

setFurnitureSortedProperty(furnitureSortedProperty)

Sets the furniture property on which this home should be sorted and fires a PropertyChangeEvent.

Parameters:
{string} furnitureSortedProperty: the new property

Deprecated:
and #setFurnitureSortedProperty(HomePieceOfFurniture.SortableProperty) should be replaced by calls to #getFurnitureSortedPropertyName() and #setFurnitureSortedPropertyName(String) to allow sorting on additional properties.

setFurnitureSortedPropertyName(furnitureSortedPropertyName)

Sets the furniture property name on which this home should be sorted and fires a PropertyChangeEvent.

Parameters:
{string} furnitureSortedPropertyName: the name of the property

setFurnitureVisibleProperties(furnitureVisibleProperties)

Sets the furniture properties that are visible and the order in which they are visible, then fires a PropertyChangeEvent.

Parameters:
{string[]} furnitureVisibleProperties: the properties to display

Deprecated:
and #setFurnitureVisibleProperties(List) should be replaced by calls to #getFurnitureVisiblePropertyNames() and #setFurnitureSortedPropertyName(List) to allow displaying additional properties.

setFurnitureVisiblePropertyNames(furnitureVisiblePropertyNames)

Sets the furniture property names that are visible and the order in which they are visible, then fires a PropertyChangeEvent.

Parameters:
{string[]} furnitureVisiblePropertyNames: the property names to display

setModified(modified)

Sets the modified state of this home and fires a PropertyChangeEvent.

Parameters:
{boolean} modified

setName(name)

Sets the name of this home and fires a PropertyChangeEvent.

Parameters:
{string} name: the new name of this home

setPrint(print)

Sets the print attributes of this home and fires a PropertyChangeEvent.

Parameters:
{HomePrint} print: the new print attributes

setProperty(name, value)

Sets a property associated with this home. Once the property is updated, listeners added to this home will receive a change event of PropertyChangeEvent class.
To avoid any issue with existing or future properties of Sweet Home 3D classes, do not use property names written with only upper case letters.

Parameters:
{string} name: the name of the property to set
{string} value: the new value of the property

setRecovered(recovered)

Sets whether this home was recovered or not and fires a PropertyChangeEvent.

Parameters:
{boolean} recovered

setRepaired(repaired)

Sets whether this home is repaired or not and fires a PropertyChangeEvent.

Parameters:
{boolean} repaired

setSelectedItems(selectedItems)

Sets the selected items in home and notifies listeners selection change.

Parameters:
{? extends com.eteks.sweethome3d.model.Selectable[]} selectedItems: the list of selected items

setSelectedLevel(selectedLevel)

Sets the selected level in home and notifies listeners of the change.

Parameters:
{Level} selectedLevel: the level to select

setStoredCameras(storedCameras)

Sets the cameras stored by this home and fires a PropertyChangeEvent. The list given as parameter is cloned but not the camera instances it contains.

Parameters:
{Camera[]} storedCameras: the new list of cameras

{void} setVersion(version)

Sets the version of this home.

Parameters:
{number} version

Returns:: {void} version the new version

setVisualProperty(name, value)

Sets a visual property associated with this home.

Parameters:
{string} name
{Object} value

Deprecated:
and {@link #setVisualProperty(String, Object)} should be replaced by calls to #getProperty(String) and {@link #setProperty(String, String)} to ensure they can be easily saved and read. Future file format might not save visual properties anymore.

	© Copyright 2024 Space Mushrooms Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Aug 21 2024 17:43:23 GMT+0200 (CEST)

Classes

Class Home