Package io.github.oblarg.oblog.annotations

Annotation Type Log.CameraStream

  • @Repeatable(CameraStreams.class)
@Retention(RUNTIME)
@Target({FIELD,METHOD})
public static @interface Log.CameraStream
    Displays a camera stream.
    Supported types:
    • VideoSource (as long as it is streaming on an MJPEG server)

    Custom properties:
    NameTypeDefault ValueNotes
    Show crosshairBooleantrue Show or hide a crosshair on the image
    Crosshair colorColor"white" Can be a string or a rgba integer
    Show controlsBooleantrueShow or hide the stream controls
    RotationString"NONE" Rotates the displayed image. One of ["NONE", "QUARTER_CW", "QUARTER_CCW", "HALF"]

    • Element Detail

      • name

        java.lang.String name
        Returns:
        The name of the value on Shuffleboard; defaults to field or method name.
        Default:
        "NO_NAME"

      • tabName

        java.lang.String tabName
        Returns:
        The name of the tab in which to place this widget, if the default inferred tab/layout is not desired. Users should be careful to avoid namespace collisions if the default tab is not used. Note that Log and config annotations can be repeated to place widgets on multiple tabs.
        Default:
        "DEFAULT"

      • methodName

        java.lang.String methodName
        Returns:
        Optional name of a method to call on the field (or return value of the method) to obtain the actual value that will be logged. Useful if one does not desire to make an entire object Loggable, but still wants to log a value from it.
        Default:
        "DEFAULT"

      • showCrosshairs

        boolean showCrosshairs
        Returns:
        Whether to show the crosshairs.
        Default:
        true

      • crosshairColor

        java.lang.String crosshairColor
        Returns:
        Color of the crosshairs.
        Default:
        "white"

      • showControls

        boolean showControls
        Returns:
        Whether to show the stream controls.
        Default:
        true

      • rotation

        java.lang.String rotation
        Returns:
        Rotate the displayed image. Must be one of: "NONE", "QUARTER_CW", "QUARTER_CCW", "HALF".
        Default:
        "NONE"

      • rowIndex

        int rowIndex
        Returns:
        The row in which this widget should be placed. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1

      • columnIndex

        int columnIndex
        Returns:
        The column in which this widget should be placed. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1

      • width

        int width
        Returns:
        The width of this widget. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1

      • height

        int height
        Returns:
        The height of this widget. WARNING: If position/size is specified for one widget in an object, it should be specified for all widgets in that object to avoid overlaps.
        Default:
        -1