Package org.opentrafficsim.web.animation.d2

Class HtmlGridPanel

java.lang.Object
org.opentrafficsim.web.animation.d2.HtmlGridPanel
All Implemented Interfaces:
ImageObserver
Direct Known Subclasses:
HtmlAnimationPanel
public class HtmlGridPanel extends Object implements ImageObserver
The VisualizationPanel introduces the gridPanel.

Copyright (c) 2003-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. BSD-style license. See OpenTrafficSim License.

Author:
Niels Lang , Peter Jacobs

  • Field Details

    • UP

      public static final int UP
      the UP directions for moving/zooming.
      See Also:

    • DOWN

      public static final int DOWN
      the DOWN directions for moving/zooming.
      See Also:

    • LEFT

      public static final int LEFT
      the LEFT directions for moving/zooming.
      See Also:

    • ZOOMFACTOR

      public static final double ZOOMFACTOR
      the ZOOM factor.
      See Also:

    • GRIDCOLOR

      protected static final Color GRIDCOLOR
      gridColor.

    • extent

      protected Bounds2d extent
      the extent of this panel.

    • homeExtent

      protected Bounds2d homeExtent
      the extent of this panel.

    • showGrid

      protected boolean showGrid
      show the grid.

    • gridSizeX

      protected double gridSizeX
      the gridSize for the X-direction in world Units.

    • gridSizeY

      protected double gridSizeY
      the gridSize for the Y-direction in world Units.

    • formatter

      protected NumberFormat formatter
      the formatter to use.

    • lastDimension

      protected Dimension lastDimension
      the last computed Dimension.

    • lastScreen

      protected Dimension lastScreen
      the last stored screen dimensions for zoom-in, zoom-out.

    • lastXScale

      protected Double lastXScale
      the last stored x-scale for zoom-in, zoom-out.

    • lastYScale

      protected Double lastYScale
      the last stored y-scale for zoom-in, zoom-out.

    • size

      protected Dimension size
      the last computed Dimension.

    • preferredSize

      protected Dimension preferredSize
      the last computed Dimension.

    • worldCoordinate

      protected Point2d worldCoordinate
      the last known world coordinate of the mouse.

    • showToolTip

      protected boolean showToolTip
      whether to show a tooltip with the coordinates or not.

    • htmlGraphics2D

      protected HtmlGraphics2d htmlGraphics2D
      the HTMLGraphics2D 'shadow' canvas.

    • renderableScale

      protected nl.tudelft.simulation.dsol.animation.d2.RenderableScale renderableScale
      the renderable scale (X/Y ratio) to use.

  • Constructor Details

    • HtmlGridPanel

      public HtmlGridPanel(Bounds2d extent)
      constructs a new VisualizationPanel.
      Parameters:
      extent - the extent to show.

    • HtmlGridPanel

      public HtmlGridPanel(Bounds2d homeExtent, Dimension size)
      constructs a new VisualizationPanel.
      Parameters:
      homeExtent - the initial extent.
      size - the size of the panel in pixels.

  • Method Details

    • getDrawingCommands

      public String getDrawingCommands()
      Return the set of drawing commands.
      Returns:
      the set of drawing commands

    • paintComponent

      public void paintComponent(HtmlGraphics2d g)
      Draw the grid.
      Parameters:
      g - the virtual Graphics2D canvas to enable writing to the browser

    • showGrid

      public final void showGrid(boolean bool)
      show the grid?
      Parameters:
      bool - true/false

    • getExtent

      public final Bounds2d getExtent()
      returns the extent of this panel.
      Returns:
      Bounds2d

    • setExtent

      public void setExtent(Bounds2d extent)
      returns the extent of this panel.
      Parameters:
      extent - Bounds2d; the new extent

    • setWorldCoordinate

      public final void setWorldCoordinate(Point2d point)
      Set the world coordinates based on a mouse move.
      Parameters:
      point - the x,y world coordinates

    • getWorldCoordinate

      public final Point2d getWorldCoordinate()
      Returns world coordinates.
      Returns:
      worldCoordinate

    • displayWorldCoordinateToolTip

      public final void displayWorldCoordinateToolTip()
      Display a tooltip with the last known world coordinates of the mouse, in case the tooltip should be displayed.

    • isShowToolTip

      public final boolean isShowToolTip()
      Returns whether to show tooltip.
      Returns:
      showToolTip

    • setShowToolTip

      public final void setShowToolTip(boolean showToolTip)
      Sets whether to show tooltip.
      Parameters:
      showToolTip - set showToolTip

    • pan

      public final void pan(int direction, double percentage)
      pans the panel in a specified direction.
      Parameters:
      direction - the direction
      percentage - the percentage

    • home

      public final void home()
      resets the panel to its original extent.

    • isShowGrid

      public final boolean isShowGrid()
      Returns show grid.
      Returns:
      Returns the showGrid.

    • setShowGrid

      public final void setShowGrid(boolean showGrid)
      Sets show grid.
      Parameters:
      showGrid - The showGrid to set.

    • zoom

      public final void zoom(double factor)
      zooms in/out.
      Parameters:
      factor - The zoom factor

    • zoom

      public final void zoom(double factor, int mouseX, int mouseY)
      zooms in/out.
      Parameters:
      factor - The zoom factor
      mouseX - x-position of the mouse around which we zoom
      mouseY - y-position of the mouse around which we zoom

    • drawGrid

      protected void drawGrid(Graphics g)
      Added to make sure the recursive render-call calls THIS render method instead of a potential super-class defined 'paintComponent' render method.
      Parameters:
      g - the graphics object

    • getRenderableScale

      public final nl.tudelft.simulation.dsol.animation.d2.RenderableScale getRenderableScale()
      Returns renderable scale.
      Returns:
      renderableScale

    • setRenderableScale

      public final void setRenderableScale(nl.tudelft.simulation.dsol.animation.d2.RenderableScale renderableScale)
      Sets renderable scale.
      Parameters:
      renderableScale - set renderableScale

    • repaint

      public void repaint()
      Repaint the shadow canvas.

    • getSize

      public final Dimension getSize()
      Returns size.
      Returns:
      size

    • setSize

      public final void setSize(Dimension size)
      Sets size.
      Parameters:
      size - set size

    • getBackground

      public final Color getBackground()
      Returns background.
      Returns:
      background

    • setBackground

      public final void setBackground(Color background)
      Sets background.
      Parameters:
      background - set background

    • getWidth

      public final int getWidth()
      Returns width.
      Returns:
      width

    • getHeight

      public final int getHeight()
      Returns height.
      Returns:
      height

    • getPreferredSize

      public final Dimension getPreferredSize()
      Returns preferred size.
      Returns:
      preferredSize

    • setPreferredSize

      public final void setPreferredSize(Dimension preferredSize)
      Sets preferred size.
      Parameters:
      preferredSize - set preferredSize

    • getToolTipText

      public final String getToolTipText()
      Returns tooltip.
      Returns:
      toolTipText

    • setToolTipText

      public final void setToolTipText(String toolTipText)
      Sets tooltip.
      Parameters:
      toolTipText - set toolTipText

    • isShowing

      public final boolean isShowing()
      Returns whether panel is showing.
      Returns:
      showing

    • setShowing

      public final void setShowing(boolean showing)
      Sets whether panel is showing.
      Parameters:
      showing - set showing

    • getFont

      public final Font getFont()
      Returns font.
      Returns:
      font

    • setFont

      public final void setFont(Font font)
      Sets font.
      Parameters:
      font - set font

    • getFontMetrics

      public final FontMetrics getFontMetrics(Font font)
      Returns font metrics.
      Parameters:
      font - the font to calculate the fontmetrics for
      Returns:
      fontMetrics

    • isDirty

      public final boolean isDirty()
      Return whether the panel is dirty.
      Returns:
      dirty

    • imageUpdate

      public boolean imageUpdate(Image img, int infoflags, int x, int y, int width, int height)
      Specified by:
      imageUpdate in interface ImageObserver

    • computeVisibleExtent

      public Optional<Bounds2d> computeVisibleExtent(Bounds2d extent)
      Computes the visible extent, while preserving zoom scale, otherwise dragging the split screen may pump up the zoom factor.
      Parameters:
      extent - the extent to use
      Returns:
      a new extent or empty if parameters are null or screen is invalid (width / height <= 0)