Package com.luciad.layers.styles.complexstrokes.builders

Class LinePatternBuilder

java.lang.Object
com.luciad.layers.styles.complexstrokes.builders.LinePatternBuilder
All Implemented Interfaces:
AutoCloseable
public final class LinePatternBuilder extends Object implements AutoCloseable
Creates a pattern with a line segment shape.
Since:
2023.1
See Also:

  • Method Details

    • finalize

      protected void finalize()
      Overrides:
      finalize in class Object

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable

    • build

      @NotNull public ComplexStrokePattern build()
      Build the line pattern as configured.
      Returns:
      the ComplexStrokePattern.

    • fixedLength

      @NotNull public LinePatternBuilder fixedLength(double fixedLength) throws IllegalArgumentException
      Set the length of the pattern in pixels.

      The length cannot be both fixed and relative, if both methods are used, only the last one affects the result.

      If no length is set, a 10 pixel fixed length will be used as default.

      Parameters:
      fixedLength - the length in pixels.
      Returns:
      this builder.
      Throws:
      IllegalArgumentException - fixedLength must be >=0.

    • relativeLength

      @NotNull public LinePatternBuilder relativeLength(double relativeLength) throws IllegalArgumentException
      Set the length of the pattern relative to the length of the entire line, as a value between 0 and 1.

      The length cannot be both fixed and relative, if both methods are used, only the last one affects the result.

      If no length is set, a 10 pixel fixed length will be used as default.

      Parameters:
      relativeLength - a value in [0,1].
      Returns:
      this builder.
      Throws:
      IllegalArgumentException - relativeLength must be in range [0,1].

    • offset0

      @NotNull public LinePatternBuilder offset0(double offset0)
      Sets the offset of the start point of the segment, relative to the base line, in pixels.
      Parameters:
      offset0 - the offset in pixels. Defaults to 0.
      Returns:
      this builder.

    • offset1

      @NotNull public LinePatternBuilder offset1(double offset1)
      Sets the offset of the end point of the segment, relative to the base line, in pixels.
      Parameters:
      offset1 - the offset in pixels. Defaults to 0.
      Returns:
      this builder.

    • lineWidth

      @NotNull public LinePatternBuilder lineWidth(double lineWidth) throws IllegalArgumentException
      Sets the line width.
      Parameters:
      lineWidth - the line's width, defaults to 1.
      Returns:
      this builder.
      Throws:
      IllegalArgumentException - lineWidth must be >0.

    • lineColor

      @NotNull public LinePatternBuilder lineColor(@NotNull android.graphics.Color color)
      Sets the line color.
      Parameters:
      color - the line's color, defaults to black.
      Returns:
      this builder.

    • fillColor

      @NotNull public LinePatternBuilder fillColor(@NotNull android.graphics.Color color)
      Sets the fill color.
      Parameters:
      color - the fill color, by default there is no fill.
      Returns:
      this builder.