PhotoEditViewController Class Reference

View Properties

previewViewScrollingContainer
The scroll view that hosts the preview view.
Declaration
Swift

fileprivate(set) open var previewViewScrollingContainer: UIScrollView?
mainPreviewView
The preview view that renders the preview image.
Declaration
Swift

fileprivate(set) open var mainPreviewView: GLKView?
initialSerializedSettings
Set this property to the value returned by serializedSettings to restore those serialized settings. This needs to be set before presenting the view controller. Setting this at a later time results in undefined behavior.
Declaration
Swift

open var initialSerializedSettings: NSData?

Model Properties

toolbarItem
The toolbar item for this controller. - seealso: ToolbarItem.
Declaration
Swift

fileprivate(set) open lazy var toolbarItem: ToolbarItem = DefaultToolbarItem()
undoController
The UndoController associated with this photo edit view controller. This instance is automatically passed to the tool controllers.
Declaration
Swift

open lazy var undoController = UndoController()
spriteController
The controller that manages sprites and hosts the sprite container view.
Declaration
Swift

private(set) open var spriteController: SpriteController?

State Properties

initialPhotoEffectIdentifier
The identifier of the photo effect to apply to the photo immediately. This is useful if you pass a photo that already has an effect applied by the CameraViewController. Note that you must set this property before presenting the view controller.
Declaration
Swift

open var initialPhotoEffectIdentifier: String?
initialPhotoEffectIntensity
The intensity of the photo effect that is applied to the photo immediately. See initialPhotoEffectIdentifier for more information.
Declaration
Swift

open var initialPhotoEffectIntensity: CGFloat?
menuItems
An array of MenuItem with items that should be presented in the menu.
Declaration
Swift

public let menuItems: [MenuItem]

Other Properties

delegate
The delegate for this photo edit view controller. You should set this delegate to respond to save events and errors.
Declaration
Swift

public weak var delegate: PhotoEditViewControllerDelegate?
activeTool
The currently active tool controller, if any.
Declaration
Swift

public var activeTool: PhotoEditToolController?

Initializers


                    
                    
                    init(data:)

Creates a newly initialized photo edit view controller for the given data object with a default configuration. The data object should represent an image either in JPG or PNG format. Use this initializer to preserve EXIF data.

Declaration

Swift

public required convenience init(data: Data)

Parameters


                                data

The data of the photo to edit, either in JPG or PNG format.


                    
                    
                    init(photo:)

Creates a newly initialized photo edit view controller for the given photo with a default configuration.

Declaration

Swift

public required convenience init(photo: UIImage)

Parameters


                                photo

The photo to edit.


                    
                    
                    init(photo:configuration:)

Creates a newly initialized photo edit view controller for the given photo with the given configuration options.

Declaration

Swift

public convenience init(photo: UIImage, configuration: Configuration)

Parameters

`photo`	The photo to edit.
`configuration`	The configuration options to apply.


                    
                    
                    init(data:configuration:)

Creates a newly initialized photo edit view controller for the given data object with the given configuration. The data object should represent an image either in JPG or PNG format. Use this initializer to preserve EXIF data.

Declaration

Swift

public convenience init(data: Data, configuration: Configuration)

Parameters

`data`	The data of the photo to edit, either in JPG or PNG format.
`configuration`	The configuration options to apply.


                    
                    
                    init(photo:menuItems:configuration:)

Creates a newly initialized photo edit view controller for the given photo with the given configuration options and the given tools.

Declaration

Swift

public init(photo: UIImage, menuItems: [MenuItem], configuration: Configuration)

Parameters

`photo`	The photo to edit.
`menuItems`	The menu items to display.
`configuration`	The configuration options to apply.


                    
                    
                    init(data:menuItems:configuration:)

Creates a newly initialized photo edit view controller for the given data object with the given configuration and the given tools. The data object should represent an image either in JPG or PNG format. Use this initializer to preserve EXIF data.

Declaration

Swift

public init(data: Data, menuItems: [MenuItem], configuration: Configuration)

Parameters

`data`	The data of the photo to edit, either in JPG or PNG format.
`menuItems`	The menu items to display.
`configuration`	The configuration options to apply.

Actions


                    
                    
                    save(_:)

Applies all changes to the photo and passes the edited image to the delegate.

Declaration

Swift

open func save(_ sender: AnyObject?)

Parameters


                                sender

The object that initiated the request.


                    
                    
                    cancel(_:)

Discards all changes to the photo and calls the delegate.

Declaration

Swift

open func cancel(_ sender: AnyObject?)

Parameters


                                sender

The object that initiated the request.


                    
                    
                    init(photo:menuItems:configuration:)

Creates a photo edit view controller with the given boxed menu items. This initializer should only be used with Objective-C.

Declaration

Swift

public convenience init(photo: UIImage, menuItems: [_ObjCMenuItem], configuration: Configuration)

Parameters

`photo`	The photo to edit.
`menuItems`	The menu items to display.
`configuration`	The configuration options to apply.

initialPhotoEffectIntensityAsNSNumber
The intensity of the photo effect that is applied to the photo immediately. See initialPhotoEffectIdentifier for more information.
Declaration
Swift

public var initialPhotoEffectIntensityAsNSNumber: NSNumber?

serializedSettings
Returns a JSON as NSData, that contains all the settings regarding the rendering. I.e. what filter has been selected, what stickers were added and such.
Declaration
Swift

public var serializedSettings: NSData?