Class VisualLayout
java.lang.Object
- All Implemented Interfaces:
java.io.Serializable
public class VisualLayout extends TCSObject<VisualLayout> implements java.io.Serializable
Describes the visual attributes of a model.
- See Also:
- Serialized Form
-
Field Summary
-
Constructor Summary
Constructors Constructor Description VisualLayout(java.lang.String name)Creates a new VisualLayout. -
Method Summary
Modifier and Type Method Description java.util.List<LayerGroup>getLayerGroups()Returns the layer groups of this layout.java.util.List<Layer>getLayers()Returns the layers of this layout.java.util.Set<LayoutElement>getLayoutElements()Deprecated.doublegetScaleX()Returns this layout's scale on the X axis (in mm/pixel).doublegetScaleY()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.VisualLayoutwithLayerGroups(java.util.List<LayerGroup> layerGroups)Creates a copy of this object, with the given layer groups.VisualLayoutwithLayers(java.util.List<Layer> layers)Creates a copy of this object, with the given layers.VisualLayoutwithLayoutElements(java.util.Set<LayoutElement> layoutElements)Deprecated.VisualLayoutwithProperties(java.util.Map<java.lang.String,java.lang.String> properties)Creates a copy of this object, with the given properties.VisualLayoutwithProperty(java.lang.String key, java.lang.String value)Creates a copy of this object, with the given property integrated.VisualLayoutwithScaleX(double scaleX)Creates a copy of this object, with the given scaleX.VisualLayoutwithScaleY(double scaleY)Creates a copy of this object, with the given scaleY.Methods inherited from class org.opentcs.data.TCSObject
equals, getHistory, getName, getProperties, getProperty, getReference, hashCode, listWithoutNullValues, mapWithoutNullValues, propertiesWith, setWithoutNullValues, toString
-
Constructor Details
-
VisualLayout
public VisualLayout(java.lang.String name)Creates a new VisualLayout.- Parameters:
name- This visual layout's name.
-
-
Method Details
-
withProperty
Description copied from class:TCSObjectCreates a copy of this object, with the given property integrated.- Specified by:
withPropertyin classTCSObject<VisualLayout>- Parameters:
key- The key of the property to be changed.value- The new value of the property, ornull, if the property is to be removed.- Returns:
- A copy of this object, with the given property integrated.
-
withProperties
Description copied from class:TCSObjectCreates a copy of this object, with the given properties.- Specified by:
withPropertiesin classTCSObject<VisualLayout>- Parameters:
properties- The properties.- Returns:
- A copy of this object, with the given properties.
-
withHistoryEntry
Description copied from class:TCSObjectCreates a copy of this object, with the given history entry integrated.- Specified by:
withHistoryEntryin classTCSObject<VisualLayout>- Parameters:
entry- The history entry to be integrated.- Returns:
- A copy of this object, with the given history entry integrated.
-
withHistory
Description copied from class:TCSObjectCreates a copy of this object, with the given history.- Specified by:
withHistoryin classTCSObject<VisualLayout>- Parameters:
history- The history.- Returns:
- 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).- Returns:
- This layout's scale on the X axis.
-
withScaleX
Creates a copy of this object, with the given scaleX.- Parameters:
scaleX- The value to be set in the copy.- Returns:
- 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).- Returns:
- This layout's scale on the Y axis.
-
withScaleY
Creates a copy of this object, with the given scaleY.- Parameters:
scaleY- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getLayoutElements
@Deprecated @ScheduledApiChange(details="Will be removed.", when="6.0") public java.util.Set<LayoutElement> getLayoutElements()Deprecated.Returns the layout elements describing the visualization of a model.- Returns:
- The layout elements describing the visualization of a model.
-
withLayoutElements
@Deprecated @ScheduledApiChange(details="Will be removed.", when="6.0") public VisualLayout withLayoutElements(java.util.Set<LayoutElement> layoutElements)Deprecated.Creates a copy of this object, with the given layoutElements.- Parameters:
layoutElements- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getLayers
Returns the layers of this layout.- Returns:
- The layers of this layout.
-
withLayers
Creates a copy of this object, with the given layers.- Parameters:
layers- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-
getLayerGroups
Returns the layer groups of this layout.- Returns:
- The layer groups of this layout.
-
withLayerGroups
Creates a copy of this object, with the given layer groups.- Parameters:
layerGroups- The value to be set in the copy.- Returns:
- A copy of this object, differing in the given value.
-