Class Envelope

java.lang.Object
org.opentcs.data.model.Envelope
All Implemented Interfaces:
Serializable

public class Envelope extends Object implements Serializable
A sequence of vertices that, when connected in their defined order, represent the area that may be occupied by an object.

Since an envelope represents a closed geometry, it is expected that the last vertex matches the first one.

Note that an envelope with less than four vertices is not reasonable, since it cannot span a two-dimensional plane. Such envelopes are therefore considered empty.

See Also:
  • Constructor Details

    • Envelope

      public Envelope(@Nonnull List<Couple> vertices)
      Creates a new instance.
      Parameters:
      vertices - The sequence of vertices the envelope consists of.
      Throws:
      IllegalArgumentException - If the sequence of vertices is empty or if the last vertext in the sequence does not match the first one.
  • Method Details

    • getVertices

      public List<Couple> getVertices()
      Returns the sequence of vertices the envelope consists of.
      Returns:
      The sequence of vertices the envelope consists of.
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object