Package repast.simphony.visualization.engine

Interface VisualizationRegistryData

Type Parameters:
T -
All Known Implementing Classes:
GIS3DVisualizationRegistryData, GISVisualizationRegistryData
public interface VisualizationRegistryData
Visualization registry data stores information about the available visualization types (displays) and their associated capabilities, such as converters, loaders, and GUI panels. User-defined visualizations should implement registry data to provide these basic capabilities to the runtime.
Author:
Eric Tatara

  • Method Details

    • getVisualizationType

      String getVisualizationType()
      The visualization type Name, e.g. "2D", "3D", etc
      Returns:
      the projection type name.

    • getDisplayCreatorFactory

      DisplayCreatorFactory getDisplayCreatorFactory()
      Provide a DisplayCreator that will create the display.
      Returns:
      the projection builder factory.

    • getDefaultStyles

      Class<?>[] getDefaultStyles()
      The default style classes that are available in the display wizard.
      Returns:
      the style classes.

    • getDefaultEdgeStyles

      Class<?>[] getDefaultEdgeStyles()
      The default edge style classes that are available in the display wizard.
      Returns:
      the edge style classes.

    • getStyleInterface

      Class<?> getStyleInterface()
      The style interface associated with the display.
      Returns:
      the style interface.

    • getEdgeStyleInterface

      Class<?> getEdgeStyleInterface()
      The edge style interface associated with the display.
      Returns:
      the edge style interface.

    • getDisplayWizardSteps

      List<Pair<org.pietschy.wizard.WizardStep,org.pietschy.wizard.models.Condition>> getDisplayWizardSteps()
      Gets display wizard steps (style, etc) specific to this display type.
      Returns:

    • getDescriptorFactory

      DisplayDescriptorFactory getDescriptorFactory()
      Get a factory for creating display descriptors for this display type.
      Returns:

    • getProjectionDescriptorFactory

      ProjectionDescriptorFactory getProjectionDescriptorFactory()
      Get a factory for creation projection discritprs used by displays.
      Returns:

    • getRequiredLibraryClassName

      String getRequiredLibraryClassName()
      Return an optional (can be null or emptystring) name of a class that is required for this visualization type to work propely. This is useful if the visualization is dependent on a third party library like JOGL. The DisplayControllerAction will check if this required class name is on the classpath and will not try to create the display if it is missing.
      Returns:

    • handlesProjectionType

      boolean handlesProjectionType(String projectionType)
      Returns true if this visualization is able to handle the projection type.
      Parameters:
      projectionType -
      Returns:

    • getDisplayValidator

      DisplayValidator getDisplayValidator()
      Get a DisplayValidator instance associated with this display type.
      Returns:

    • getDefaultEditedStyleDataClass

      Class<? extends EditedStyleData> getDefaultEditedStyleDataClass()

    • getDefaultEditedEdgeStyleDataClass

      Class<? extends EditedEdgeStyleData> getDefaultEditedEdgeStyleDataClass()

    • getEditedStyleClass

      Class<?> getEditedStyleClass(EditedStyleData editedStyleData)

    • getEditedEdgeStyleClass

      Class<?> getEditedEdgeStyleClass()

    • getAllowedShapes

      Set<String> getAllowedShapes()