Module org.refcodes.graphical
Package org.refcodes.graphical

Interface PixGridPane

All Superinterfaces:
org.refcodes.mixin.Clearable, VisibleAccessor, VisibleAccessor.VisibleMutator, VisibleAccessor.VisibleProperty
All Known Subinterfaces:
PixGridBannerPanel
public interface PixGridPane extends VisibleAccessor.VisibleProperty, org.refcodes.mixin.Clearable
The PixGridPane projects a RgbPixmap on a grid panel (such as an LED matrix) , the underlying RgbPixmap is painted onto that grid pane as implemented by any implementing classes.

  • Method Details

    • getPixelAt

      RgbPixel getPixelAt(int aPosX, int aPosY) throws IndexOutOfBoundsException
      Gets the RgbPixel at the given position.
      Parameters:
      aPosX - the x position
      aPosY - the y position
      Returns:
      the RgbPixel at the given position
      Throws:
      IndexOutOfBoundsException - the index out of bounds exception

    • setPixelAtAt

      void setPixelAtAt(RgbPixel aPixel, int aPosX, int aPosY)
      Paints the RgbPixel at the given position.
      Parameters:
      aPixel - the RgbPixel for the pixel at the given position.
      aPosX - the x position
      aPosY - the y position

    • getTopBorder

      int getTopBorder()
      Gets the top border.
      Returns:
      the top border

    • getBottomBorder

      int getBottomBorder()
      Gets the bottom border.
      Returns:
      the bottom border

    • getLeftBorder

      int getLeftBorder()
      Gets the left border.
      Returns:
      the left border

    • getRightBorder

      int getRightBorder()
      Gets the right border.
      Returns:
      the right border

    • getHorizontalSpace

      int getHorizontalSpace()
      Gets the horizontal space.
      Returns:
      the horizontal space

    • getVerticalSpace

      int getVerticalSpace()
      Gets the vertical space.
      Returns:
      the vertical space

    • getPixelWidth

      int getPixelWidth()
      Gets the pixel width.
      Returns:
      the pixel width

    • getPixelHeight

      int getPixelHeight()
      Gets the pixel height.
      Returns:
      the pixel height

    • getPixelShape

      PixelShape getPixelShape()
      Gets the pixel shape.
      Returns:
      the pixel shape

    • getMatrixWidth

      int getMatrixWidth()
      Gets the matrix width.
      Returns:
      the matrix width

    • getMatrixHeight

      int getMatrixHeight()
      Gets the matrix height.
      Returns:
      the matrix height

    • getMatrixSize

      Dimension getMatrixSize()
      Gets the matrix size.
      Returns:
      the matrix size

    • getRgbPixmap

      RgbPixmap.RgbPixmapBuilder getRgbPixmap()
      Gets the underlying RgbPixmap.RgbPixmapBuilder.
      Returns:
      the according RgbPixmap.RgbPixmapBuilder.

    • getPixmapOffsetX

      int getPixmapOffsetX()
      Gets the pixmap offset X.
      Returns:
      the pixmap offset X

    • getPixmapOffsetY

      int getPixmapOffsetY()
      Gets the pixmap offset Y.
      Returns:
      the pixmap offset Y

    • isHorizontalWrapEnabled

      boolean isHorizontalWrapEnabled()
      Checks if is horizontal wrap enabled.
      Returns:
      true, if is horizontal wrap enabled

    • isVerticalWrapEnabled

      boolean isVerticalWrapEnabled()
      Checks if is vertical wrap enabled.
      Returns:
      true, if is vertical wrap enabled

    • getPixmapSnapshot

      RgbPixmap.RgbPixmapBuilder getPixmapSnapshot()
      Gets the pixmap snapshot.
      Returns:
      the pixmap snapshot

    • addBlankArea

      boolean addBlankArea(int aPosX, int aPosY, int aWidth, int aHeight)
      Adds the blank area not to be painted with grid pixels.
      Parameters:
      aPosX - the x position
      aPosY - the y position
      aWidth - the according area's width
      aHeight - the according area's height
      Returns:
      true, if successfully added, false if such an area has already been added.

    • addBlankArea

      boolean addBlankArea(Rectangle aArea)
      Adds the blank area not to be painted with grid pixels.
      Parameters:
      aArea - the Rectangle representing the blank area.
      Returns:
      true, if successfully added, false if such an area has already been added.

    • removeBlankArea

      boolean removeBlankArea(Rectangle aArea)
      Removes the blank area now to be painted with grid pixels again.
      Parameters:
      aArea - the Rectangle representing the blank area.
      Returns:
      true, if successfully removed, false if such an area has not been added before.

    • clearBlankAreas

      void clearBlankAreas()
      Removes all blank areas now to be painted with grid pixels again.

    • getInactivePixelColor

      RgbColor getInactivePixelColor()
      Gets the inactive pixel color.
      Returns:
      the inactive pixel color

    • getMatrixDrawingWidth

      default int getMatrixDrawingWidth()
      Gets the matrix drawing width.
      Returns:
      the matrix drawing width

    • getMatrixDrawingHeight

      default int getMatrixDrawingHeight()
      Gets the matrix drawing height.
      Returns:
      the matrix drawing height

    • getMatrixDrawingWidth

      int getMatrixDrawingWidth(boolean isWithBorder, boolean isWithPixelSpace, boolean isWithPixelWidth)
      Gets the matrix drawing width.
      Parameters:
      isWithBorder - the is with border
      isWithPixelSpace - the is with pixel space
      isWithPixelWidth - the is with pixel width
      Returns:
      the matrix drawing width

    • getMatrixDrawingHeight

      int getMatrixDrawingHeight(boolean isWithBorder, boolean isWithPixelSpace, boolean isWithPixelHeight)
      Gets the matrix drawing height.
      Parameters:
      isWithBorder - the is with border
      isWithPixelSpace - the is with pixel space
      isWithPixelHeight - the is with pixel height
      Returns:
      the matrix drawing height

    • setPixmapOffset

      void setPixmapOffset(int aPosX, int aPosY)
      Sets the pixmap offset.
      Parameters:
      aPosX - the a X pos
      aPosY - the a Y pos

    • repaint

      void repaint()
      Repaint the pane with the underlying metrics and pixmap.