Package org.simbrain.world.visionworld.filter.editor

The visionworld.filter.editor package contains classes of the different types of filter editors.

See: Description

Interface Summary

Interface	Description
FilterEditor	Filter editor.

Class Summary

Class	Description
FilterEditors	Filter editors.
PixelAccumulatorEditor	Pixel accumulator editor.
RandomFilterEditor	Random filter editor.
RgbFilterEditor	FilterEditor that creates RgbFilters.
UniformFilterEditor	Uniform filter editor.

Exception Summary

Exception	Description
FilterEditorException	Filter editor exception.

Package org.simbrain.world.visionworld.filter.editor Description

The visionworld.filter.editor package contains classes of the different types of filter editors.

Creating a new filter editor

To create a new filter editor, perform the following steps:

1. Implement the FilterEditor interface. It is helpful but not necessary to extend JPanel, e.g.

public class MyFilterEditor
  extends JPanel
  implements FilterEditor {

  public MyFilterEditor() {
    super();
    // add UI components to panel
  }


  public Component getEditorComponent() {
    // reset UI components and return this
    return this;
  }

  public Filter createFilter() throws FilterEditorException {
    try {
      // create instance of MyFilter from values in UI components
      return new MyFilter(...);
    }
    catch (IllegalArgumentException e) {
      // rethrow instantiation exceptions as FilterEditorExceptions
      throw new FilterEditorException(e);
    }
  }

  //...
}

2. Return a reasonable display name for String toString().

   public String toString() {
     return "My filter";
   }
   

3. Add a public static instance of the filter editor to FilterEditors.

/** My filter editor. */
public static final FilterEditor MY_FILTER_EDITOR = new MyFilterEditor();

4. Add a reference to that public static instance to the private values array in FilterEditors.

/** Private array of filter editors. */
private static final FilterEditor[] values = new FilterEditor[] { RANDOM, UNIFORM, MY_FILTER_EDITOR };