Interface RegionOfInterest.Builder

    • Method Detail

      • boundingBox

        RegionOfInterest.Builder boundingBox​(BoundingBox boundingBox)

        The box representing a region of interest on screen.

        Parameters:
        boundingBox - The box representing a region of interest on screen.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • polygon

        RegionOfInterest.Builder polygon​(Collection<Point> polygon)

        Specifies a shape made up of up to 10 Point objects to define a region of interest.

        Parameters:
        polygon - Specifies a shape made up of up to 10 Point objects to define a region of interest.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • polygon

        RegionOfInterest.Builder polygon​(Point... polygon)

        Specifies a shape made up of up to 10 Point objects to define a region of interest.

        Parameters:
        polygon - Specifies a shape made up of up to 10 Point objects to define a region of interest.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • polygon

        RegionOfInterest.Builder polygon​(Consumer<Point.Builder>... polygon)

        Specifies a shape made up of up to 10 Point objects to define a region of interest.

        This is a convenience method that creates an instance of the Point.Builder avoiding the need to create one manually via Point.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #polygon(List).

        Parameters:
        polygon - a consumer that will call methods on Point.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #polygon(java.util.Collection)