Package heronarts.lx

Interface LXPlugin

All Known Subinterfaces:
LXStudio.Plugin
public interface LXPlugin
Generic interface for an object that contains callback methods for the LX engine. These can be used to integrate third-party components or perform custom initializations.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static @interface 
    LXPlugin.Name
    An annotation to be applied to an LXPlugin class giving it a user-facing name

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    dispose()
    This method is invoked when the plugin is done and will not be used anymore.
    void
    initialize(LX lx)
    This method is invoked on the plugin object after LX has been initialized.

  • Method Details

    • initialize

      void initialize(LX lx)
      This method is invoked on the plugin object after LX has been initialized. Note that this happens before any project files have been loaded. The plugin can add components to the LX hierarchy and register listeners if it is going to take actions based upon those.
      Parameters:
      lx - LX instance

    • dispose

      default void dispose()
      This method is invoked when the plugin is done and will not be used anymore. Any resources used should be freed, listeners should be unregistered, etc.