path: root/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/style/layers/HillshadeLayer.java

// This file is generated. Edit android/platform/scripts/generate-style-code.js, then run `make android-style-code`.

package com.mapbox.mapboxsdk.style.layers;

import android.support.annotation.ColorInt;
import android.support.annotation.NonNull;
import android.support.annotation.UiThread;

import static com.mapbox.mapboxsdk.utils.ColorUtils.rgbaToColor;

import com.mapbox.mapboxsdk.style.layers.TransitionOptions;

/**
 * Client-side hillshading visualization based on DEM data. Currently, the implementation only supports Mapbox Terrain RGB and Mapzen Terrarium tiles.
 *
 * @see <a href="https://www.mapbox.com/mapbox-gl-style-spec/#layers-hillshade">The online documentation</a>
 */
@UiThread
public class HillshadeLayer extends Layer {

  /**
   * Creates a HillshadeLayer.
   *
   * @param nativePtr pointer used by core
   */
  public HillshadeLayer(long nativePtr) {
    super(nativePtr);
  }

  /**
   * Creates a HillshadeLayer.
   *
   * @param layerId  the id of the layer
   * @param sourceId the id of the source
   */
  public HillshadeLayer(String layerId, String sourceId) {
    initialize(layerId, sourceId);
  }

  protected native void initialize(String layerId, String sourceId);

  /**
   * Set the source layer.
   *
   * @param sourceLayer the source layer to set
   */
  public void setSourceLayer(String sourceLayer) {
    nativeSetSourceLayer(sourceLayer);
  }

  /**
   * Set the source Layer.
   *
   * @param sourceLayer the source layer to set
   * @return This
   */
  public HillshadeLayer withSourceLayer(String sourceLayer) {
    setSourceLayer(sourceLayer);
    return this;
  }

  /**
   * Set a property or properties.
   *
   * @param properties the var-args properties
   * @return This
   */
  public HillshadeLayer withProperties(@NonNull PropertyValue<?>... properties) {
    setProperties(properties);
    return this;
  }

  // Property getters

  /**
   * Get the HillshadeIlluminationDirection property
   *
   * @return property wrapper value around Float
   */
  @SuppressWarnings("unchecked")
  public PropertyValue<Float> getHillshadeIlluminationDirection() {
    return (PropertyValue<Float>) new PropertyValue("hillshade-illumination-direction", nativeGetHillshadeIlluminationDirection());
  }

  /**
   * Get the HillshadeIlluminationAnchor property
   *
   * @return property wrapper value around String
   */
  @SuppressWarnings("unchecked")
  public PropertyValue<String> getHillshadeIlluminationAnchor() {
    return (PropertyValue<String>) new PropertyValue("hillshade-illumination-anchor", nativeGetHillshadeIlluminationAnchor());
  }

  /**
   * Get the HillshadeExaggeration property
   *
   * @return property wrapper value around Float
   */
  @SuppressWarnings("unchecked")
  public PropertyValue<Float> getHillshadeExaggeration() {
    return (PropertyValue<Float>) new PropertyValue("hillshade-exaggeration", nativeGetHillshadeExaggeration());
  }

  /**
   * Get the HillshadeExaggeration property transition options
   *
   * @return transition options for Float
   */
  public TransitionOptions getHillshadeExaggerationTransition() {
    return nativeGetHillshadeExaggerationTransition();
  }

  /**
   * Set the HillshadeExaggeration property transition options
   *
   * @param options transition options for Float
   */
  public void setHillshadeExaggerationTransition(TransitionOptions options) {
    nativeSetHillshadeExaggerationTransition(options.getDuration(), options.getDelay());
  }

  /**
   * Get the HillshadeShadowColor property
   *
   * @return property wrapper value around String
   */
  @SuppressWarnings("unchecked")
  public PropertyValue<String> getHillshadeShadowColor() {
    return (PropertyValue<String>) new PropertyValue("hillshade-shadow-color", nativeGetHillshadeShadowColor());
  }

  /**
   * The shading color of areas that face away from the light source.
   *
   * @return int representation of a rgba string color
   * @throws RuntimeException thrown if property isn't a value
   */
  @ColorInt
  public int getHillshadeShadowColorAsInt() {
    PropertyValue<String> value = getHillshadeShadowColor();
    if (value.isValue()) {
      return rgbaToColor(value.getValue());
    } else {
      throw new RuntimeException("hillshade-shadow-color was set as a Function");
    }
  }

  /**
   * Get the HillshadeShadowColor property transition options
   *
   * @return transition options for String
   */
  public TransitionOptions getHillshadeShadowColorTransition() {
    return nativeGetHillshadeShadowColorTransition();
  }

  /**
   * Set the HillshadeShadowColor property transition options
   *
   * @param options transition options for String
   */
  public void setHillshadeShadowColorTransition(TransitionOptions options) {
    nativeSetHillshadeShadowColorTransition(options.getDuration(), options.getDelay());
  }

  /**
   * Get the HillshadeHighlightColor property
   *
   * @return property wrapper value around String
   */
  @SuppressWarnings("unchecked")
  public PropertyValue<String> getHillshadeHighlightColor() {
    return (PropertyValue<String>) new PropertyValue("hillshade-highlight-color", nativeGetHillshadeHighlightColor());
  }

  /**
   * The shading color of areas that faces towards the light source.
   *
   * @return int representation of a rgba string color
   * @throws RuntimeException thrown if property isn't a value
   */
  @ColorInt
  public int getHillshadeHighlightColorAsInt() {
    PropertyValue<String> value = getHillshadeHighlightColor();
    if (value.isValue()) {
      return rgbaToColor(value.getValue());
    } else {
      throw new RuntimeException("hillshade-highlight-color was set as a Function");
    }
  }

  /**
   * Get the HillshadeHighlightColor property transition options
   *
   * @return transition options for String
   */
  public TransitionOptions getHillshadeHighlightColorTransition() {
    return nativeGetHillshadeHighlightColorTransition();
  }

  /**
   * Set the HillshadeHighlightColor property transition options
   *
   * @param options transition options for String
   */
  public void setHillshadeHighlightColorTransition(TransitionOptions options) {
    nativeSetHillshadeHighlightColorTransition(options.getDuration(), options.getDelay());
  }

  /**
   * Get the HillshadeAccentColor property
   *
   * @return property wrapper value around String
   */
  @SuppressWarnings("unchecked")
  public PropertyValue<String> getHillshadeAccentColor() {
    return (PropertyValue<String>) new PropertyValue("hillshade-accent-color", nativeGetHillshadeAccentColor());
  }

  /**
   * The shading color used to accentuate rugged terrain like sharp cliffs and gorges.
   *
   * @return int representation of a rgba string color
   * @throws RuntimeException thrown if property isn't a value
   */
  @ColorInt
  public int getHillshadeAccentColorAsInt() {
    PropertyValue<String> value = getHillshadeAccentColor();
    if (value.isValue()) {
      return rgbaToColor(value.getValue());
    } else {
      throw new RuntimeException("hillshade-accent-color was set as a Function");
    }
  }

  /**
   * Get the HillshadeAccentColor property transition options
   *
   * @return transition options for String
   */
  public TransitionOptions getHillshadeAccentColorTransition() {
    return nativeGetHillshadeAccentColorTransition();
  }

  /**
   * Set the HillshadeAccentColor property transition options
   *
   * @param options transition options for String
   */
  public void setHillshadeAccentColorTransition(TransitionOptions options) {
    nativeSetHillshadeAccentColorTransition(options.getDuration(), options.getDelay());
  }

  private native Object nativeGetHillshadeIlluminationDirection();

  private native Object nativeGetHillshadeIlluminationAnchor();

  private native Object nativeGetHillshadeExaggeration();

  private native TransitionOptions nativeGetHillshadeExaggerationTransition();

  private native void nativeSetHillshadeExaggerationTransition(long duration, long delay);

  private native Object nativeGetHillshadeShadowColor();

  private native TransitionOptions nativeGetHillshadeShadowColorTransition();

  private native void nativeSetHillshadeShadowColorTransition(long duration, long delay);

  private native Object nativeGetHillshadeHighlightColor();

  private native TransitionOptions nativeGetHillshadeHighlightColorTransition();

  private native void nativeSetHillshadeHighlightColorTransition(long duration, long delay);

  private native Object nativeGetHillshadeAccentColor();

  private native TransitionOptions nativeGetHillshadeAccentColorTransition();

  private native void nativeSetHillshadeAccentColorTransition(long duration, long delay);

  @Override
  protected native void finalize() throws Throwable;

}