Package org.opentcs.data.model.visualization

Klasse VisualLayout

java.lang.Object

org.opentcs.data.TCSObject<VisualLayout>

org.opentcs.data.model.visualization.VisualLayout

Alle implementierten Schnittstellen:

Serializable

public class VisualLayout
extends TCSObject<VisualLayout>
implements Serializable

Describes the visual attributes of a model.

Siehe auch:

• Serialisierte Form

Feldübersicht

Von Klasse geerbte Felder org.opentcs.data.TCSObject

reference

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
VisualLayout(String name)	Creates a new VisualLayout.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
List<LayerGroup>	getLayerGroups()	Returns the layer groups of this layout.
List<Layer>	getLayers()	Returns the layers of this layout.
double	getScaleX()	Returns this layout's scale on the X axis (in mm/pixel).
double	getScaleY()	Returns this layout's scale on the Y axis (in mm/pixel).
TCSObject<VisualLayout>	withHistory(ObjectHistory history)	Creates a copy of this object, with the given history.
TCSObject<VisualLayout>	withHistoryEntry(ObjectHistory.Entry entry)	Creates a copy of this object, with the given history entry integrated.
VisualLayout	withLayerGroups(List<LayerGroup> layerGroups)	Creates a copy of this object, with the given layer groups.
VisualLayout	withLayers(List<Layer> layers)	Creates a copy of this object, with the given layers.
VisualLayout	withProperties(Map<String,String> properties)	Creates a copy of this object, with the given properties.
VisualLayout	withProperty(String key, String value)	Creates a copy of this object, with the given property integrated.
VisualLayout	withScaleX(double scaleX)	Creates a copy of this object, with the given scaleX.
VisualLayout	withScaleY(double scaleY)	Creates a copy of this object, with the given scaleY.

Von Klasse geerbte Methoden org.opentcs.data.TCSObject

equals, getHistory, getName, getProperties, getProperty, getReference, hashCode, listWithoutNullValues, mapWithoutNullValues, propertiesWith, setWithoutNullValues, toString

Von Klasse geerbte Methoden java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Konstruktordetails

VisualLayout

public VisualLayout(String name)

Creates a new VisualLayout.

Parameter:

name - This visual layout's name.

Methodendetails

withProperty

public VisualLayout withProperty(String key,
 String value)

Beschreibung aus Klasse kopiert: TCSObject

Creates a copy of this object, with the given property integrated.

Angegeben von:

withProperty in Klasse TCSObject<VisualLayout>

Parameter:

key - The key of the property to be changed.

value - The new value of the property, or null, if the property is to be removed.

Gibt zurück:

A copy of this object, with the given property integrated.

withProperties

public VisualLayout withProperties(Map<String,String> properties)

Beschreibung aus Klasse kopiert: TCSObject

Creates a copy of this object, with the given properties.

Angegeben von:

withProperties in Klasse TCSObject<VisualLayout>

Parameter:

properties - The properties.

Gibt zurück:

A copy of this object, with the given properties.

withHistoryEntry

public TCSObject<VisualLayout> withHistoryEntry(ObjectHistory.Entry entry)

Beschreibung aus Klasse kopiert: TCSObject

Creates a copy of this object, with the given history entry integrated.

Angegeben von:

withHistoryEntry in Klasse TCSObject<VisualLayout>

Parameter:

entry - The history entry to be integrated.

Gibt zurück:

A copy of this object, with the given history entry integrated.

withHistory

public TCSObject<VisualLayout> withHistory(ObjectHistory history)

Beschreibung aus Klasse kopiert: TCSObject

Creates a copy of this object, with the given history.

Angegeben von:

withHistory in Klasse TCSObject<VisualLayout>

Parameter:

history - The history.

Gibt zurück:

A copy of this object, with the given history.

getScaleX

public double getScaleX()

Returns this layout's scale on the X axis (in mm/pixel).

Gibt zurück:

This layout's scale on the X axis.

withScaleX

public VisualLayout withScaleX(double scaleX)

Creates a copy of this object, with the given scaleX.

Parameter:

scaleX - The value to be set in the copy.

Gibt zurück:

A copy of this object, differing in the given value.

getScaleY

public double getScaleY()

Returns this layout's scale on the Y axis (in mm/pixel).

Gibt zurück:

This layout's scale on the Y axis.

withScaleY

public VisualLayout withScaleY(double scaleY)

Creates a copy of this object, with the given scaleY.

Parameter:

scaleY - The value to be set in the copy.

Gibt zurück:

A copy of this object, differing in the given value.

getLayers

public List<Layer> getLayers()

Returns the layers of this layout.

Gibt zurück:

The layers of this layout.

withLayers

public VisualLayout withLayers(List<Layer> layers)

Creates a copy of this object, with the given layers.

Parameter:

layers - The value to be set in the copy.

Gibt zurück:

A copy of this object, differing in the given value.

getLayerGroups

public List<LayerGroup> getLayerGroups()

Returns the layer groups of this layout.

Gibt zurück:

The layer groups of this layout.

withLayerGroups

public VisualLayout withLayerGroups(List<LayerGroup> layerGroups)

Creates a copy of this object, with the given layer groups.

Parameter:

layerGroups - The value to be set in the copy.

Gibt zurück:

A copy of this object, differing in the given value.