com.eteks.sweethome3d.model

Class DimensionLine

java.lang.Object

com.eteks.sweethome3d.model.HomeObject

com.eteks.sweethome3d.model.DimensionLine

All Implemented Interfaces:

Elevatable, Selectable, java.io.Serializable, java.lang.Cloneable

public class DimensionLine
extends HomeObject
implements Selectable, Elevatable

A dimension line in plan.

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DimensionLine.Property The properties of a dimension line that may change.

Constructor Summary

Constructors

Constructor and Description
DimensionLine(float xStart, float yStart, float xEnd, float yEnd, float offset) Creates a dimension line from (xStart, yStart) to (xEnd, yEnd), with a given offset.
DimensionLine(float xStart, float yStart, float elevationStart, float xEnd, float yEnd, float elevationEnd, float offset) Creates a dimension line from (xStart, yStart, elevationStart) to (xEnd, yEnd, elevationEnd), with a given offset.
DimensionLine(java.lang.String id, float xStart, float yStart, float xEnd, float yEnd, float offset) Creates a dimension line from (xStart,yStart) to (xEnd, yEnd), with a given offset.
DimensionLine(java.lang.String id, float xStart, float yStart, float elevationStart, float xEnd, float yEnd, float elevationEnd, float offset) Creates a dimension line from (xStart, yStart, elevationStart) to (xEnd, yEnd, elevationEnd), with a given offset.

Method Summary

Modifier and Type	Method and Description
DimensionLine	clone() Returns a clone of this dimension line.
boolean	containsEndExtensionLineAt(float x, float y, float margin) Returns true if the extension line at the end of this dimension line contains the point at (x, y) with a given margin around the extension line.
boolean	containsPoint(float x, float y, float margin) Returns true if this dimension line contains the point at (x, y) with a given margin.
boolean	containsStartExtensionLinetAt(float x, float y, float margin) Returns true if the extension line at the start of this dimension line contains the point at (x, y) with a given margin around the extension line.
java.lang.Integer	getColor() Returns the color used to display the text of this dimension line.
float	getElevationEnd() Returns the end point elevation of this dimension line.
float	getElevationStart() Returns the start point elevation of this dimension line.
float	getEndMarkSize() Returns the size of marks drawn at the end of the dimension line.
float	getLength() Returns the length of this dimension line.
TextStyle	getLengthStyle() Returns the text style used to display dimension line length.
Level	getLevel() Returns the level which this dimension line belongs to.
float	getOffset() Returns the offset of this dimension line.
float	getPitch() Returns the pitch angle in radians of this dimension line around its axis.
float[][]	getPoints() Returns the points of the rectangle surrounding this dimension line and its extension lines.
float	getXEnd() Returns the end point abscissa of this dimension line.
float	getXStart() Returns the start point abscissa of this dimension line.
float	getYEnd() Returns the end point ordinate of this dimension line.
float	getYStart() Returns the start point ordinate of this dimension line.
boolean	intersectsRectangle(float x0, float y0, float x1, float y1) Returns true if this dimension line intersects with the horizontal rectangle which opposite corners are at points (x0, y0) and (x1, y1).
boolean	isAtLevel(Level level) Returns true if this dimension line is at the given level or at a level with the same elevation and a smaller elevation index or if the elevation of its highest end is higher than level elevation.
boolean	isBottomPointAt(float x, float y, float margin) Returns true if the bottom left point of this dimension line is the point at (x, y) with a given margin.
boolean	isElevationDimensionLine() Returns true if this dimension line is an elevation (vertical) dimension line.
boolean	isLeftPointAt(float x, float y, float margin) Returns true if the left point of this dimension line is the point at (x, y) with a given margin.
boolean	isMiddlePointAt(float x, float y, float margin) Returns true if the middle point of this dimension line is the point at (x, y) with a given margin.
boolean	isRightPointAt(float x, float y, float margin) Returns true if the right point of this dimension line is the point at (x, y) with a given margin.
boolean	isTopPointAt(float x, float y, float margin) Returns true if the top point of this dimension line is the point at (x, y) with a given margin.
boolean	isVisibleIn3D() Returns true if this dimension line should be displayed in 3D.
void	move(float dx, float dy) Moves this dimension line of (dx, dy) units.
void	setColor(java.lang.Integer color) Sets the color used to display the text of this dimension line.
void	setElevationEnd(float elevationEnd) Sets the end point elevation of this dimension line.
void	setElevationStart(float elevationStart) Sets the start point elevation of this dimension line.
void	setEndMarkSize(float endMarkSize) Sets the size of marks drawn at the end of the dimension line.
void	setLengthStyle(TextStyle lengthStyle) Sets the text style used to display dimension line length.
void	setLevel(Level level) Sets the level of this dimension line.
void	setOffset(float offset) Sets the offset of this dimension line.
void	setPitch(float pitch) Sets the pitch angle of this dimension line.
void	setVisibleIn3D(boolean visibleIn3D) Sets whether this dimension line should be displayed in 3D.
void	setXEnd(float xEnd) Sets the end point abscissa of this dimension line.
void	setXStart(float xStart) Sets the start point abscissa of this dimension line.
void	setYEnd(float yEnd) Sets the end point ordinate of this dimension line.
void	setYStart(float yStart) Sets the start point ordinate of this dimension line.

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

DimensionLine

public DimensionLine(float xStart,
                     float yStart,
                     float xEnd,
                     float yEnd,
                     float offset)

Creates a dimension line from (xStart, yStart) to (xEnd, yEnd), with a given offset.

DimensionLine

public DimensionLine(float xStart,
                     float yStart,
                     float elevationStart,
                     float xEnd,
                     float yEnd,
                     float elevationEnd,
                     float offset)

Creates a dimension line from (xStart, yStart, elevationStart) to (xEnd, yEnd, elevationEnd), with a given offset.

Since:

7.2

DimensionLine

public DimensionLine(java.lang.String id,
                     float xStart,
                     float yStart,
                     float xEnd,
                     float yEnd,
                     float offset)

Creates a dimension line from (xStart,yStart) to (xEnd, yEnd), with a given offset.

Since:

6.4

DimensionLine

public DimensionLine(java.lang.String id,
                     float xStart,
                     float yStart,
                     float elevationStart,
                     float xEnd,
                     float yEnd,
                     float elevationEnd,
                     float offset)

Creates a dimension line from (xStart, yStart, elevationStart) to (xEnd, yEnd, elevationEnd), with a given offset.

Since:

7.2

Method Detail

getXStart

public float getXStart()

Returns the start point abscissa of this dimension line.

setXStart

public void setXStart(float xStart)

Sets the start point abscissa of this dimension line. Once this dimension line is updated, listeners added to this dimension line will receive a change notification.

getYStart

public float getYStart()

Returns the start point ordinate of this dimension line.

setYStart

public void setYStart(float yStart)

Sets the start point ordinate of this dimension line. Once this dimension line is updated, listeners added to this dimension line will receive a change notification.

getElevationStart

public float getElevationStart()

Returns the start point elevation of this dimension line.

Since:

7.2

setElevationStart

public void setElevationStart(float elevationStart)

Sets the start point elevation of this dimension line. Once this dimension line is updated, listeners added to this dimension line will receive a change notification.

Since:

7.2

getXEnd

public float getXEnd()

Returns the end point abscissa of this dimension line.

setXEnd

public void setXEnd(float xEnd)

Sets the end point abscissa of this dimension line. Once this dimension line is updated, listeners added to this dimension line will receive a change notification.

getYEnd

public float getYEnd()

Returns the end point ordinate of this dimension line.

setYEnd

public void setYEnd(float yEnd)

Sets the end point ordinate of this dimension line. Once this dimension line is updated, listeners added to this dimension line will receive a change notification.

getElevationEnd

public float getElevationEnd()

Returns the end point elevation of this dimension line.

Since:

7.2

setElevationEnd

public void setElevationEnd(float elevationEnd)

Sets the end point elevation of this dimension line. Once this dimension line is updated, listeners added to this dimension line will receive a change notification.

Since:

7.2

isElevationDimensionLine

public boolean isElevationDimensionLine()

Returns true if this dimension line is an elevation (vertical) dimension line.

Since:

7.2

getOffset

public float getOffset()

Returns the offset of this dimension line.

setOffset

public void setOffset(float offset)

Sets the offset of this dimension line. Once this dimension line is updated, listeners added to this dimension line will receive a change notification.

getPitch

public float getPitch()

Returns the pitch angle in radians of this dimension line around its axis.

Since:

7.2

setPitch

public void setPitch(float pitch)

Sets the pitch angle of this dimension line. Once this dimension line is updated, listeners added to this dimension line will receive a change notification.

Since:

7.2

getLength

public float getLength()

Returns the length of this dimension line.

getLengthStyle

public TextStyle getLengthStyle()

Returns the text style used to display dimension line length.

setLengthStyle

public void setLengthStyle(TextStyle lengthStyle)

Sets the text style used to display dimension line length. Once this dimension line is updated, listeners added to it will receive a change notification.

getColor

public java.lang.Integer getColor()

Returns the color used to display the text of this dimension line.

Since:

7.2

setColor

public void setColor(java.lang.Integer color)

Sets the color used to display the text of this dimension line. Once this dimension line is updated, listeners added to this dimension line will receive a change notification.

Since:

7.2

getEndMarkSize

public float getEndMarkSize()

Returns the size of marks drawn at the end of the dimension line.

Since:

7.2

setEndMarkSize

public void setEndMarkSize(float endMarkSize)

Sets the size of marks drawn at the end of the dimension line.

Since:

7.2

isVisibleIn3D

public boolean isVisibleIn3D()

Returns true if this dimension line should be displayed in 3D.

Since:

7.2

setVisibleIn3D

public void setVisibleIn3D(boolean visibleIn3D)

Sets whether this dimension line should be displayed in 3D. Once this dimension line is updated, listeners added to this dimension line will receive a change notification.

Since:

7.2

getLevel

public Level getLevel()

Returns the level which this dimension line belongs to.

Specified by:

getLevel in interface Elevatable

Since:

3.4

setLevel

public void setLevel(Level level)

Sets the level of this dimension line. Once this dimension line is updated, listeners added to this dimension line will receive a change notification.

Since:

3.4

isAtLevel

public boolean isAtLevel(Level level)

Returns true if this dimension line is at the given level or at a level with the same elevation and a smaller elevation index or if the elevation of its highest end is higher than level elevation.

Specified by:

isAtLevel in interface Elevatable

Since:

3.4

getPoints

public float[][] getPoints()

Returns the points of the rectangle surrounding this dimension line and its extension lines.

Specified by:

getPoints in interface Selectable

Returns:

an array of the 4 (x,y) coordinates of the rectangle.

intersectsRectangle

public boolean intersectsRectangle(float x0,
                                   float y0,
                                   float x1,
                                   float y1)

Returns true if this dimension line 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 dimension line contains the point at (x, y) with a given margin.

Specified by:

containsPoint in interface Selectable

isMiddlePointAt

public boolean isMiddlePointAt(float x,
                               float y,
                               float margin)

Returns true if the middle point of this dimension line is the point at (x, y) with a given margin.

containsStartExtensionLinetAt

public boolean containsStartExtensionLinetAt(float x,
                                             float y,
                                             float margin)

Returns true if the extension line at the start of this dimension line contains the point at (x, y) with a given margin around the extension line.

containsEndExtensionLineAt

public boolean containsEndExtensionLineAt(float x,
                                          float y,
                                          float margin)

Returns true if the extension line at the end of this dimension line contains the point at (x, y) with a given margin around the extension line.

isTopPointAt

public boolean isTopPointAt(float x,
                            float y,
                            float margin)

Returns true if the top point of this dimension line is the point at (x, y) with a given margin.

Since:

7.2

isRightPointAt

public boolean isRightPointAt(float x,
                              float y,
                              float margin)

Returns true if the right point of this dimension line is the point at (x, y) with a given margin.

Since:

7.2

isBottomPointAt

public boolean isBottomPointAt(float x,
                               float y,
                               float margin)

Returns true if the bottom left point of this dimension line is the point at (x, y) with a given margin.

Since:

7.2

isLeftPointAt

public boolean isLeftPointAt(float x,
                             float y,
                             float margin)

Returns true if the left point of this dimension line is the point at (x, y) with a given margin.

Since:

7.2

move

public void move(float dx,
                 float dy)

Moves this dimension line of (dx, dy) units.

Specified by:

move in interface Selectable

clone

public DimensionLine clone()

Returns a clone of this dimension line.

Specified by:

clone in interface Selectable

Overrides:

clone in class HomeObject