com.anylogic.engine.markup.MarkupSegmentLine

All Implemented Interfaces:: IMarkupSegment, Serializable

public final class MarkupSegmentLine
extends MarkupSegment

Straight markup segment for continuous space.

Author:: AnyLogic North America, LLC https://anylogic.com
See Also:: Serialized Form

Constructor Summary

Constructor	Description
`MarkupSegmentLine()`
`MarkupSegmentLine(double sx, double sy, double sz, double ex, double ey, double ez)`

Method Summary

Modifier and Type	Method	Description
`void`	`addTo(Path2D path)`	Adds this segment to the given path assuming that path is currently positioned on the start point of this segment
`List<Shape>`	`convertToShapes()`	Converts the markup segment into java.awt.geom primitives like `Arc2D` or `Line2D`
`BoundingRectangle`	`getBoundingRectangle()`
`double`	`getDistanceSq(double x, double y)`	For horizontal segments, calculates and returns the square of distance to the point (in the XY-projection).
`double`	`getDistanceSq(double x, double y, double z)`	For horizontal segments, calculates and returns the square of distance to the point (in the XY-projection).
`Position`	`getEnd(Position out)`	Returns the location of the end position of the segment
`double`	`getNearestPoint(double x, double y, double z, Point out)`	Calculates (using the `output` object) the point in this space markup element nearest to the given (x, y, z) point.
`double`	`getNearestPoint(double x, double y, Point out)`	For horizontal segments, calculates (using the `output` object) the point in this space markup element nearest to the given (x, y) point.
`double`	`getNearestPointOnRay2D(double x1, double y1, double x2, double y2, Point out)`	Calculates (and sets in the 'out' object) the point where this segment intersects the given ray with the minimum distance from ray beginning (if there are several intersection points like in arc segments).
`double`	`getOffsetOfPoint(double x, double y)`	Calculates distance by segment to the given point.
`Position`	`getStart(Position out)`	Returns the location of the start position of the segment
`final void`	`initialize()`
`String`	`toString()`

Methods inherited from class com.anylogic.engine.markup.MarkupSegment

getDistanceSq, getEnd, getEndX, getEndY, getEndZ, getNearestPoint, getOffsetFrom2D, getPositionAtOffset, getStart, getStartX, getStartY, getStartZ, length, length2D, setEnd, setEnd, setStart, setStart, setStartNextTo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

MarkupSegmentLine

public MarkupSegmentLine(double sx,
 double sy,
 double sz,
 double ex,
 double ey,
 double ez)

MarkupSegmentLine

public MarkupSegmentLine()

Method Details

getStart

public Position getStart(Position out)

Description copied from class: AbstractMarkupSegment

Returns the location of the start position of the segment

Specified by:: getStart in class AbstractMarkupSegment
Parameters:: out - output object to write to, may be null
Returns:: the Position object with coordinates of the segment start

getEnd

public Position getEnd(Position out)

Description copied from class: AbstractMarkupSegment

Returns the location of the end position of the segment

Specified by:: getEnd in class AbstractMarkupSegment
Parameters:: out - output object to write to, may be null
Returns:: the Position object with coordinates of the segment end

initialize

public final void initialize()

getNearestPoint

public double getNearestPoint(double x,
 double y,
 Point out)

Description copied from class: MarkupSegment

For horizontal segments, calculates (using the output object) the point in this space markup element nearest to the given (x, y) point. Returns the square of distance to the point (in the XY-projection). All the calculations are performed in the horizontal projection (z-coordinates aren't used, as if all of the z coordinates were zero).

Specified by:: getNearestPoint in class MarkupSegment
Parameters:: x - x coordinate of the point; y - y coordinate of the point; out - the output point to write result to. Note that output.z is left unchanged.
Returns:: the square of distance to the nearest point in the horizontal (XY) projection

getDistanceSq

public double getDistanceSq(double x,
 double y)

Description copied from class: MarkupSegment

For horizontal segments, calculates and returns the square of distance to the point (in the XY-projection). All the calculations are performed in the horizontal projection (z-coordinates aren't used, as if all of the z coordinates were zero).

Specified by:: getDistanceSq in class MarkupSegment
Parameters:: x - x coordinate of the point; y - y coordinate of the point
Returns:: the square of distance to the given point in the horizontal (XY) projection

getNearestPoint

public double getNearestPoint(double x,
 double y,
 double z,
 Point out)

Description copied from class: MarkupSegment

Calculates (using the output object) the point in this space markup element nearest to the given (x, y, z) point. Returns the square of distance to the point.

Specified by:: getNearestPoint in class MarkupSegment
Parameters:: x - x coordinate of the point; y - y coordinate of the point; z - z coordinate of the point
Returns:: the square of distance to the nearest point

getDistanceSq

public double getDistanceSq(double x,
 double y,
 double z)

For horizontal segments, calculates and returns the square of distance to the point (in the XY-projection). All the calculations are performed in the horizontal projection (z-coordinates aren't used, as if all of the z coordinates were zero).

Specified by:: getDistanceSq in class MarkupSegment
Parameters:: x - x coordinate of the point; y - y coordinate of the point; z - z coordinate of the point
Returns:: the square of distance to the given point in the horizontal (XY) projection

getNearestPointOnRay2D

public double getNearestPointOnRay2D(double x1,
 double y1,
 double x2,
 double y2,
 Point out)

Description copied from interface: IMarkupSegment

Calculates (and sets in the 'out' object) the point where this segment intersects the given ray with the minimum distance from ray beginning (if there are several intersection points like in arc segments). Returns the square of that distance.
Returns +infinity if there is no intersections.

Parameters:: x1 - the X coordinate of the start point of the ray; y1 - the Y coordinate of the start point of the ray; x2 - the X coordinate of some point on the ray; y2 - the Y coordinate of some point on the ray; out - the Point object to write result to
Returns:: the square of the distance from ray beginning to the nearest intersection point or +infinity if there is no intersections

getOffsetOfPoint

public double getOffsetOfPoint(double x,
 double y)

Description copied from interface: IMarkupSegment

Calculates distance by segment to the given point. Point is specified by a pair of coordinates. The given point should by on this segment.

Parameters:: x - the x coordinate of the given point.
In case of GIS environment this is the latitude of the given point, measured in degrees (-90 ... (South) ... 0 ... (North) ... +90); y - the y coordinate of the given point
In case of GIS environment this is the longitude of the given point, measured in degrees (-180 ... (West) ... 0 ... (East) ... +180)
Returns:: the distance by segment to the given point

addTo

public void addTo(Path2D path)

Description copied from interface: IMarkupSegment

Adds this segment to the given path assuming that path is currently positioned on the start point of this segment

Parameters:: path - the path to add this segment to

toString

public String toString()

Overrides:: toString in class Object

convertToShapes

public List<Shape> convertToShapes()

Description copied from class: MarkupSegment

Converts the markup segment into java.awt.geom primitives like Arc2D or Line2D

Specified by:: convertToShapes in class MarkupSegment
Returns:: the list of primitives that comprise the markup segment

getBoundingRectangle

@AnyLogicInternalAPI
public BoundingRectangle getBoundingRectangle()

Class MarkupSegmentLine

Constructor Summary

Method Summary

Methods inherited from class com.anylogic.engine.markup.MarkupSegment

Methods inherited from class java.lang.Object

Constructor Details

MarkupSegmentLine

MarkupSegmentLine

Method Details

getStart

getEnd

initialize

getNearestPoint

getDistanceSq

getNearestPoint

getDistanceSq

getNearestPointOnRay2D

getOffsetOfPoint

addTo

toString

convertToShapes

getBoundingRectangle