com.anylogic.engine.markup

Class NetworkMarkupElement

java.lang.Object

com.anylogic.engine.markup.AbstractMarkup

com.anylogic.engine.markup.MarkupShape

com.anylogic.engine.markup.NetworkMarkupElement

All Implemented Interfaces:

INetworkMarkupElement, SVGElement, java.io.Serializable

Direct Known Subclasses:

Node, PalletRack, Path

@AnyLogicInternalAPI
public abstract class NetworkMarkupElement
extends MarkupShape
implements INetworkMarkupElement

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NetworkMarkupElement()
NetworkMarkupElement(Agent owner, ShapeDrawMode drawMode, boolean isPublic)

Method Summary

Modifier and Type	Method and Description
ShapeDrawMode	getDrawMode() Returns the drawing mode of the shape (where to draw this shape: 2D, 3D or 2D+3D).
double	getNearestPoint(double x, double y, double z, LengthUnits units, Point output) Calculates (using the output object) the point in this space markup element nearest to the given (x, y, z) point.
abstract double	getNearestPoint(double x, double y, double z, Point output) 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, LengthUnits units, Point output) Calculates (using the output object) the point in this space markup element nearest to the given (x, y) point.
abstract double	getNearestPoint(double x, double y, Point output) Calculates (using the output object) the point in this space markup element nearest to the given (x, y) point.
double	getNearestPoint(Point givenPoint, Point out) Calculates (using the output object) the point in this space markup element nearest to the given point.
Network	getNetwork()

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

contains, error, getPresentable, getSpace, initialize, isClickHandled, onClick, setDrawMode, setOwner

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

executeUserAction, findSVGElement, getName, getSVGId, isVisible, resetSVGState, setVisible, updateDynamicProperties, updateSVGProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.anylogic.engine.markup.INetworkMarkupElement

contains, getSpace, randomPointInside, randomPointInside, randomPointInside, randomPointInside

Constructor Detail

NetworkMarkupElement

public NetworkMarkupElement()

NetworkMarkupElement

public NetworkMarkupElement(Agent owner,
                            ShapeDrawMode drawMode,
                            boolean isPublic)

Method Detail

getDrawMode

public ShapeDrawMode getDrawMode()

Description copied from class: MarkupShape

Returns the drawing mode of the shape (where to draw this shape: 2D, 3D or 2D+3D).
If the shape has been created with no-argument constructor, and has no specific limitations (like 2D-only), and drawing mode hasn't yet been set, then it is initialized to default (2D + 3D).

Overrides:

getDrawMode in class MarkupShape

Returns:

the draw mode for this shape

getNearestPoint

public abstract double getNearestPoint(double x,
                                       double y,
                                       Point output)

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).

Parameters:

x - x coordinate of the point

y - y coordinate of the point

output - 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

getNearestPoint

public double getNearestPoint(double x,
                              double y,
                              LengthUnits units,
                              Point output)

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).

Parameters:

x - x coordinate of the point

y - y coordinate of the point

units - the units of length

output - 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

Since:

7.1

getNearestPoint

public abstract double getNearestPoint(double x,
                                       double y,
                                       double z,
                                       Point output)

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.

Parameters:

x - x coordinate of the point

y - y coordinate of the point

z - z coordinate of the point

output - the output point to write result to.

Returns:

the square of distance to the nearest point

getNearestPoint

public double getNearestPoint(double x,
                              double y,
                              double z,
                              LengthUnits units,
                              Point output)

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.

Parameters:

x - x coordinate of the point

y - y coordinate of the point

z - z coordinate of the point

units - the units of length

output - the output point to write result to.

Returns:

the square of distance to the nearest point

Since:

7.1

getNearestPoint

public double getNearestPoint(Point givenPoint,
                              Point out)

Description copied from interface: INetworkMarkupElement

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

Specified by:

getNearestPoint in interface INetworkMarkupElement

Parameters:

givenPoint - given point

out - the output point to write result to.

Returns:

the square of distance to the nearest point

getNetwork

public Network getNetwork()

Specified by:

getNetwork in interface INetworkMarkupElement

Returns:

network this markup element belongs to or null if this element isn't a part of a network