Class FieldImage

java.lang.Object
org.wpilib.fields.FieldImage

public final class FieldImage extends Object
Field image metadata.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    int
    Bottom field boundary in image pixels.
    int
    Left field boundary in image pixels.
    Field image path.
    int
    Right field boundary in image pixels.
    int
    Top field boundary in image pixels.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Constructs a field image metadata object.
    FieldImage(String path, int top, int left, int bottom, int right)
    Constructs a field image metadata object.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
    int
     

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • path

      public String path
      Field image path. JSON files store this relative to the JSON file's directory; built-in fields store the image resource path relative to Fields.BASE_RESOURCE_DIR.
    • top

      public int top
      Top field boundary in image pixels.
    • left

      public int left
      Left field boundary in image pixels.
    • bottom

      public int bottom
      Bottom field boundary in image pixels.
  • Constructor Details

    • FieldImage

      public FieldImage()
      Constructs a field image metadata object.
    • FieldImage

      public FieldImage(String path, int top, int left, int bottom, int right)
      Constructs a field image metadata object.
      Parameters:
      path - Field image path. JSON files store this relative to the JSON file's directory; built-in fields store the image resource path relative to Fields.BASE_RESOURCE_DIR.
      top - Top field boundary in image pixels.
      left - Left field boundary in image pixels.
      bottom - Bottom field boundary in image pixels.
      right - Right field boundary in image pixels.
  • Method Details