PhotoEditViewController

@available(iOS 9.0, *)
@objcMembers
@objc(PESDKPhotoEditViewController)
open class PhotoEditViewController : ViewController

A PhotoEditViewController is the main starting point for the SDK. It displays the rendered photo and a menu. It can present PhotoEditToolController objects and react to changes. It can be presented on its own (thus displaying a toolbar for navigation at the bottom) or be embedded into a UINavigationController (thus using the navigation controller’s navigation bar for navigation).

  • The undo button that is displayed in the editor.

    Declaration

    Swift

    open private(set) var undoButton: OverlayButton?
  • The redo button that is displayed in the editor.

    Declaration

    Swift

    open private(set) var redoButton: OverlayButton?
  • All overlay buttons that are displayed in the editor. This includes undoButton and redoButtton.

    Declaration

    Swift

    open private(set) var overlayButtons: [OverlayButton]
  • Presents the tool that is represented by the given ToolMenuItem. You must only call this when the editor is already on-screen.

    Declaration

    Swift

    open func presentTool(for toolMenuItem: ToolMenuItem)

    Parameters

    toolMenuItem

    The tool menu item whose represented tool should be presented.

  • Applies all changes to the high resolution image and calls the delegate methods.

    Declaration

    Swift

    open func renderHighResolutionImage()
  • The tools that are currently on the stack.

    Declaration

    Swift

    open private(set) var viewControllers: [PhotoEditToolController]
  • Pushes a new tool onto the tool stack and presents its view.

    Declaration

    Swift

    @objc(pushViewController:animated:completion:)
    open func push(_ viewController: PhotoEditToolController, animated: Bool, completion: (() -> Void)? = nil)

    Parameters

    viewController

    The tool controller to present.

    animated

    Whether to show this tool animated or not.

    completion

    A closure that is executed after the presentation animation is finished.

  • Pops the top view controller from the stack and removes its view.

    Declaration

    Swift

    @discardableResult
    @objc(popViewControllerAnimated:completion:)
    open func pop(animated: Bool, completion: (() -> Void)? = nil) -> PhotoEditToolController?

    Parameters

    animated

    Whether to animate the transition or not.

    completion

    A closure that is executed after the dismissal animation.

    Return Value

    The tool that was popped from the stack, if any.

  • Creates a new PhotoEditViewController for the given Photo and the given configuration, using the default menu items and photo edit model.

    Declaration

    Swift

    convenience init(photoAsset: Photo, configuration: Configuration)

    Parameters

    photoAsset

    The photo to edit.

    configuration

    The configuration options to apply.

  • Creates a new PhotoEditViewController for the given Photo, the given configuration, menu items and photo edit model.

    Attention

    This initializer should only be used with Objective-C.

    Declaration

    Swift

    convenience init(photoAsset: Photo, configuration: Configuration, menuItems: [_ObjCPhotoEditMenuItem], photoEditModel: _ObjCPhotoEditModel)

    Parameters

    photoAsset

    The photo to edit.

    configuration

    The configuration options to apply.

    menuItems

    The menu items to display.

    photoEditModel

    The initial photo edit model to apply to the photo.