Package velox.api.layer1.layers.strategies.interfaces

Interface ScreenSpacePainter

All Known Subinterfaces:
ScreenSpacePainterAdapter
public interface ScreenSpacePainter
Provides information regarding where user is looking at. Expected reaction is to create/update shapes. Note: you are not limited to creating/updating/deleting shapes in response to the methods of this interface, shapes can be updated at any time.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dispose()
    Painter is no longer needed.
    void
    onHeatmapActivePixelsWidth(int heatmapActivePixelsWidth)
    Width of the heatmap area corresponding to data (in pixels) changed.
    void
    onHeatmapActiveTimeWidth(long heatmapActiveTimeWidth)
    Width of the heatmap area corresponding to data (in nanoseconds) changed.
    void
    onHeatmapFullPixelsWidth(int heatmapFullPixelsWidth)
    Width of the heatmap area (including the part containing no data, in pixels) changed.
    void
    onHeatmapFullTimeWidth(long heatmapFullTimeWidth)
    Width of the heatmap area (including the part containing no data, in nanoseconds) changed.
    void
    onHeatmapPixelsBottom(int heatmapPixelsBottom)
    Position of bottom edge of heatmap on inside the window changed.
    void
    onHeatmapPixelsHeight(int heatmapPixelsHeight)
    Height of the area representing the heatmap (in pixels) changed
    void
    onHeatmapPixelsLeft(int heatmapPixelsLeft)
    Position of left edge of heatmap on inside the window changed.
    void
    onHeatmapPriceBottom(long heatmapPriceBottom)
    Lowest price displayed on heatmap changed
    void
    onHeatmapPriceHeight(long heatmapPriceHeight)
    Number of levels displayed on heatmap changed
    void
    onHeatmapTimeLeft(long heatmapTimeLeft)
    Time corresponding to left edge of heatmap changed
    void
    onMoveEnd()
    Called after transmitting actual changes, allows batch processing of changes.
    void
    onMoveStart()
    Called after view was moved before transmitting actual changes, allows batch processing of changes
    void
    onRightOfTimelineLeft(int rightOfTimelineLeft)
    X coordinate of the timeline has changed (in pixels).
    void
    onRightOfTimelineWidth(int rightOfTimelineWidth)
    Width of the area to the right of timeline (in pixels) has changed.

  • Method Details

    • onMoveStart

      void onMoveStart()
      Called after view was moved before transmitting actual changes, allows batch processing of changes

    • onMoveEnd

      void onMoveEnd()
      Called after transmitting actual changes, allows batch processing of changes.

    • onHeatmapTimeLeft

      void onHeatmapTimeLeft(long heatmapTimeLeft)
      Time corresponding to left edge of heatmap changed
      Parameters:
      heatmapTimeLeft - new time in nanoseconds

    • onHeatmapActiveTimeWidth

      void onHeatmapActiveTimeWidth(long heatmapActiveTimeWidth)
      Width of the heatmap area corresponding to data (in nanoseconds) changed.
      Parameters:
      heatmapActiveTimeWidth - new width in nanoseconds

    • onHeatmapFullTimeWidth

      void onHeatmapFullTimeWidth(long heatmapFullTimeWidth)
      Width of the heatmap area (including the part containing no data, in nanoseconds) changed.
      Parameters:
      heatmapFullTimeWidth - new width in nanoseconds

    • onHeatmapPriceBottom

      void onHeatmapPriceBottom(long heatmapPriceBottom)
      Lowest price displayed on heatmap changed
      Parameters:
      heatmapPriceBottom - new lowest price as a number of level (multiply by InstrumentInfo.pips to get human-readable price).

    • onHeatmapPriceHeight

      void onHeatmapPriceHeight(long heatmapPriceHeight)
      Number of levels displayed on heatmap changed
      Parameters:
      heatmapPriceHeight - new number of levels

    • onHeatmapPixelsLeft

      void onHeatmapPixelsLeft(int heatmapPixelsLeft)
      Position of left edge of heatmap on inside the window changed.

      In the current version of Screen Space Painter API this method is useless for 3-rd party addons.

      Parameters:
      heatmapPixelsLeft - new x coordinate in pixels

    • onHeatmapActivePixelsWidth

      void onHeatmapActivePixelsWidth(int heatmapActivePixelsWidth)
      Width of the heatmap area corresponding to data (in pixels) changed.
      Parameters:
      heatmapActivePixelsWidth -

    • onHeatmapFullPixelsWidth

      void onHeatmapFullPixelsWidth(int heatmapFullPixelsWidth)
      Width of the heatmap area (including the part containing no data, in pixels) changed.
      Parameters:
      heatmapFullPixelsWidth - new width in pixels

    • onHeatmapPixelsBottom

      void onHeatmapPixelsBottom(int heatmapPixelsBottom)
      Position of bottom edge of heatmap on inside the window changed. Y coordinate increases when going up (same direction as price increase).

      In the current version of Screen Space Painter API this method is useless for 3-d party addons.

      Parameters:
      heatmapPixelsBottom - new y coordinate in pixels.

    • onHeatmapPixelsHeight

      void onHeatmapPixelsHeight(int heatmapPixelsHeight)
      Height of the area representing the heatmap (in pixels) changed
      Parameters:
      heatmapPixelsHeight - new heatmap height in pixels

    • onRightOfTimelineLeft

      void onRightOfTimelineLeft(int rightOfTimelineLeft)
      X coordinate of the timeline has changed (in pixels). Note, that in drag mode when timeline is not visible it's considered to be in the leftmost pixel of heatmap.
      Parameters:
      rightOfTimelineLeft - new x coordinate of timeline in pixels

    • onRightOfTimelineWidth

      void onRightOfTimelineWidth(int rightOfTimelineWidth)
      Width of the area to the right of timeline (in pixels) has changed.
      Parameters:
      rightOfTimelineWidth - new width of the area to the right of timeline

    • dispose

      void dispose()
      Painter is no longer needed. When this method is called all resources should be disposed (including created ScreenSpaceCanvas).