Package com.luciad.view.lightspeed.style.complexstroke

Class ALspComplexStroke.WaveBuilder

java.lang.Object
com.luciad.view.lightspeed.style.complexstroke.ALspComplexStroke.WaveBuilder
Enclosing class:
ALspComplexStroke
public static class ALspComplexStroke.WaveBuilder extends Object
Used to build wave strokes. For more information, see ALspComplexStroke.wave() and ALspComplexStroke.filledWave().
Since:
2013.1

  • Method Details

    • length

      public ALspComplexStroke.WaveBuilder length(double aLength)
      Sets the length of this stroke, in pixels. The default is 10. Note that when this method is called, the value set using lengthRelative is ignored.
      Parameters:
      aLength - the length of this stroke, in pixels
      Returns:
      this

    • lengthRelative

      public ALspComplexStroke.WaveBuilder lengthRelative(double aLengthRelative)
      Sets the length of this stroke, as a value relative to the length of the line. The default is 0. Note that when this method is called, the value set using length is ignored.
      Parameters:
      aLengthRelative - a length, defined relative ([0, 1]) to the length of the entire line, representing the part of the line occupied by this gap.
      Returns:
      this

    • amplitude

      public ALspComplexStroke.WaveBuilder amplitude(double aAmplitude)
      Sets the amplitude of this stroke. This is a value in pixels, relative to the base line.
      Parameters:
      aAmplitude - the amplitude
      Returns:
      this

    • lineWidth

      public ALspComplexStroke.WaveBuilder lineWidth(double aLineWidth)
      Sets the line width. The default is 1.
      Parameters:
      aLineWidth - the line width.
      Returns:
      this

    • lineColor

      public ALspComplexStroke.WaveBuilder lineColor(Color aLineColor)
      Sets the line color.
      Parameters:
      aLineColor - the line color
      Returns:
      this

    • lineTexture

      public ALspComplexStroke.WaveBuilder lineTexture(ILcdIcon aTextureIcon)

      Specifies an icon that is used to retrieve the line color. This texture icon is sampled in view space, i.e. one pixel of the icon corresponds with one pixel on the screen. If a line color is set as well, that color is used as a modulation color. For best results, the given icon should be tileable, see for example TLcdGXYHatchedFillStyle.asIcon().

      Parameters:
      aTextureIcon - a texture icon
      Returns:
      this

    • fillColor

      public ALspComplexStroke.WaveBuilder fillColor(Color aFillColor)
      Sets the fill color. This color is used for every pixel in between the wave and the base line.
      Parameters:
      aFillColor - the fill color.
      Returns:
      this

    • fillTexture

      public ALspComplexStroke.WaveBuilder fillTexture(ILcdIcon aTextureIcon)

      Specifies an icon that is used to retrieve the fill color. This texture icon is sampled in view space, i.e. one pixel of the icon corresponds with one pixel on the screen. If a fill color is set as well, that color is used as a modulation color. For best results, the given icon should be tileable, see for example TLcdGXYHatchedFillStyle.asIcon().

      When using a textured fill along the entire stroked line, it may be useful to change the sharp angle threshold. This makes it possible to avoid gaps or overlapping regions between line segments.

      Parameters:
      aTextureIcon - a texture icon
      Returns:
      this

    • startAngle

      public ALspComplexStroke.WaveBuilder startAngle(double aStartAngle)
      Sets the start angle of the wave, in degrees.
      Parameters:
      aStartAngle - the start angle, in degrees.
      Returns:
      this

    • angle

      public ALspComplexStroke.WaveBuilder angle(double aAngle)
      Sets the angle of the wave, in degrees.
      Parameters:
      aAngle - the angle of the wave, in degrees.
      Returns:
      this

    • build

      public ALspComplexStroke build()
      Returns a new wave stroke
      Returns:
      a new wave stroke