Polyline (Sweet Home 3D 7.5 API)

java.lang.Object
- com.eteks.sweethome3d.model.HomeObject
- - com.eteks.sweethome3d.model.Polyline

All Implemented Interfaces:

Elevatable, Selectable, java.io.Serializable, java.lang.Cloneable
```
public class Polyline
extends HomeObject
implements Selectable, Elevatable
```
A polyline or a polygon in a home plan.

Since:

5.0

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Polyline.ArrowStyle`
`static class`	`Polyline.CapStyle`
`static class`	`Polyline.DashStyle`
`static class`	`Polyline.JoinStyle`
`static class`	`Polyline.Property` The properties of a polyline that may change.

Constructor Summary

Constructors
Constructor and Description
`Polyline(float[][] points)` Creates a polyline from the given coordinates.
`Polyline(float[][] points, float thickness, Polyline.CapStyle capStyle, Polyline.JoinStyle joinStyle, Polyline.DashStyle dashStyle, float dashOffset, Polyline.ArrowStyle startArrowStyle, Polyline.ArrowStyle endArrowStyle, boolean closedPath, int color)` Creates a polyline from the given coordinates.
`Polyline(float[][] points, float thickness, Polyline.CapStyle capStyle, Polyline.JoinStyle joinStyle, Polyline.DashStyle dashStyle, Polyline.ArrowStyle startArrowStyle, Polyline.ArrowStyle endArrowStyle, boolean closedPath, int color)` Creates a polyline from the given coordinates.
`Polyline(java.lang.String id, float[][] points)` Creates a polyline from the given coordinates.
`Polyline(java.lang.String id, float[][] points, float thickness, Polyline.CapStyle capStyle, Polyline.JoinStyle joinStyle, Polyline.DashStyle dashStyle, float dashOffset, Polyline.ArrowStyle startArrowStyle, Polyline.ArrowStyle endArrowStyle, boolean closedPath, int color)` Creates a polyline from the given coordinates.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPoint(float x, float y)` Adds a point at the end of polyline points.
`void`	`addPoint(float x, float y, int index)` Adds a point at the given `index`.
`Polyline`	`clone()` Returns a clone of this polyline.
`boolean`	`containsPoint(float x, float y, float margin)` Returns `true` if this polyline contains the point at (`x`, `y`) with a given `margin`.
`Polyline.CapStyle`	`getCapStyle()` Returns the cap style of this polyline.
`int`	`getColor()` Returns the color of this polyline.
`float`	`getDashOffset()` Returns the offset from which the dash of this polyline should start.
`float[]`	`getDashPattern()` Returns the dash pattern of this polyline in percentage of its thickness.
`Polyline.DashStyle`	`getDashStyle()` Returns the dash style of this polyline.
`float`	`getElevation()` Returns the elevation of this polyline in 3D.
`Polyline.ArrowStyle`	`getEndArrowStyle()` Returns the arrow style at the end of this polyline.
`float`	`getGroundElevation()` Returns the elevation of this polyline from the ground according to the elevation of its level.
`Polyline.JoinStyle`	`getJoinStyle()` Returns the join style of this polyline.
`float`	`getLength()` Returns an approximate length of this polyline.
`Level`	`getLevel()` Returns the level which this polyline belongs to.
`int`	`getPointCount()` Returns the number of points of the polygon matching this polyline.
`int`	`getPointIndexAt(float x, float y, float margin)` Returns the index of the point of this polyline equal to the point at (`x`, `y`) with a given `margin`.
`float[][]`	`getPoints()` Returns the points of the polygon matching this polyline.
`Polyline.ArrowStyle`	`getStartArrowStyle()` Returns the arrow style at the start of this polyline.
`float`	`getThickness()` Returns the thickness of this polyline.
`boolean`	`intersectsRectangle(float x0, float y0, float x1, float y1)` Returns `true` if this polyline intersects with the horizontal rectangle which opposite corners are at points (`x0`, `y0`) and (`x1`, `y1`).
`boolean`	`isAtLevel(Level level)` Returns `true` if this polyline is at the given `level` or at a level with the same elevation and a smaller elevation index.
`boolean`	`isClosedPath()` Returns `true` if the first and last points of this polyline should be joined to form a polygon.
`boolean`	`isVisibleIn3D()` Returns `true` if this polyline should be displayed in 3D.
`void`	`move(float dx, float dy)` Moves this polyline of (`dx`, `dy`) units.
`void`	`removePoint(int index)` Removes the point at the given `index`.
`void`	`setCapStyle(Polyline.CapStyle capStyle)` Sets the cap style of this polyline.
`void`	`setClosedPath(boolean closedPath)` Sets whether the first and last points of this polyline should be joined.
`void`	`setColor(int color)` Sets the color of this polyline.
`void`	`setDashOffset(float dashOffset)` Sets the offset from which the dash of this polyline should start.
`void`	`setDashPattern(float[] dashPattern)` Sets the dash pattern of this polyline in percentage of its thickness.
`void`	`setDashStyle(Polyline.DashStyle dashStyle)` Sets the dash style of this polyline.
`void`	`setElevation(float elevation)` Sets the elevation of this polyline in 3D.
`void`	`setEndArrowStyle(Polyline.ArrowStyle endArrowStyle)` Sets the arrow style at the end of this polyline.
`void`	`setJoinStyle(Polyline.JoinStyle joinStyle)` Sets the join style of this polyline.
`void`	`setLevel(Level level)` Sets the level of this polyline.
`void`	`setPoint(float x, float y, int index)` Sets the point at the given `index`.
`void`	`setPoints(float[][] points)` Sets the points of the polygon matching this polyline.
`void`	`setStartArrowStyle(Polyline.ArrowStyle startArrowStyle)` Sets the arrow style at the start of this polyline.
`void`	`setThickness(float thickness)` Sets the thickness of this polyline.
`void`	`setVisibleIn3D(boolean visibleIn3D)` Sets whether this polyline should be displayed in 3D and fires a `PropertyChangeEvent`.

Methods inherited from class com.eteks.sweethome3d.model.HomeObject
addPropertyChangeListener, addPropertyChangeListener, createId, duplicate, firePropertyChange, getContentProperty, getId, getProperty, getPropertyNames, isContentProperty, removePropertyChangeListener, removePropertyChangeListener, setProperty, setProperty

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Polyline
```
public Polyline(float[][] points)
```
    Creates a polyline from the given coordinates.
  - Polyline
```
public Polyline(java.lang.String id,
                float[][] points)
```
    Creates a polyline from the given coordinates.
    
    Since:
    
    6.4
  - Polyline
```
public Polyline(float[][] points,
                float thickness,
                Polyline.CapStyle capStyle,
                Polyline.JoinStyle joinStyle,
                Polyline.DashStyle dashStyle,
                Polyline.ArrowStyle startArrowStyle,
                Polyline.ArrowStyle endArrowStyle,
                boolean closedPath,
                int color)
```
    Creates a polyline from the given coordinates.
  - Polyline
```
public Polyline(float[][] points,
                float thickness,
                Polyline.CapStyle capStyle,
                Polyline.JoinStyle joinStyle,
                Polyline.DashStyle dashStyle,
                float dashOffset,
                Polyline.ArrowStyle startArrowStyle,
                Polyline.ArrowStyle endArrowStyle,
                boolean closedPath,
                int color)
```
    Creates a polyline from the given coordinates.
    
    Since:
    
    6.0
  - Polyline
```
public Polyline(java.lang.String id,
                float[][] points,
                float thickness,
                Polyline.CapStyle capStyle,
                Polyline.JoinStyle joinStyle,
                Polyline.DashStyle dashStyle,
                float dashOffset,
                Polyline.ArrowStyle startArrowStyle,
                Polyline.ArrowStyle endArrowStyle,
                boolean closedPath,
                int color)
```
    Creates a polyline from the given coordinates.
    
    Since:
    
    6.4
- Method Detail
  - getPoints
```
public float[][] getPoints()
```
    Returns the points of the polygon matching this polyline.
    
    Specified by:
    
    getPoints in interface Selectable
    
    Returns:
    
    an array of the (x,y) coordinates of the polyline points.
  - getPointCount
```
public int getPointCount()
```
    Returns the number of points of the polygon matching this polyline.
  - setPoints
```
public void setPoints(float[][] points)
```
    Sets the points of the polygon matching this polyline. Once this polyline is updated, listeners added to this polyline will receive a change notification.
  - addPoint
```
public void addPoint(float x,
                     float y)
```
    Adds a point at the end of polyline points.
  - addPoint
```
public void addPoint(float x,
                     float y,
                     int index)
```
    Adds a point at the given index.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if index is negative or > getPointCount()
  - setPoint
```
public void setPoint(float x,
                     float y,
                     int index)
```
    Sets the point at the given index.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if index is negative or >= getPointCount()
  - removePoint
```
public void removePoint(int index)
```
    Removes the point at the given index.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if index is negative or >= getPointCount()
  - getThickness
```
public float getThickness()
```
    Returns the thickness of this polyline.
  - setThickness
```
public void setThickness(float thickness)
```
    Sets the thickness of this polyline. Once this polyline is updated, listeners added to this polyline will receive a change notification.
  - getCapStyle
```
public Polyline.CapStyle getCapStyle()
```
    Returns the cap style of this polyline.
  - setCapStyle
```
public void setCapStyle(Polyline.CapStyle capStyle)
```
    Sets the cap style of this polyline. Once this polyline is updated, listeners added to this polyline will receive a change notification.
  - getJoinStyle
```
public Polyline.JoinStyle getJoinStyle()
```
    Returns the join style of this polyline.
  - setJoinStyle
```
public void setJoinStyle(Polyline.JoinStyle joinStyle)
```
    Sets the join style of this polyline. Once this polyline is updated, listeners added to this polyline will receive a change notification.
  - getDashStyle
```
public Polyline.DashStyle getDashStyle()
```
    Returns the dash style of this polyline. If DashStyle.CUSTOMIZED is returned, the actual dash pattern will be returned by getDashPattern().
  - setDashStyle
```
public void setDashStyle(Polyline.DashStyle dashStyle)
```
    Sets the dash style of this polyline. Once this polyline is updated, listeners added to this polyline will receive a change notification.
  - getDashPattern
```
public float[] getDashPattern()
```
    Returns the dash pattern of this polyline in percentage of its thickness.
    
    Since:
    
    6.0
  - setDashPattern
```
public void setDashPattern(float[] dashPattern)
```
    Sets the dash pattern of this polyline in percentage of its thickness. Once this polyline is updated, listeners added to this polyline will receive a change notification.
    
    Since:
    
    6.0
  - getDashOffset
```
public float getDashOffset()
```
    Returns the offset from which the dash of this polyline should start.
    
    Returns:
    
    the offset in percentage of the dash pattern
    
    Since:
    
    6.0
  - setDashOffset
```
public void setDashOffset(float dashOffset)
```
    Sets the offset from which the dash of this polyline should start. Once this polyline is updated, listeners added to this polyline will receive a change notification.
    
    Parameters:
    
    dashOffset - the offset in percentage of the dash pattern
    
    Since:
    
    6.0
  - getStartArrowStyle
```
public Polyline.ArrowStyle getStartArrowStyle()
```
    Returns the arrow style at the start of this polyline.
  - setStartArrowStyle
```
public void setStartArrowStyle(Polyline.ArrowStyle startArrowStyle)
```
    Sets the arrow style at the start of this polyline. Once this polyline is updated, listeners added to this polyline will receive a change notification.
  - getEndArrowStyle
```
public Polyline.ArrowStyle getEndArrowStyle()
```
    Returns the arrow style at the end of this polyline.
  - setEndArrowStyle
```
public void setEndArrowStyle(Polyline.ArrowStyle endArrowStyle)
```
    Sets the arrow style at the end of this polyline. Once this polyline is updated, listeners added to this polyline will receive a change notification.
  - isClosedPath
```
public boolean isClosedPath()
```
    Returns true if the first and last points of this polyline should be joined to form a polygon.
  - setClosedPath
```
public void setClosedPath(boolean closedPath)
```
    Sets whether the first and last points of this polyline should be joined. Once this polyline is updated, listeners added to this polyline will receive a change notification.
  - getColor
```
public int getColor()
```
    Returns the color of this polyline.
  - setColor
```
public void setColor(int color)
```
    Sets the color of this polyline. Once this polyline is updated, listeners added to this polyline will receive a change notification.
  - getGroundElevation
```
public float getGroundElevation()
```
    Returns the elevation of this polyline from the ground according to the elevation of its level.
    
    Since:
    
    6.0
  - getElevation
```
public float getElevation()
```
    Returns the elevation of this polyline in 3D.
    
    Since:
    
    6.0
  - setElevation
```
public void setElevation(float elevation)
```
    Sets the elevation of this polyline in 3D. Once this polyline is updated, listeners added to this polyline will receive a change notification.
    
    Since:
    
    6.0
  - isVisibleIn3D
```
public boolean isVisibleIn3D()
```
    Returns true if this polyline should be displayed in 3D.
    
    Since:
    
    6.0
  - setVisibleIn3D
```
public void setVisibleIn3D(boolean visibleIn3D)
```
    Sets whether this polyline should be displayed in 3D and fires a PropertyChangeEvent.
    
    Since:
    
    6.0
  - getLevel
```
public Level getLevel()
```
    Returns the level which this polyline belongs to.
    
    Specified by:
    
    getLevel in interface Elevatable
  - setLevel
```
public void setLevel(Level level)
```
    Sets the level of this polyline. Once this polyline is updated, listeners added to this polyline will receive a change notification.
  - isAtLevel
```
public boolean isAtLevel(Level level)
```
    Returns true if this polyline is at the given level or at a level with the same elevation and a smaller elevation index.
    
    Specified by:
    
    isAtLevel in interface Elevatable
  - getLength
```
public float getLength()
```
    Returns an approximate length of this polyline.
  - intersectsRectangle
```
public boolean intersectsRectangle(float x0,
                                   float y0,
                                   float x1,
                                   float y1)
```
    Returns true if this polyline intersects with the horizontal rectangle which opposite corners are at points (x0, y0) and (x1, y1).
    
    Specified by:
    
    intersectsRectangle in interface Selectable
  - containsPoint
```
public boolean containsPoint(float x,
                             float y,
                             float margin)
```
    Returns true if this polyline contains the point at (x, y) with a given margin.
    
    Specified by:
    
    containsPoint in interface Selectable
  - getPointIndexAt
```
public int getPointIndexAt(float x,
                           float y,
                           float margin)
```
    Returns the index of the point of this polyline equal to the point at (x, y) with a given margin.
    
    Returns:
    
    the index of the first found point or -1.
  - move
```
public void move(float dx,
                 float dy)
```
    Moves this polyline of (dx, dy) units.
    
    Specified by:
    
    move in interface Selectable
  - clone
```
public Polyline clone()
```
    Returns a clone of this polyline.
    
    Specified by:
    
    clone in interface Selectable
    
    Overrides:
    
    clone in class HomeObject

Class Polyline

Nested Class Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Polyline

Polyline

Polyline

Polyline

Polyline

Method Detail

getPoints

getPointCount

setPoints

addPoint

addPoint

setPoint

removePoint

getThickness

setThickness

getCapStyle

setCapStyle

getJoinStyle

setJoinStyle

getDashStyle

setDashStyle

getDashPattern

setDashPattern

getDashOffset

setDashOffset

getStartArrowStyle

setStartArrowStyle

getEndArrowStyle

setEndArrowStyle

isClosedPath

setClosedPath

getColor

setColor

getGroundElevation

getElevation

setElevation

isVisibleIn3D

setVisibleIn3D

getLevel

setLevel

isAtLevel

getLength

intersectsRectangle

containsPoint

getPointIndexAt

move

clone