Package io.github.ennuil.libzoomer.api

Class ZoomRegistry

java.lang.Object
io.github.ennuil.libzoomer.api.ZoomRegistry
public class ZoomRegistry extends Object
The class responsible for the handling the zoom instance registry.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ZoomRegistry()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Set<ZoomInstance>
    getZoomInstances()
    Gets a set of all registered zoom instances.
    protected static ZoomInstance
    registerInstance(ZoomInstance instance)
    Registers a zoom instance into the internal set of zoom instances.
    static void
    setIterateModifiers(boolean iterateModifiers)
    Sets the state that determines the need for an iteration through all zoom instances with active modifiers.
    static void
    setIterateOverlays(boolean iterateOverlays)
    Sets the state that determines the need for an iteration through all zoom instances with active overlays.
    static void
    setIterateTransitions(boolean iterateTransitions)
    Sets the state that determines the need for an iteration through all zoom instances with active transitions.
    static void
    setIterateZoom(boolean iterateZoom)
    Sets the state that determines the need for an iteration through all active zoom instances.
    static boolean
    shouldIterateModifiers()
    Determines whenever an iteration through all zoom instances with active modifiers is necessary.
    static boolean
    shouldIterateOverlays()
    Determines whenever an iteration through all zoom instances with active overlays is necessary.
    static boolean
    shouldIterateTransitions()
    Determines whenever an iteration through all zoom instances with active transitions is necessary.
    static boolean
    shouldIterateZoom()
    Determines whenever an iteration through all active zoom instances is necessary.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ZoomRegistry

      public ZoomRegistry()

  • Method Details

    • registerInstance

      @Internal protected static ZoomInstance registerInstance(ZoomInstance instance)
      Registers a zoom instance into the internal set of zoom instances. Mandatory in order to make a zoom instance functional.
      Parameters:
      instance - an unregistered zoom instance
      Returns:
      the zoom instance if registered, or null otherwise

    • getZoomInstances

      public static Set<ZoomInstance> getZoomInstances()
      Gets a set of all registered zoom instances.
      Returns:
      a set of all registered zoom instances

    • shouldIterateZoom

      public static boolean shouldIterateZoom()
      Determines whenever an iteration through all active zoom instances is necessary.
      Returns:
      true if an iteration is needed, or false otherwise

    • setIterateZoom

      @Internal public static void setIterateZoom(boolean iterateZoom)
      Sets the state that determines the need for an iteration through all active zoom instances. This is an internal method that shouldn't be used by other mods.
      Parameters:
      iterateZoom - The new iteration state.

    • shouldIterateTransitions

      public static boolean shouldIterateTransitions()
      Determines whenever an iteration through all zoom instances with active transitions is necessary.
      Returns:
      true if an iteration is needed, or false otherwise

    • setIterateTransitions

      @Internal public static void setIterateTransitions(boolean iterateTransitions)
      Sets the state that determines the need for an iteration through all zoom instances with active transitions.

      This is an internal method and shouldn't be used by other mods.

      Parameters:
      iterateTransitions - the new iteration state

    • shouldIterateModifiers

      public static boolean shouldIterateModifiers()
      Determines whenever an iteration through all zoom instances with active modifiers is necessary.
      Returns:
      true if an iteration is needed, or false otherwise

    • setIterateModifiers

      @Internal public static void setIterateModifiers(boolean iterateModifiers)
      Sets the state that determines the need for an iteration through all zoom instances with active modifiers.

      This is an internal method that shouldn't be used by other mods.

      Parameters:
      iterateModifiers - the new iteration state

    • shouldIterateOverlays

      public static boolean shouldIterateOverlays()
      Determines whenever an iteration through all zoom instances with active overlays is necessary.
      Returns:
      true if an iteration is needed, or false otherwise

    • setIterateOverlays

      @Internal public static void setIterateOverlays(boolean iterateOverlays)
      Sets the state that determines the need for an iteration through all zoom instances with active overlays.

      This is an internal method that shouldn't be used by other mods.

      Parameters:
      iterateOverlays - the new iteration state