com.facebook.spectrum.requirements

Class CropRequirement

java.lang.Object

com.facebook.spectrum.requirements.CropRequirement

@Immutable
public abstract class CropRequirement
extends java.lang.Object

Defines how an image should be cropped. The CropRequirement can be expressed in absolute or relative coordinates.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	mustBeExact True if the crop has to be exact.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	hashCode()
static CropRequirement	makeAbsoluteToOrigin(int left, int top, int right, int bottom, boolean mustBeExact) Crop requirement based on absolute offsets to the origin plane (left or top).
static CropRequirement	makeAbsoluteToOrigin(android.graphics.Rect cropRect, boolean mustBeExact) Crop requirement based on absolute offsets to the origin plane (left or top).
static CropRequirement	makeRelativeToOrigin(float left, float top, float right, float bottom, boolean mustBeExact) Relative offsets to crop off the image.
static CropRequirement	makeRelativeToOrigin(android.graphics.RectF cropRect, boolean mustBeExact) Relative offsets to crop off the image.
abstract java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

mustBeExact

public final boolean mustBeExact

True if the crop has to be exact. Non exact crop can be more efficient.

Method Detail

makeAbsoluteToOrigin

public static CropRequirement makeAbsoluteToOrigin(int left,
                                                   int top,
                                                   int right,
                                                   int bottom,
                                                   boolean mustBeExact)

Crop requirement based on absolute offsets to the origin plane (left or top).

Parameters:

mustBeExact - True if the crop has to be exact. Non exact crop can be more efficient.

makeAbsoluteToOrigin

public static CropRequirement makeAbsoluteToOrigin(android.graphics.Rect cropRect,
                                                   boolean mustBeExact)

Crop requirement based on absolute offsets to the origin plane (left or top).

Parameters:

mustBeExact - True if the crop has to be exact. Non exact crop can be more efficient.

makeRelativeToOrigin

public static CropRequirement makeRelativeToOrigin(float left,
                                                   float top,
                                                   float right,
                                                   float bottom,
                                                   boolean mustBeExact)

Relative offsets to crop off the image. Each offset is relative to their axis'length and the top/left edge. For example, {0, 0.5, 1.0, 1.0} would return the top right quarter of the image.

This can be handy if one does not know the absolute dimensions of an image.

Parameters:

mustBeExact - True if the crop has to be exact. Non exact crop can be more efficient.

makeRelativeToOrigin

public static CropRequirement makeRelativeToOrigin(android.graphics.RectF cropRect,
                                                   boolean mustBeExact)

Relative offsets to crop off the image. Each offset is relative to their axis'length and the top/left edge. For example, {0, 0, 0.5, 0.5} would return the top left quarter of the image.

This can be handy if one does not know the absolute dimensions of an image.

Parameters:

mustBeExact - True if the crop has to be exact. Non exact crop can be more efficient.

toString

public abstract java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object