Constructor Detail

• Region

  Region()

• Region

  Region(Number v1, Number v2)

  Parameters:

  v2 - Values are ordered so that min is the smaller of the two.

Method Detail

• withDefaults

  @NonNull() static Region withDefaults(@NonNull() Region defaults)

• setMinMax

   void setMinMax(@NonNull() Region region)

• measure

  @Nullable() static Number measure(@Nullable() Number v1, @Nullable() Number v2)

  Returns:

  The distance between val1 and val2 or null if either parameters are null.

  Since:

  0.9.7

• length

  @Nullable() Number length()

• contains

   boolean contains(@NonNull() Number value)

  Tests whether a value is within the given range

• intersects

   boolean intersects(@NonNull() Region region)

• center

  @NonNull() Number center()

  Returns:

  Middle value within this region

• transform

  @NonNull() Number transform(double value, @NonNull() Region region2)

  Transform a value relative to this region into it's corresponding value relative to the specified region.

• transform

  @NonNull() Number transform(double value, @NonNull() Region region2, boolean flip)

• transform

   double transform(double value, double min, double max, boolean flip)

• ratio

  @NonNull() Number ratio(@NonNull() Region r2)

• ratio

   double ratio(double min, double max)

  Returns:

  length of this series divided by the length of the distance between min and max.

• union

   void union(@Nullable() Number value)

• union

   void union(@NonNull() Region input)

  Compares the input bounds min/max against this instance's current min/max. If the input.min is less than this.min then this.min will be set to input.min. If the input.max is greater than this.max then this.max will be set to input.max The result of a union will always be an equal or larger size region.

• intersect

   void intersect(@NonNull() Region input)

  The result of an intersect will always be an equal or smaller size region.

• intersects

   boolean intersects(@Nullable() Number line2Min, @Nullable() Number line2Max)

  Tests whether this segment intersects another. A null min represents negative infinity and a null max represents positive infinity, both for the params and for this region's own min / max.

• isMinSet

   boolean isMinSet()

• getMin

  @Nullable() Number getMin()

• setMin

   void setMin(@Nullable() Number min)

• isMaxSet

   boolean isMaxSet()

• getMax

  @Nullable() Number getMax()

• setMax

   void setMax(@Nullable() Number max)

• isDefined

   boolean isDefined()

  Returns:

  True if both min and max values are non-null, false otherwise. Does *not* consider defaults.

• toString

   String toString()