Class PolylineController

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	PolylineController(home, preferences, viewFactory, contentManager, undoSupport) Creates the controller of polyline view with undo support.

Method Summary
Method Attributes	Method Name and Description
	addPropertyChangeListener(property, listener) Adds the property change `listener` in parameter to this controller.
	displayView(parentView) Displays the view controlled by this controller.
	getCapStyle() Returns the edited capStyle.
	getColor() Returns the edited color.
	getDashOffset() Returns the edited dash offset.
	getDashPattern() Returns the edited dash pattern.
	getDashStyle() Returns the edited dash style.
	getElevation() Returns the edited elevation.
	getEndArrowStyle() Returns the edited end arrow style.
	getJoinStyle() Returns the edited joinStyle.
	getStartArrowStyle() Returns the edited start arrow style.
	getThickness() Returns the edited thickness.
	getView() Returns the view associated with this controller.
	isArrowsStyleEditable() Returns `true` if arrows style is editable.
	isCapStyleEditable() Returns `true` if cap style is editable.
	isElevationEnabled() Returns `Boolean.TRUE` if all edited polylines are viewed in 3D, or `Boolean.FALSE` if no polyline is viewed in 3D.
	isJoinStyleEditable() Returns `true` if join style is editable.
	modifyPolylines() Controls the modification of selected polylines in edited home.
	removePropertyChangeListener(property, listener) Removes the property change `listener` in parameter from this controller.
	setCapStyle(capStyle) Sets the edited capStyle.
	setColor(color) Sets the edited color.
	setDashOffset(dashOffset) Sets the edited dash offset.
	setDashPattern(dashPattern) Sets the edited dash pattern.
	setDashStyle(dashStyle) Sets the edited dash style.
	setElevation(elevation) Sets the edited elevation.
	setEndArrowStyle(endArrowStyle) Sets the edited end arrow style.
	setJoinStyle(joinStyle) Sets the edited joinStyle.
	setStartArrowStyle(startArrowStyle) Sets the edited start arrow style.
	setThickness(thickness) Sets the edited thickness.
	updateProperties() Updates edited properties from selected polylines in the home edited by this controller.

Class Detail

PolylineController(home, preferences, viewFactory, contentManager, undoSupport)

Creates the controller of polyline view with undo support.
Author: Emmanuel Puybaret.

Parameters:
{Home} home
{UserPreferences} preferences
{Object} viewFactory
{Object} contentManager
{javax.swing.undo.UndoableEditSupport} undoSupport

Method Detail

addPropertyChangeListener(property, listener)

Adds the property change listener in parameter to this controller.

Parameters:
{string} property
{PropertyChangeListener} listener

displayView(parentView)

Displays the view controlled by this controller.

Parameters:
{Object} parentView

{Polyline.CapStyle} getCapStyle()

Returns the edited capStyle.

Returns:: {Polyline.CapStyle}

{number} getColor()

Returns the edited color.

Returns:: {number}

{number} getDashOffset()

Returns the edited dash offset.

Returns:: {number}

{float[]} getDashPattern()

Returns the edited dash pattern.

Returns:: {float[]}

{Polyline.DashStyle} getDashStyle()

Returns the edited dash style.

Returns:: {Polyline.DashStyle}

{number} getElevation()

Returns the edited elevation.

Returns:: {number}

{Polyline.ArrowStyle} getEndArrowStyle()

Returns the edited end arrow style.

Returns:: {Polyline.ArrowStyle}

{Polyline.JoinStyle} getJoinStyle()

Returns the edited joinStyle.

Returns:: {Polyline.JoinStyle}

{Polyline.ArrowStyle} getStartArrowStyle()

Returns the edited start arrow style.

Returns:: {Polyline.ArrowStyle}

{number} getThickness()

Returns the edited thickness.

Returns:: {number}

{Object} getView()

Returns the view associated with this controller.

Returns:: {Object}

{boolean} isArrowsStyleEditable()

Returns true if arrows style is editable.

Returns:: {boolean}

{boolean} isCapStyleEditable()

Returns true if cap style is editable.

Returns:: {boolean}

{boolean} isElevationEnabled()

Returns Boolean.TRUE if all edited polylines are viewed in 3D, or Boolean.FALSE if no polyline is viewed in 3D.

Returns:: {boolean}

{boolean} isJoinStyleEditable()

Returns true if join style is editable.

Returns:: {boolean}

modifyPolylines()

Controls the modification of selected polylines in edited home.

removePropertyChangeListener(property, listener)

Removes the property change listener in parameter from this controller.

Parameters:
{string} property
{PropertyChangeListener} listener

setCapStyle(capStyle)

Sets the edited capStyle.

Parameters:
{Polyline.CapStyle} capStyle

setColor(color)

Sets the edited color.

Parameters:
{number} color

setDashOffset(dashOffset)

Sets the edited dash offset.

Parameters:
{number} dashOffset

setDashPattern(dashPattern)

Sets the edited dash pattern.

Parameters:
{float[]} dashPattern

setDashStyle(dashStyle)

Sets the edited dash style.

Parameters:
{Polyline.DashStyle} dashStyle

setElevation(elevation)

Sets the edited elevation.

Parameters:
{number} elevation

setEndArrowStyle(endArrowStyle)

Sets the edited end arrow style.

Parameters:
{Polyline.ArrowStyle} endArrowStyle

setJoinStyle(joinStyle)

Sets the edited joinStyle.

Parameters:
{Polyline.JoinStyle} joinStyle

setStartArrowStyle(startArrowStyle)

Sets the edited start arrow style.

Parameters:
{Polyline.ArrowStyle} startArrowStyle

setThickness(thickness)

Sets the edited thickness.

Parameters:
{number} thickness

updateProperties()

Updates edited properties from selected polylines in the home edited by this controller.

	© 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:24 GMT+0200 (CEST)

Classes

Class PolylineController