org.opentcs.data.model.visualization.VisualLayout Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.data.model.visualization;

import java.io.Serializable;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import static java.util.Objects.requireNonNull;
import java.util.Set;
import org.opentcs.data.ObjectHistory;
import org.opentcs.data.TCSObject;
import org.opentcs.util.annotations.ScheduledApiChange;

/**
 * Describes the visual attributes of a model.
 *
 * @author Stefan Walter (Fraunhofer IML)
 */
public class VisualLayout
    extends TCSObject
    implements Serializable {

  /**
   * This layout's scale on the X axis (in mm/pixel).
   */
  private final double scaleX;
  /**
   * This layout's scale on the Y axis (in mm/pixel).
   */
  private final double scaleY;
  /**
   * VisualLayout elements describing the visualization of a model and additional
   * elements that need to be displayed.
   */
  @Deprecated
  private final Set layoutElements;
  /**
   * The layers in this model.
   */
  private final List layers;
  /**
   * The layer groups in this model.
   */
  private final List layerGroups;

  /**
   * Creates a new VisualLayout.
   *
   * @param name This visual layout's name.
   */
  public VisualLayout(String name) {
    super(name);
    this.scaleX = 50.0;
    this.scaleY = 50.0;
    this.layoutElements = new HashSet<>();
    this.layers = new LinkedList<>();
    this.layerGroups = new LinkedList<>();
  }

  /**
   * Creates a new VisualLayout.
   *
   * @param name This visual layout's name.
   */
  @SuppressWarnings("deprecation")
  private VisualLayout(String name,
                       Map properties,
                       ObjectHistory history,
                       double scaleX,
                       double scaleY,
                       Set layoutElements,
                       List layers,
                       List layerGroups) {
    super(name, properties, history);
    this.scaleX = scaleX;
    this.scaleY = scaleY;
    this.layoutElements = new HashSet<>(requireNonNull(layoutElements, "layoutElements"));
    this.layers = new LinkedList<>(requireNonNull(layers, "layers"));
    this.layerGroups = new LinkedList<>(requireNonNull(layerGroups, "layerGroups"));
  }

  @Override
  public VisualLayout withProperty(String key, String value) {
    return new VisualLayout(getName(),
                            propertiesWith(key, value),
                            getHistory(),
                            scaleX,
                            scaleY,
                            layoutElements,
                            layers,
                            layerGroups);
  }

  @Override
  public VisualLayout withProperties(Map properties) {
    return new VisualLayout(getName(),
                            properties,
                            getHistory(),
                            scaleX,
                            scaleY,
                            layoutElements,
                            layers,
                            layerGroups);
  }

  @Override
  public TCSObject withHistoryEntry(ObjectHistory.Entry entry) {
    return new VisualLayout(getName(),
                            getProperties(),
                            getHistory().withEntryAppended(entry),
                            scaleX,
                            scaleY,
                            layoutElements,
                            layers,
                            layerGroups);
  }

  @Override
  public TCSObject withHistory(ObjectHistory history) {
    return new VisualLayout(getName(),
                            getProperties(),
                            history,
                            scaleX,
                            scaleY,
                            layoutElements,
                            layers,
                            layerGroups);
  }

  /**
   * Returns this layout's scale on the X axis (in mm/pixel).
   *
   * @return This layout's scale on the X axis.
   */
  public double getScaleX() {
    return scaleX;
  }

  /**
   * Creates a copy of this object, with the given scaleX.
   *
   * @param scaleX The value to be set in the copy.
   * @return A copy of this object, differing in the given value.
   */
  public VisualLayout withScaleX(double scaleX) {
    return new VisualLayout(getName(),
                            getProperties(),
                            getHistory(),
                            scaleX,
                            scaleY,
                            layoutElements,
                            layers,
                            layerGroups);
  }

  /**
   * Returns this layout's scale on the Y axis (in mm/pixel).
   *
   * @return This layout's scale on the Y axis.
   */
  public double getScaleY() {
    return scaleY;
  }

  /**
   * Creates a copy of this object, with the given scaleY.
   *
   * @param scaleY The value to be set in the copy.
   * @return A copy of this object, differing in the given value.
   */
  public VisualLayout withScaleY(double scaleY) {
    return new VisualLayout(getName(),
                            getProperties(),
                            getHistory(),
                            scaleX,
                            scaleY,
                            layoutElements,
                            layers,
                            layerGroups);
  }

  /**
   * Returns the layout elements describing the visualization of a model.
   *
   * @return The layout elements describing the visualization of a model.
   */
  @Deprecated
  @ScheduledApiChange(details = "Will be removed.", when = "6.0")
  public Set getLayoutElements() {
    return layoutElements;
  }

  /**
   * Creates a copy of this object, with the given layoutElements.
   *
   * @param layoutElements The value to be set in the copy.
   * @return A copy of this object, differing in the given value.
   */
  @Deprecated
  @ScheduledApiChange(details = "Will be removed.", when = "6.0")
  public VisualLayout withLayoutElements(Set layoutElements) {
    return new VisualLayout(getName(),
                            getProperties(),
                            getHistory(),
                            scaleX,
                            scaleY,
                            layoutElements,
                            layers,
                            layerGroups);
  }

  /**
   * Returns the layers of this layout.
   *
   * @return The layers of this layout.
   */
  public List getLayers() {
    return layers;
  }

  /**
   * Creates a copy of this object, with the given layers.
   *
   * @param layers The value to be set in the copy.
   * @return A copy of this object, differing in the given value.
   */
  public VisualLayout withLayers(List layers) {
    return new VisualLayout(getName(),
                            getProperties(),
                            getHistory(),
                            scaleX,
                            scaleY,
                            layoutElements,
                            layers,
                            layerGroups);
  }

  /**
   * Returns the layer groups of this layout.
   *
   * @return The layer groups of this layout.
   */
  public List getLayerGroups() {
    return layerGroups;
  }

  /**
   * Creates a copy of this object, with the given layer groups.
   *
   * @param layerGroups The value to be set in the copy.
   * @return A copy of this object, differing in the given value.
   */
  public VisualLayout withLayerGroups(List layerGroups) {
    return new VisualLayout(getName(),
                            getProperties(),
                            getHistory(),
                            scaleX,
                            scaleY,
                            layoutElements,
                            layers,
                            layerGroups);
  }
}