Package org.opentcs.data.model
Class Path.Layout
java.lang.Object
org.opentcs.data.model.Path.Layout
- All Implemented Interfaces:
java.io.Serializable
- Enclosing class:
- Path
public static class Path.Layout
extends java.lang.Object
implements java.io.Serializable
Contains information regarding the grahical representation of a path.
- See Also:
- Serialized Form
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPath.Layout.ConnectionTypeThe connection type a path is represented as. -
Constructor Summary
Constructors Constructor Description Layout()Creates a new instance.Layout(Path.Layout.ConnectionType connectionType, java.util.List<Couple> controlPoints, int layerId)Creates a new instance. -
Method Summary
Modifier and Type Method Description Path.Layout.ConnectionTypegetConnectionType()Returns the connection type the path is represented as.java.util.List<Couple>getControlPoints()Returns the control points describing the way the path is drawn.intgetLayerId()Returns the ID of the layer on which the path is to be drawn.Path.LayoutwithConnectionType(Path.Layout.ConnectionType connectionType)Creates a copy of this object, with the given connection type.Path.LayoutwithControlPoints(java.util.List<Couple> controlPoints)Creates a copy of this object, with the given control points.Path.LayoutwithLayer(int layerId)Creates a copy of this object, with the given layer ID.
-
Constructor Details
-
Layout
public Layout()Creates a new instance. -
Layout
public Layout(Path.Layout.ConnectionType connectionType, java.util.List<Couple> controlPoints, int layerId)Creates a new instance.- Parameters:
connectionType- The connection type a path is represented as.controlPoints- Control points describing the way the path is drawn.layerId- The ID of the layer on which the path is to be drawn.
-
-
Method Details
-
getConnectionType
Returns the connection type the path is represented as.- Returns:
- The connection type the path is represented as.
-
withConnectionType
Creates a copy of this object, with the given connection type.- Parameters:
connectionType- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getControlPoints
Returns the control points describing the way the path is drawn. Returns an empty list if connection type is notPath.Layout.ConnectionType.BEZIER,Path.Layout.ConnectionType.BEZIER_3orPath.Layout.ConnectionType.POLYPATH.- Returns:
- The control points describing the way the path is drawn.
-
withControlPoints
Creates a copy of this object, with the given control points.- Parameters:
controlPoints- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getLayerId
public int getLayerId()Returns the ID of the layer on which the path is to be drawn.- Returns:
- The layer ID.
-
withLayer
Creates a copy of this object, with the given layer ID.- Parameters:
layerId- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-