Package de.gurkenlabs.litiengine.sound

Class SoundPlayback.VolumeControl

java.lang.Object
de.gurkenlabs.litiengine.sound.SoundPlayback.VolumeControl
All Implemented Interfaces:
Tweenable
Enclosing class:
SoundPlayback
public class SoundPlayback.VolumeControl
extends java.lang.Object
implements Tweenable
An object for controlling the volume of a SoundPlayback. Each distinct instance represents an independent factor contributing to its volume.
See Also:
SoundPlayback.createVolumeControl()

  • Method Summary

    Modifier and TypeMethodDescription
    protected voidfinalize()
    Deprecated.
    floatget()
    Gets the value of this volume control.
    float[]getTweenValues​(TweenType tweenType)
    Gets one or many values from the target object associated to the given tween type.
    voidset​(float value)
    Sets the value of this volume control.
    voidsetTweenValues​(TweenType tweenType, float[] newValues)
    This method is called in a Tween's update() method to set the new interpolated values.

    Methods inherited from class java.lang.Object

    clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • get

      public float get()
      Gets the value of this volume control.
      Returns:
      The value of this control.

    • set

      public void set​(float value)
      Sets the value of this volume control.
      Parameters:
      value - The value to be set.

    • finalize

      @Deprecated protected void finalize()
      Deprecated.
      Overrides:
      finalize in class java.lang.Object

    • getTweenValues

      public float[] getTweenValues​(TweenType tweenType)
      Description copied from interface: Tweenable
      Gets one or many values from the target object associated to the given tween type. It is used by the Tween Engine to determine starting values.
      Specified by:
      getTweenValues in interface Tweenable
      Parameters:
      tweenType - The tween type of this interpolation, determining which values are modified.
      Returns:
      The array of current tween values.

    • setTweenValues

      public void setTweenValues​(TweenType tweenType, float[] newValues)
      Description copied from interface: Tweenable
      This method is called in a Tween's update() method to set the new interpolated values.
      Specified by:
      setTweenValues in interface Tweenable
      Parameters:
      tweenType - The tween type of this interpolation, determining which values are modified.
      newValues - The new values determined by the tween equation.