de.lessvoid.nifty.slick2d.loaders.SlickRenderFontLoaders Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nifty-slick2d-renderer Show documentation
Nifty Renderer for Slick2D
There is a newer version: 1.4.3
Show newest version
package de.lessvoid.nifty.slick2d.loaders;

import de.lessvoid.nifty.slick2d.render.font.SlickLoadFontException;
import de.lessvoid.nifty.slick2d.render.font.SlickRenderFont;
import de.lessvoid.nifty.slick2d.render.font.loader.*;
import org.newdawn.slick.Graphics;

import javax.annotation.Nonnull;
import java.util.Iterator;

/**
 * This class is used to trigger the actual font loading. It will query all the font loaders and try to load a font
 * with
 * the specified name.
 *
 * @author Martin Karing <[email protected]>
 */
public final class SlickRenderFontLoaders extends AbstractSlickLoaders {
  /**
   * The singleton instance of this class.
   */
  private static final SlickRenderFontLoaders INSTANCE = new SlickRenderFontLoaders();

  /**
   * Get the singleton instance of this class.
   *
   * @return the singleton instance
   */
  @Nonnull
  public static SlickRenderFontLoaders getInstance() {
    return INSTANCE;
  }

  /**
   * Private constructor so no instances but the singleton instance are created.
   */
  private SlickRenderFontLoaders() {
  }

  /**
   * Add the default implemented loaders to the loader list. This is done automatically in case fonts are requested but
   * no loaders got registered. In general using this function should be avoided. Its better to load only the loaders
   * that are actually needed for your resources.
   *
   * @param order the place where the default loaders are added to the list
   */
  @Override
  public void loadDefaultLoaders(@Nonnull final SlickAddLoaderLocation order) {
    switch (order) {
      case first:
        addLoader(new DefaultSlickRenderFontLoader(), order);
        addLoader(new AngelCodeSlickRenderFontLoader(), order);
        addLoader(new HieroUnicodeSlickRenderFontLoader(), order);
        addLoader(new UnicodeSlickRenderFontLoader(), order);
        break;
      case last:
      case doNotCare:
        addLoader(new UnicodeSlickRenderFontLoader(), order);
        addLoader(new HieroUnicodeSlickRenderFontLoader(), order);
        addLoader(new AngelCodeSlickRenderFontLoader(), order);
        addLoader(new DefaultSlickRenderFontLoader(), order);
        break;
    }
  }

  /**
   * Add the loaders to the loader list that are flagged as deprecated. In general its a bad idea to do this.
   *
   * @param order the place where the deprecated loaders are added to the list
   * @deprecated loads deprecated font loaders
   */
  @Deprecated
  public void loadDeprecatedLoaders(@Nonnull final SlickAddLoaderLocation order) {
    addLoader(new TrueTypeSlickRenderFontLoader(), order);
  }

  /**
   * Load the font with the defined name.
   *
   * @param g        the graphics instance used for rendering
   * @param filename name of the file that contains the font
   * @return the font loaded
   * @throws IllegalArgumentException in case all loaders fail to load the font
   */
  @Nonnull
  @SuppressWarnings("TypeMayBeWeakened")
  public SlickRenderFont loadFont(final Graphics g, final String filename) {
    final Iterator itr = getLoaderIterator();

    while (itr.hasNext()) {
      try {
        return itr.next().loadFont(g, filename);
      } catch (@Nonnull final SlickLoadFontException ignored) {
        // this loader failed... does not matter
      }
    }

    throw new IllegalArgumentException("Failed to load font \"" + filename + "\".");
  }
}