jp.wasabeef.picasso.transformations

Class CropTransformation

java.lang.Object

jp.wasabeef.picasso.transformations.CropTransformation

All Implemented Interfaces:

com.squareup.picasso.Transformation

public class CropTransformation
extends java.lang.Object
implements com.squareup.picasso.Transformation

Crops a rectangle, allowing its dimensions and positioning to be specified by a combination of: width/height in pixels width/height as a ratio of the source image aspect ratio offset from left/top in pixels horizontal and vertical gravity If aspect ratio is provided then both width and height should not be provided or the ratio wil be ignored. If neither width or height are provided then the aspect ratio is used to crop the largest possible image. Constructors accepting width and height expect pixels if the values are ints and ratio of source image if the values are floats.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CropTransformation.GravityHorizontal
static class	CropTransformation.GravityVertical

Constructor Summary

Constructors

Constructor and Description
CropTransformation(float aspectRatio, CropTransformation.GravityHorizontal gravityHorizontal, CropTransformation.GravityVertical gravityVertical) Crops to the largest image that will fit the given aspectRatio.
CropTransformation(float widthRatio, float heightRatio) Crops to a ratio of the source image's width/height, defaulting to CENTER/CENTER gravity.
CropTransformation(float widthRatio, float heightRatio, CropTransformation.GravityHorizontal gravityHorizontal, CropTransformation.GravityVertical gravityVertical) Crops to a ratio of the source image's width/height.
CropTransformation(float widthRatio, float heightRatio, float aspectRatio, CropTransformation.GravityHorizontal gravityHorizontal, CropTransformation.GravityVertical gravityVertical) Crops to the desired aspectRatio driven by either width OR height as a ratio to the original image's dimension.
CropTransformation(int width, int height) Crops to the given width and height (in pixels), defaulting gravity to CENTER/CENTER.
CropTransformation(int width, int height, CropTransformation.GravityHorizontal gravityHorizontal, CropTransformation.GravityVertical gravityVertical) Crops to the given width and height (in pixels) using the given gravity.
CropTransformation(int width, int height, float aspectRatio, CropTransformation.GravityHorizontal gravityHorizontal, CropTransformation.GravityVertical gravityVertical) Crops to the desired aspectRatio driven by either width OR height in pixels.
CropTransformation(int left, int top, int width, int height) Crops to the given size and offset in pixels.

Method Summary

Modifier and Type	Method and Description
java.lang.String	key()
android.graphics.Bitmap	transform(android.graphics.Bitmap source)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CropTransformation

public CropTransformation(int left,
                          int top,
                          int width,
                          int height)

Crops to the given size and offset in pixels. If either width or height is zero then the original image's dimension is used.

Parameters:

left - offset in pixels from the left edge of the source image

top - offset in pixels from the top of the source image

width - in pixels

height - in pixels

CropTransformation

public CropTransformation(int width,
                          int height,
                          CropTransformation.GravityHorizontal gravityHorizontal,
                          CropTransformation.GravityVertical gravityVertical)

Crops to the given width and height (in pixels) using the given gravity. If either width or height is zero then the original image's dimension is used.

Parameters:

width - in pixels

height - in pixels

gravityHorizontal - position of the cropped area within the larger source image

gravityVertical - position of the cropped area within the larger source image

CropTransformation

public CropTransformation(int width,
                          int height)

Crops to the given width and height (in pixels), defaulting gravity to CENTER/CENTER. If either width or height is zero then the original image's dimension is used.

Parameters:

width - in pixels

height - in pixels

CropTransformation

public CropTransformation(float widthRatio,
                          float heightRatio,
                          CropTransformation.GravityHorizontal gravityHorizontal,
                          CropTransformation.GravityVertical gravityVertical)

Crops to a ratio of the source image's width/height. e.g. (0.5, 0.5, LEFT, TOP) will crop a quarter-sized box from the top left of the original. If widthRatio or heightRatio are zero then 100% of the original image's dimension will be used.

Parameters:

widthRatio - width of the target image relative to the width of the source image; 1 = 100%

heightRatio - height of the target image relative to the height of the source image; 1 = 100%

gravityHorizontal - position of the cropped area within the larger source image

gravityVertical - position of the cropped area within the larger source image

CropTransformation

public CropTransformation(float widthRatio,
                          float heightRatio)

Crops to a ratio of the source image's width/height, defaulting to CENTER/CENTER gravity. e.g. (0.5, 0.5) will crop a quarter-sized box from the middle of the original. If widthRatio or heightRatio are zero then 100% of the original image's dimension will be used.

Parameters:

widthRatio - width of the target image relative to the width of the source image; 1 = 100%

heightRatio - height of the target image relative to the height of the source image; 1 = 100%

CropTransformation

public CropTransformation(int width,
                          int height,
                          float aspectRatio,
                          CropTransformation.GravityHorizontal gravityHorizontal,
                          CropTransformation.GravityVertical gravityVertical)

Crops to the desired aspectRatio driven by either width OR height in pixels. If one of width/height is greater than zero the other is calculated If width and height are both zero then the largest area matching the aspectRatio is returned If both width and height are specified then the aspectRatio is ignored If aspectRatio is 0 then the result will be the same as calling the version without aspectRatio.

Parameters:

width - in pixels, one of width/height should be zero

height - in pixels, one of width/height should be zero

aspectRatio - width/height: greater than 1 is landscape, less than 1 is portrait, 1 is square

gravityHorizontal - position of the cropped area within the larger source image

gravityVertical - position of the cropped area within the larger source image

CropTransformation

public CropTransformation(float widthRatio,
                          float heightRatio,
                          float aspectRatio,
                          CropTransformation.GravityHorizontal gravityHorizontal,
                          CropTransformation.GravityVertical gravityVertical)

Crops to the desired aspectRatio driven by either width OR height as a ratio to the original image's dimension. If one of width/height is greater than zero the other is calculated If width and height are both zero then the largest area matching the aspectRatio is returned If both width and height are specified then the aspectRatio is ignored If aspectRatio is 0 then the result will be the same as calling the version without aspectRatio. e.g. to get an image with a width of 50% of the source image's width and cropped to 16:9 from the center/center: CropTransformation(0.5, (float)0, (float)16/9, CENTER, CENTER);

Parameters:

widthRatio - width of the target image relative to the width of the source image; 1 = 100%

heightRatio - height of the target image relative to the height of the source image; 1 = 100%

aspectRatio - width/height: greater than 1 is landscape, less than 1 is portrait, 1 is square

gravityHorizontal - position of the cropped area within the larger source image

gravityVertical - position of the cropped area within the larger source image

CropTransformation

public CropTransformation(float aspectRatio,
                          CropTransformation.GravityHorizontal gravityHorizontal,
                          CropTransformation.GravityVertical gravityVertical)

Crops to the largest image that will fit the given aspectRatio. This will effectively chop off either the top/bottom or left/right of the source image.

Parameters:

aspectRatio - width/height: greater than 1 is landscape, less than 1 is portrait, 1 is square

gravityHorizontal - position of the cropped area within the larger source image

gravityVertical - position of the cropped area within the larger source image

Method Detail

transform

public android.graphics.Bitmap transform(android.graphics.Bitmap source)

Specified by:

transform in interface com.squareup.picasso.Transformation

key

public java.lang.String key()

Specified by:

key in interface com.squareup.picasso.Transformation