ly.img.android.sdk.models.chunk

Class RelativeRectAccurate

java.lang.Object

ly.img.android.sdk.models.chunk.RelativeRectAccurate

All Implemented Interfaces:

android.os.Parcelable

public class RelativeRectAccurate
extends java.lang.Object
implements android.os.Parcelable

Created by svennahler on 17.09.16.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.math.BigDecimal	bottom
static android.os.Parcelable.Creator<RelativeRectAccurate>	CREATOR
static java.math.BigDecimal	HALF
protected java.math.BigDecimal	left
static java.math.MathContext	MATH_CONTEXT
static java.math.BigDecimal	ONE
protected java.math.BigDecimal	rangeOffsetX
protected java.math.BigDecimal	rangeOffsetY
protected java.math.BigDecimal	rangeScaleX
protected java.math.BigDecimal	rangeScaleY
protected java.math.BigDecimal	right
protected java.math.BigDecimal	sourceAspect
protected java.math.BigDecimal	top
static java.math.BigDecimal	TWO
static java.math.BigDecimal	ZERO

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	RelativeRectAccurate() Create a new empty BigRect.
	RelativeRectAccurate(java.math.BigDecimal left, java.math.BigDecimal top, java.math.BigDecimal right, java.math.BigDecimal bottom, java.math.BigDecimal sourceAspect) Create a new rectangle with the specified coordinates.
protected	RelativeRectAccurate(android.os.Parcel in)
	RelativeRectAccurate(android.graphics.RectF ref, float left, float top, float right, float bottom)
	RelativeRectAccurate(android.graphics.Rect ref, float left, float top, float right, float bottom)
	RelativeRectAccurate(android.graphics.RectF ref, android.graphics.Rect r) Create a new rectangle, initialized with the values in the specified rectangle (which is left unmodified).
	RelativeRectAccurate(android.graphics.RectF ref, android.graphics.RectF r) Create a new rectangle, initialized with the values in the specified rectangle (which is left unmodified).
	RelativeRectAccurate(android.graphics.Rect ref, android.graphics.Rect r) Create a new rectangle, initialized with the values in the specified rectangle (which is left unmodified).
	RelativeRectAccurate(android.graphics.Rect ref, android.graphics.RectF r) Create a new rectangle, initialized with the values in the specified rectangle (which is left unmodified).
	RelativeRectAccurate(RelativeRectAccurate r) Create a new rectangle, initialized with the values in the specified rectangle (which is left unmodified).
	RelativeRectAccurate(RelativeRectFast r) Create a new rectangle, initialized with the values in the specified rectangle (which is left unmodified).

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	bottom()
java.math.BigDecimal	centerX()
java.math.BigDecimal	centerY()
boolean	contains(java.math.BigDecimal x, java.math.BigDecimal y) Returns true if (x,y) is inside the rectangle.
boolean	contains(java.math.BigDecimal left, java.math.BigDecimal top, java.math.BigDecimal right, java.math.BigDecimal bottom) Returns true iff the 4 specified sides of a rectangle are inside or equal to this rectangle. i.e. is this rectangle a superset of the specified rectangle.
boolean	contains(RelativeRectAccurate r) Returns true iff the specified rectangle r is inside or equal to this rectangle.
java.math.BigDecimal	convertAspect(java.math.BigDecimal aspect)
int	describeContents()
boolean	equals(java.lang.Object o)
MultiRect	getMultiRect(android.graphics.Rect ref)
android.graphics.RectF	getRectF(android.graphics.Rect ref)
android.graphics.RectF	getRectF(android.graphics.RectF ref)
static RelativeRectAccurate	getRelativeRectCenterInside(float imageWidthValue, float imageHeightValue, float viewWidthValue, float viewHeightValue)
java.math.BigDecimal	getSourceAspect()
int	hashCode()
java.math.BigDecimal	height()
void	inset(java.math.BigDecimal dx, java.math.BigDecimal dy) Inset the rectangle by (dx,dy).
boolean	intersect(java.math.BigDecimal left, java.math.BigDecimal top, java.math.BigDecimal right, java.math.BigDecimal bottom) If the rectangle specified by left,top,right,bottom intersects this rectangle, return true and set this rectangle to that intersection, otherwise return false and do not change this rectangle.
boolean	intersect(RelativeRectAccurate r) If the specified rectangle intersects this rectangle, return true and set this rectangle to that intersection, otherwise return false and do not change this rectangle.
boolean	intersects(java.math.BigDecimal left, java.math.BigDecimal top, java.math.BigDecimal right, java.math.BigDecimal bottom) Returns true if this rectangle intersects the specified rectangle.
static boolean	intersects(RelativeRectAccurate a, RelativeRectAccurate b) Returns true iff the two specified rectangles intersect.
boolean	isEmpty() Returns true if the rectangle is empty (left >= right or top >= bottom)
java.math.BigDecimal	left()
void	limitTo(java.math.BigDecimal left, java.math.BigDecimal top, java.math.BigDecimal right, java.math.BigDecimal bottom)
void	limitTo(java.math.BigDecimal left, java.math.BigDecimal top, java.math.BigDecimal right, java.math.BigDecimal bottom, boolean saveSize)
void	offset(java.math.BigDecimal dx, java.math.BigDecimal dy) Offset the rectangle by adding dx to its left and right coordinates, and adding dy to its top and bottom coordinates.
void	offsetTo(java.math.BigDecimal newLeft, java.math.BigDecimal newTop) Offset the rectangle to a specific (left, top) position, keeping its width and height the same.
void	printShortString(java.io.PrintWriter pw) Print short representation to given writer.
java.math.BigDecimal	right()
android.graphics.Rect	round(android.graphics.Rect ref) Set the dst integer Rect by rounding this rectangle's coordinates to their nearest integer values.
android.graphics.Rect	round(android.graphics.RectF ref) Set the dst integer Rect by rounding this rectangle's coordinates to their nearest integer values.
android.graphics.Rect	roundOut(android.graphics.Rect ref) Set the dst integer Rect by rounding "out" this rectangle, choosing the floor of top and left, and the ceiling of right and bottom.
android.graphics.Rect	roundOut(android.graphics.RectF ref) Set the dst integer Rect by rounding "out" this rectangle, choosing the floor of top and left, and the ceiling of right and bottom.
void	scale(java.math.BigDecimal scale)
void	scaleInCenter(java.math.BigDecimal scale)
void	set(java.math.BigDecimal left, java.math.BigDecimal top, java.math.BigDecimal right, java.math.BigDecimal bottom) Set the rectangle's coordinates to the specified values.
void	set(android.graphics.RectF ref, float left, float top, float right, float bottom) Set the rectangle's coordinates to the specified values.
void	set(android.graphics.RectF ref, android.graphics.Rect src) Copy the coordinates from src into this rectangle.
void	set(android.graphics.RectF ref, android.graphics.RectF src) Copy the coordinates from src into this rectangle.
void	set(RelativeRectAccurate src) Copy the coordinates from src into this rectangle.
void	setEmpty() Set the rectangle to (0,0,0,0)
boolean	setIntersect(RelativeRectAccurate a, RelativeRectAccurate b) If rectangles a and b intersect, return true and set this rectangle to that intersection, otherwise return false and do not change this rectangle.
protected void	setRef(android.graphics.Rect ref)
protected void	setRef(android.graphics.RectF ref)
void	setSourceAspect(java.math.BigDecimal sourceAspect)
void	sort() Swap top/bottom or left/right if there are flipped (i.e. left > right and/or top > bottom).
java.math.BigDecimal	top()
java.lang.String	toShortString() Return a string representation of the rectangle in a compact form.
java.lang.String	toShortString(java.lang.StringBuilder sb) Return a string representation of the rectangle in a compact form.
java.lang.String	toString()
RelativeRectAccurate	translateCoordinateSystem(RelativeRectAccurate newCoordinateSystem)
void	union(java.math.BigDecimal x, java.math.BigDecimal y) Update this Rect to enclose itself and the [x,y] coordinate.
void	union(java.math.BigDecimal left, java.math.BigDecimal top, java.math.BigDecimal right, java.math.BigDecimal bottom) Update this Rect to enclose itself and the specified rectangle.
void	union(RelativeRectAccurate r) Update this Rect to enclose itself and the specified rectangle.
java.math.BigDecimal	width()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

bottom

@NonNull
protected java.math.BigDecimal bottom

CREATOR

public static final android.os.Parcelable.Creator<RelativeRectAccurate> CREATOR

HALF

public static final java.math.BigDecimal HALF

left

@NonNull
protected java.math.BigDecimal left

MATH_CONTEXT

public static final java.math.MathContext MATH_CONTEXT

ONE

public static final java.math.BigDecimal ONE

rangeOffsetX

protected java.math.BigDecimal rangeOffsetX

rangeOffsetY

protected java.math.BigDecimal rangeOffsetY

rangeScaleX

protected java.math.BigDecimal rangeScaleX

rangeScaleY

protected java.math.BigDecimal rangeScaleY

right

@NonNull
protected java.math.BigDecimal right

sourceAspect

protected java.math.BigDecimal sourceAspect

top

@NonNull
protected java.math.BigDecimal top

TWO

public static final java.math.BigDecimal TWO

ZERO

public static final java.math.BigDecimal ZERO

Constructor Detail

RelativeRectAccurate

public RelativeRectAccurate()

Create a new empty BigRect. All coordinates are initialized to 0.

RelativeRectAccurate

public RelativeRectAccurate(@NonNull
                            java.math.BigDecimal left,
                            @NonNull
                            java.math.BigDecimal top,
                            @NonNull
                            java.math.BigDecimal right,
                            @NonNull
                            java.math.BigDecimal bottom,
                            @NonNull
                            java.math.BigDecimal sourceAspect)

Create a new rectangle with the specified coordinates. Note: no range checking is performed, so the caller must ensure that left <= right and top <= bottom.

Parameters:

left - The X coordinate of the left side of the rectangle

top - The Y coordinate of the top of the rectangle

right - The X coordinate of the right side of the rectangle

bottom - The Y coordinate of the bottom of the rectangle

RelativeRectAccurate

protected RelativeRectAccurate(android.os.Parcel in)

RelativeRectAccurate

public RelativeRectAccurate(@NonNull
                            android.graphics.RectF ref,
                            float left,
                            float top,
                            float right,
                            float bottom)

RelativeRectAccurate

public RelativeRectAccurate(@NonNull
                            android.graphics.Rect ref,
                            float left,
                            float top,
                            float right,
                            float bottom)

RelativeRectAccurate

public RelativeRectAccurate(android.graphics.RectF ref,
                            android.graphics.Rect r)

Create a new rectangle, initialized with the values in the specified rectangle (which is left unmodified).

Parameters:

r - The rectangle whose coordinates are copied into the new rectangle.

RelativeRectAccurate

public RelativeRectAccurate(android.graphics.RectF ref,
                            android.graphics.RectF r)

Create a new rectangle, initialized with the values in the specified rectangle (which is left unmodified).

Parameters:

r - The rectangle whose coordinates are copied into the new rectangle.

RelativeRectAccurate

public RelativeRectAccurate(android.graphics.Rect ref,
                            android.graphics.Rect r)

Create a new rectangle, initialized with the values in the specified rectangle (which is left unmodified).

Parameters:

r - The rectangle whose coordinates are copied into the new rectangle.

RelativeRectAccurate

public RelativeRectAccurate(android.graphics.Rect ref,
                            android.graphics.RectF r)

Create a new rectangle, initialized with the values in the specified rectangle (which is left unmodified).

Parameters:

r - The rectangle whose coordinates are copied into the new rectangle.

RelativeRectAccurate

public RelativeRectAccurate(RelativeRectAccurate r)

Create a new rectangle, initialized with the values in the specified rectangle (which is left unmodified).

Parameters:

r - The rectangle whose coordinates are copied into the new rectangle.

RelativeRectAccurate

public RelativeRectAccurate(RelativeRectFast r)

Create a new rectangle, initialized with the values in the specified rectangle (which is left unmodified).

Parameters:

r - The rectangle whose coordinates are copied into the new rectangle.

Method Detail

bottom

@NonNull
public java.math.BigDecimal bottom()

centerX

public final java.math.BigDecimal centerX()

Returns:

the horizontal center of the rectangle. This does not check for a valid rectangle (i.e. left <= right)

centerY

public final java.math.BigDecimal centerY()

Returns:

the vertical center of the rectangle. This does not check for a valid rectangle (i.e. top <= bottom)

contains

public boolean contains(java.math.BigDecimal x,
                        java.math.BigDecimal y)

Returns true if (x,y) is inside the rectangle. The left and top are considered to be inside, while the right and bottom are not. This means that for a x,y to be contained: left <= x < right and top <= y < bottom. An empty rectangle never contains any point.

Parameters:

x - The X coordinate of the point being tested for containment

y - The Y coordinate of the point being tested for containment

Returns:

true iff (x,y) are contained by the rectangle, where containment means left <= x < right and top <= y < bottom

contains

public boolean contains(java.math.BigDecimal left,
                        java.math.BigDecimal top,
                        java.math.BigDecimal right,
                        java.math.BigDecimal bottom)

Returns true iff the 4 specified sides of a rectangle are inside or equal to this rectangle. i.e. is this rectangle a superset of the specified rectangle. An empty rectangle never contains another rectangle.

Parameters:

left - The left side of the rectangle being tested for containment

top - The top of the rectangle being tested for containment

right - The right side of the rectangle being tested for containment

bottom - The bottom of the rectangle being tested for containment

Returns:

true iff the the 4 specified sides of a rectangle are inside or equal to this rectangle

contains

public boolean contains(RelativeRectAccurate r)

Returns true iff the specified rectangle r is inside or equal to this rectangle. An empty rectangle never contains another rectangle.

Parameters:

r - The rectangle being tested for containment.

Returns:

true iff the specified rectangle r is inside or equal to this rectangle

convertAspect

public java.math.BigDecimal convertAspect(java.math.BigDecimal aspect)

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getMultiRect

public MultiRect getMultiRect(android.graphics.Rect ref)

getRectF

public android.graphics.RectF getRectF(android.graphics.Rect ref)

getRectF

public android.graphics.RectF getRectF(android.graphics.RectF ref)

getRelativeRectCenterInside

@NonNull
public static RelativeRectAccurate getRelativeRectCenterInside(float imageWidthValue,
                                                                        float imageHeightValue,
                                                                        float viewWidthValue,
                                                                        float viewHeightValue)

getSourceAspect

public java.math.BigDecimal getSourceAspect()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

height

public final java.math.BigDecimal height()

Returns:

the rectangle's height. This does not check for a valid rectangle (i.e. top <= bottom) so the result may be negative.

inset

public void inset(java.math.BigDecimal dx,
                  java.math.BigDecimal dy)

Inset the rectangle by (dx,dy). If dx is positive, then the sides are moved inwards, making the rectangle narrower. If dx is negative, then the sides are moved outwards, making the rectangle wider. The same holds true for dy and the top and bottom.

Parameters:

dx - The amount to add(subtract) from the rectangle's left(right)

dy - The amount to add(subtract) from the rectangle's top(bottom)

intersect

public boolean intersect(java.math.BigDecimal left,
                         java.math.BigDecimal top,
                         java.math.BigDecimal right,
                         java.math.BigDecimal bottom)

If the rectangle specified by left,top,right,bottom intersects this rectangle, return true and set this rectangle to that intersection, otherwise return false and do not change this rectangle. No check is performed to see if either rectangle is empty. Note: To just test for intersection, use intersects()

Parameters:

left - The left side of the rectangle being intersected with this rectangle

top - The top of the rectangle being intersected with this rectangle

right - The right side of the rectangle being intersected with this rectangle.

bottom - The bottom of the rectangle being intersected with this rectangle.

Returns:

true if the specified rectangle and this rectangle intersect (and this rectangle is then set to that intersection) else return false and do not change this rectangle.

intersect

public boolean intersect(RelativeRectAccurate r)

If the specified rectangle intersects this rectangle, return true and set this rectangle to that intersection, otherwise return false and do not change this rectangle. No check is performed to see if either rectangle is empty. To just test for intersection, use intersects()

Parameters:

r - The rectangle being intersected with this rectangle.

Returns:

true if the specified rectangle and this rectangle intersect (and this rectangle is then set to that intersection) else return false and do not change this rectangle.

intersects

public boolean intersects(java.math.BigDecimal left,
                          java.math.BigDecimal top,
                          java.math.BigDecimal right,
                          java.math.BigDecimal bottom)

Returns true if this rectangle intersects the specified rectangle. In no event is this rectangle modified. No check is performed to see if either rectangle is empty. To record the intersection, use intersect() or setIntersect().

Parameters:

left - The left side of the rectangle being tested for intersection

top - The top of the rectangle being tested for intersection

right - The right side of the rectangle being tested for intersection

bottom - The bottom of the rectangle being tested for intersection

Returns:

true iff the specified rectangle intersects this rectangle. In no event is this rectangle modified.

intersects

public static boolean intersects(RelativeRectAccurate a,
                                 RelativeRectAccurate b)

Returns true iff the two specified rectangles intersect. In no event are either of the rectangles modified. To record the intersection, use intersect() or setIntersect().

Parameters:

a - The first rectangle being tested for intersection

b - The second rectangle being tested for intersection

Returns:

true iff the two specified rectangles intersect. In no event are either of the rectangles modified.

isEmpty

public final boolean isEmpty()

Returns true if the rectangle is empty (left >= right or top >= bottom)

left

@NonNull
public java.math.BigDecimal left()

limitTo

public void limitTo(java.math.BigDecimal left,
                    java.math.BigDecimal top,
                    java.math.BigDecimal right,
                    java.math.BigDecimal bottom)

limitTo

public void limitTo(java.math.BigDecimal left,
                    java.math.BigDecimal top,
                    java.math.BigDecimal right,
                    java.math.BigDecimal bottom,
                    boolean saveSize)

offset

public void offset(java.math.BigDecimal dx,
                   java.math.BigDecimal dy)

Offset the rectangle by adding dx to its left and right coordinates, and adding dy to its top and bottom coordinates.

Parameters:

dx - The amount to add to the rectangle's left and right coordinates

dy - The amount to add to the rectangle's top and bottom coordinates

offsetTo

public void offsetTo(java.math.BigDecimal newLeft,
                     java.math.BigDecimal newTop)

Offset the rectangle to a specific (left, top) position, keeping its width and height the same.

Parameters:

newLeft - The new "left" coordinate for the rectangle

newTop - The new "top" coordinate for the rectangle

printShortString

public void printShortString(java.io.PrintWriter pw)

Print short representation to given writer.

right

@NonNull
public java.math.BigDecimal right()

round

public android.graphics.Rect round(android.graphics.Rect ref)

Set the dst integer Rect by rounding this rectangle's coordinates to their nearest integer values.

round

public android.graphics.Rect round(android.graphics.RectF ref)

Set the dst integer Rect by rounding this rectangle's coordinates to their nearest integer values.

roundOut

public android.graphics.Rect roundOut(android.graphics.Rect ref)

Set the dst integer Rect by rounding "out" this rectangle, choosing the floor of top and left, and the ceiling of right and bottom.

roundOut

public android.graphics.Rect roundOut(android.graphics.RectF ref)

Set the dst integer Rect by rounding "out" this rectangle, choosing the floor of top and left, and the ceiling of right and bottom.

scale

public void scale(java.math.BigDecimal scale)

scaleInCenter

public void scaleInCenter(java.math.BigDecimal scale)

set

public void set(java.math.BigDecimal left,
                java.math.BigDecimal top,
                java.math.BigDecimal right,
                java.math.BigDecimal bottom)

Set the rectangle's coordinates to the specified values. Note: no range checking is performed, so it is up to the caller to ensure that left <= right and top <= bottom.

Parameters:

left - The X coordinate of the left side of the rectangle

top - The Y coordinate of the top of the rectangle

right - The X coordinate of the right side of the rectangle

bottom - The Y coordinate of the bottom of the rectangle

set

public void set(android.graphics.RectF ref,
                float left,
                float top,
                float right,
                float bottom)

Set the rectangle's coordinates to the specified values. Note: no range checking is performed, so it is up to the caller to ensure that left <= right and top <= bottom.

Parameters:

left - The X coordinate of the left side of the rectangle

top - The Y coordinate of the top of the rectangle

right - The X coordinate of the right side of the rectangle

bottom - The Y coordinate of the bottom of the rectangle

set

public void set(android.graphics.RectF ref,
                android.graphics.Rect src)

Copy the coordinates from src into this rectangle.

Parameters:

src - The rectangle whose coordinates are copied into this rectangle.

set

public void set(android.graphics.RectF ref,
                android.graphics.RectF src)

Copy the coordinates from src into this rectangle.

Parameters:

src - The rectangle whose coordinates are copied into this rectangle.

set

public void set(RelativeRectAccurate src)

Copy the coordinates from src into this rectangle.

Parameters:

src - The rectangle whose coordinates are copied into this rectangle.

setEmpty

public void setEmpty()

Set the rectangle to (0,0,0,0)

setIntersect

public boolean setIntersect(RelativeRectAccurate a,
                            RelativeRectAccurate b)

If rectangles a and b intersect, return true and set this rectangle to that intersection, otherwise return false and do not change this rectangle. No check is performed to see if either rectangle is empty. To just test for intersection, use intersects()

Parameters:

a - The first rectangle being intersected with

b - The second rectangle being intersected with

Returns:

true iff the two specified rectangles intersect. If they do, set this rectangle to that intersection. If they do not, return false and do not change this rectangle.

setRef

protected void setRef(android.graphics.Rect ref)

setRef

protected void setRef(android.graphics.RectF ref)

setSourceAspect

public void setSourceAspect(java.math.BigDecimal sourceAspect)

sort

public void sort()

Swap top/bottom or left/right if there are flipped (i.e. left > right and/or top > bottom). This can be called if the edges are computed separately, and may have crossed over each other. If the edges are already correct (i.e. left <= right and top <= bottom) then nothing is done.

top

@NonNull
public java.math.BigDecimal top()

toShortString

public java.lang.String toShortString()

Return a string representation of the rectangle in a compact form.

toShortString

public java.lang.String toShortString(java.lang.StringBuilder sb)

Return a string representation of the rectangle in a compact form.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

translateCoordinateSystem

public RelativeRectAccurate translateCoordinateSystem(RelativeRectAccurate newCoordinateSystem)

union

public void union(java.math.BigDecimal x,
                  java.math.BigDecimal y)

Update this Rect to enclose itself and the [x,y] coordinate. There is no check to see that this rectangle is non-empty.

Parameters:

x - The x coordinate of the point to add to the rectangle

y - The y coordinate of the point to add to the rectangle

union

public void union(java.math.BigDecimal left,
                  java.math.BigDecimal top,
                  java.math.BigDecimal right,
                  java.math.BigDecimal bottom)

Update this Rect to enclose itself and the specified rectangle. If the specified rectangle is empty, nothing is done. If this rectangle is empty it is set to the specified rectangle.

Parameters:

left - The left edge being unioned with this rectangle

top - The top edge being unioned with this rectangle

right - The right edge being unioned with this rectangle

bottom - The bottom edge being unioned with this rectangle

union

public void union(RelativeRectAccurate r)

Update this Rect to enclose itself and the specified rectangle. If the specified rectangle is empty, nothing is done. If this rectangle is empty it is set to the specified rectangle.

Parameters:

r - The rectangle being unioned with this rectangle

width

public final java.math.BigDecimal width()

Returns:

the rectangle's width. This does not check for a valid rectangle (i.e. left <= right) so the result may be negative.

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable