Package repast.simphony.visualizationOGL2D

Interface SpatialSource

All Known Subinterfaces:
ReLogoSpatialSource
All Known Implementing Classes:
ImageSpatialSource, NamedSpatialSoure, NLImageSpatialSource, ReLogoImageSpatialSource, ReLogoSVGSpatialSource, SVGSpatialSource
public interface SpatialSource
Interface for classes that can act as sources for VSpatials.
Author:
Nick Collier

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    KEY_BSQUARE_SIZE
    Key for the map passed to registerSource whose value specifies the size of a bounding square side, if applicable, of the created Spatial.
    static final String
    KEY_HEIGHT
    Key for the map passed to registerSource whose value specifies the height, if appicable, of the created Spatial.
    static final String
    KEY_SCALE
    Key for the map passed to registerSource whose value specifies the scale, if appicable, of the created Spatial.
    static final String
    KEY_WIDTH
    Key for the map passed to registerSource whose value specifies the width, if appicable, of the created Spatial.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getID()
    Gets the unique name for this source.
    void
    registerSource(saf.v3d.ShapeFactory2D shapeFactory, Map<String,String> props)
    Registers this source with ShapeFactory2D.

  • Field Details

    • KEY_WIDTH

      static final String KEY_WIDTH
      Key for the map passed to registerSource whose value specifies the width, if appicable, of the created Spatial.
      See Also:

    • KEY_HEIGHT

      static final String KEY_HEIGHT
      Key for the map passed to registerSource whose value specifies the height, if appicable, of the created Spatial.
      See Also:

    • KEY_SCALE

      static final String KEY_SCALE
      Key for the map passed to registerSource whose value specifies the scale, if appicable, of the created Spatial.
      See Also:

    • KEY_BSQUARE_SIZE

      static final String KEY_BSQUARE_SIZE
      Key for the map passed to registerSource whose value specifies the size of a bounding square side, if applicable, of the created Spatial.
      See Also:

  • Method Details

    • getID

      String getID()
      Gets the unique name for this source.
      Returns:
      the unique name for this source.

    • registerSource

      void registerSource(saf.v3d.ShapeFactory2D shapeFactory, Map<String,String> props) throws IOException
      Registers this source with ShapeFactory2D. After registering the source VSpatials can be retreived by name from the ShapeFactory2D.
      Parameters:
      props - a map containing properties (SpatialSource.WIDTH, etc.) that can be used in registering the source
      Throws:
      IOException