Package com.luciad.maps.effects

Class BloomModel.Builder

java.lang.Object
com.luciad.maps.effects.BloomModel.Builder
All Implemented Interfaces:
AutoCloseable
Enclosing class:
BloomModel
public static final class BloomModel.Builder extends Object implements AutoCloseable
A builder class for creating bloom models.

  • Constructor Details

    • Builder

      public Builder(@NotNull BloomModel.Builder other)
      Copy constructor.
      Parameters:
      other - the builder to copy.

  • Method Details

    • finalize

      protected void finalize()
      Overrides:
      finalize in class Object

    • close

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

    • build

      @NotNull public BloomModel build()
      Returns a newly created bloom model, based on the properties set on this builder.
      Returns:
      a newly created bloom model.

    • strength

      @NotNull public BloomModel.Builder strength(double strength) throws IllegalArgumentException
      Sets the bloom strength.

      The strength is a non-negative number to make the bloom effect more or less pronounced.

      This method is optional. By default, it is 1.

      Parameters:
      strength - the bloom strength.
      Returns:
      this builder.
      Throws:
      IllegalArgumentException - if the strength is negative.

    • softness

      @NotNull public BloomModel.Builder softness(double softness) throws IllegalArgumentException
      Sets the bloom softness.

      The softness is a value in the [0, 1] range that determines how focused or spread out the bloom effect should be. Lower values produce a more concentrated bloom. Higher values produce a more diffuse bloom.

      This method is optional. By default, it is 0.5.

      Parameters:
      softness - the bloom softness.
      Throws:
      IllegalArgumentException - if the softness is not in [0, 1].