AKImageCropper
Image cropping plugin for iOS devices with support for landscape and portrait orientation. Cropper view allows to specify the location and size of the crop rectangle. Easy to set up. Has many settings for flexible integration into your project. The plugin is written in Swift.
Features:
- Easy to setup and integrate
- Crop rectangle animation (show / dismiss)
- Full image resolution
- Zoom and scroll
- Translation to landscape or portrait orientation
- Сolor customization
- Ability to draw custom crop rectangle
- Drag, Scroll, Zoom callback methods
- Changing crop rectangle callback method
Usage
Storyboard
@IBOutlet weak var cropView: AKImageCropperView!
override func viewDidLoad() {
super.viewDidLoad()
cropView.image = UIImage(named: "yourImage")
}
override func viewWillLayoutSubviews() {
super.viewWillLayoutSubviews()
// Refreshing
cropView.refresh()
}
Programmatically
var cropView: AKImageCropperView!
override func viewDidLoad() {
super.viewDidLoad()
let image = UIImage(named: "yourImage")
let frame = CGRectMake(0, 0, 300, 300)
cropView = AKImageCropperView(frame: frame, image: image, showOverlayView: false)
view.addSubview(cropView)
}
override func viewWillLayoutSubviews() {
super.viewWillLayoutSubviews()
// Refreshing
cropView.refresh()
}
Initializing
func init(frame: CGRect, image: UIImage, showOverlayView: Bool)
Parameter | Description |
---|---|
frame | The frame rectangle for the Cropper view, measured in points. The origin of the frame is relative to the superview in which you plan to add it. |
image | The image you want to crop. |
showOverlayView | Pass true to show Overlay view with crop rectangle on initialization. |
Initializes and returns a newly allocated Cropper view object with the specified frame rectangle, image to crop and Overlay view show / hide on initialization flag.
func init(image: UIImage, showOverlayView: Bool)
Parameter | Description |
---|---|
image | The image you want to crop. |
showOverlayView | Pass true to show Overlay view with crop rectangle on initialization. |
Initializes and returns a newly allocated croper view object with CGRectZero frame rectangle, image to crop and Overlay view show / hide on initialization flag.
Properties
var image: UIImage!
The image you want to crop.
The initial value of this property is nil
.
var imageView: UIImageView! {get}
Returns image view object.
Crop rectangle
var cropRect: CGRect {get}
Returns crop rectangle, measured in points. If Overlay view is active value returns crop rectangle located on the Overlay view, if not - crop rectangle will have size that eaual of scroll view and CGPointZero
origin coordinates.
var cropRectTranslatedToImage: CGRect {get}
Returns crop rectangle cropRect
translated to image with scroll view scale factor.
var cropRectMinSize: CGSize
The minimum value to which is possible to reduce the size of crop rectangle.
The initial value of this property is 30
pixels width and 30
pixels height.
var scrollView: AKImageCropperScollView! {get}
Returns scroll view object as UIScrollView
subclass. UIScrollViewDelegate
protocol can be extended in your view controller.
Configuring Overlay animation
var overlayViewAnimationDuration: NSTimeInterval
The duration of the transition animation, measured in seconds.
The initial value of this property is 300
milliseconds.
var overlayViewAnimationOptions: UIViewAnimationOptions
Specifies the supported animation curves.
The initial value of this property is CurveLinear
.
Configuring Overlay view
var fingerSize: CGFloat
// __ __ __ __ Cropper View __ __
// |
// | __ __ __ __ Scroll View __ __
// | |
// |<--->| -- Offset fingerSize / 2
// | |
// |<---- ----> -- Finger touch size "fingerSize"
// | |
A size width of finger touch. This value used to calculate a size of the outer offset for Scroll view when Overlay view will active.
The initial value of this property is 30
pixels.
var cornerOffset: Int
The distance to which will be offset corners of the crop rectangle.
The initial value of this property is 3
pixels.
var cornerSize: Int
The size of the crop rectangle corner.
The initial value of this property is 18
pixels width and 18
pixels height.
var grid: Bool
A Boolean value that determines whether the lines inside the crop rectangle will be shown.
The initial value of this property is true
.
var gridLines: Int
The number of vertical and horizontal lines inside the crop rectangle.
The initial value of this property is 2
(2
vertical and 2
horizontal lines).
var overlayColor: UIColor
Overlay view background color.
The initial value of this property is UIColor(red: 0, green: 0, blue: 0, alpha: 0.5)
(Black with 50% alpha).
var strokeColor: UIColor
The color of the outer crop rectangle line.
The initial value of this property is UIColor(red: 1, green: 1, blue: 1, alpha: 1)
(White).
var cornerColor: UIColor
The color of the corners of the crop rectangle.
The initial value of this property is UIColor(red: 1, green: 1, blue: 1, alpha: 1)
(White).
var gridColor: UIColor
The color of the vertical and horizontal lines inside the crop rectangle.
The initial value of this property is UIColor(red: 1, green: 1, blue: 1, alpha: 0.5)
(White with 50% alpha).
Overlay view state
var overlayViewIsActive {get}
Returns a boolean value that determines Overaly view state in current moment.
Managing the Delegate
weak var delegate: AKImageCropperViewDelegate?
The object that acts as the delegate of the Cropper view.
Methods
Refreshing and destroying
func refresh()
Call this method to refresh all sizes of the views that used to construct the Cropper view.
func destroy()
Call this method to destroy the Cropper view with removing itself from superview.
Crop rectangle
func setCropRect(rect: CGRect)
Parameter | Description |
---|---|
rect | The crop rectangle in the Overlay view, measured in points. The origin of the frame is relative to the Overlay view. |
Presenting crop Overlay view
func showOverlayViewAnimated(flag: Bool,
withCropFrame cropRect: CGRect!,
completion: (() -> Void)?)
Parameter | Description |
---|---|
flag | Pass true to animate the transition. |
cropRect | The crop rectangle, measured in points. The origin of the frame is relative to the Overlay view. If you may specify nil for this parameter, crop rectangle will have size that eaual of scroll view and CGPointZero origin coordinates. |
completion | The block to execute after the Overlay view is presented. This block has no return value and takes no parameters. You may specify nil for this parameter. |
Presents a Overlay view.
func dismissOverlayViewAnimated(flag: Bool,
completion: (() -> Void)?)
Parameter | Description |
---|---|
flag | Pass true to animate the transition. |
completion | The block to execute after the Overlay view is dismissed. This block has no return value and takes no parameters. You may specify nil for this parameter. |
Dismisses the Overlay view.
Get cropped image
func croppedImage() -> UIImage
Returns a cropped image.
Responding to user actions
optional func cropRectChanged(rect: CGRect)
Parameter | Description |
---|---|
rect | New crop rectangle origin and size. |
Tells the delegate when the crop rectangle was changed.
Draw crop rectagle
optional func overlayViewDrawInTopLeftCropRectCornerPoint(point: CGPoint)
Parameter | Description |
---|---|
point | Point where will placed corner. |
Draws corner in the Overlay view context in top left corner of the crop rectangle.
optional func overlayViewDrawInTopRightCropRectCornerPoint(point: CGPoint)
Parameter | Description |
---|---|
point | Point where will placed corner. |
Draws corner in the Overlay view context in top right corner of the crop rectangle.
optional func overlayViewDrawInBottomRightCropRectCornerPoint(point: CGPoint)
Parameter | Description |
---|---|
point | Point where will placed corner. |
Draws corner in the Overlay view context in bottom right corner of the crop rectangle.
optional func overlayViewDrawInBottomLeftCropRectCornerPoint(point: CGPoint)
Parameter | Description |
---|---|
point | Point where will placed corner. |
Draws corner in the Overlay view context in bottom left corner of the crop rectangle.
optional func overlayViewDrawStrokeInCropRect(cropRect: CGRect)
Parameter | Description |
---|---|
cropRect | Crop rectangle origin and size. |
Draws outer stroke line for the crop rectangle in the Overlay view context.
optional func overlayViewDrawGridInCropRect(cropRect: CGRect)
Parameter | Description |
---|---|
cropRect | Crop rectangle origin and size. |
Draws grid lines inside the crop rectangle in the Overlay view context.
Please do not forget to star this repository and follow me.
Author
Artem Krachulov: www.artemkrachulov.com, email artem.krachulov@gmail.com
License
Released under the MIT license