Other Classes

The following classes are available globally.

  • Provides functions to import fonts added as resources. It also registers them, so that the application can load them like any other pre-installed font.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKFontImporter)
    open class FontImporter : NSObject
  • Applies a gaussian focus to an instance of CIImage.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKGaussianFocusFilter)
    open class GaussianFocusFilter : CIFilter
  • Applies a gradient focus to an instance of CIImage.

    Important

    This gradient focus filter is actually the ‘linear’ focus in the serialization, but for legacy reasons the old name was kept. This will most likely be subject to change in a future major version update of the PhotoEditor SDK.
    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKGradientFocusFilter)
    open class GradientFocusFilter : CIFilter
  • This filter applies an overlay to an image.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKOverlayFilter)
    open class OverlayFilter : CIFilter
  • This filter changes the sharpness of an image.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKSharpnessFilter)
    open class SharpnessFilter : CIFilter
  • This class provides our own implementation of adjustment filters. Using these we get more consistant results across the several platforms.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKSpriteAdjustmentsFilter)
    open class SpriteAdjustmentsFilter : CIFilter
  • This filter changes the temperature of an image.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKTemperatureFilter)
    open class TemperatureFilter : CIFilter
  • Wrapper class that manages deserialization of settings files and delegates work to the different implementations for each major version.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKDeserializer)
    public class Deserializer : NSObject
  • The Serializer class is used to serialize a PhotoEditModel object into a Data object.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    public class Serializer
  • An AssetManager can be used to cache UIImage and CIImage instances and to download and cache image assets.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKAssetManager)
    open class AssetManager : NSObject
  • An ImageAsset object can be used together with an AssetManager to cache an UIImage or a CIImage object and an optional user info dictionary.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKImageAsset)
    open class ImageAsset : NSObject
  • A RoundGenerator generates a round stamp image with a given hardness.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKRoundGenerator)
    open class RoundGenerator : StampGenerator
  • A StampGenerator is responsible for generating a stamp image that is used by a brush to draw a stroke.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKStampGenerator)
    open class StampGenerator : NSObject
  • A Brush holds all information needed to render a stroke.

    Declaration

    Swift

    @objc(PESDKBrush)
    open class Brush : NSObject
  • A Painting manages the shaders, textures, vertices and framebuffers involved in a single painting.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKPainting)
    open class Painting : NSObject
  • A PaintingFragment holds the data to redraw a certain part of a Painting. This is mainly used for fast and efficient undo and redo.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKPaintingFragment)
    open class PaintingFragment : NSObject
  • A Texture manages an OpenGL texture. It is responsible for allocating and deallocting the necessary memory.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKTexture)
    open class Texture : NSObject
  • A FreehandTool is responsible for creating vertices for a freehand drawing.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKFreehandTool)
    open class FreehandTool : Tool
  • A Tool is an abstract base class. Currently FreehandTool is the only concrete subclass and it is used to handle touch events and draw primitives.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKTool)
    open class Tool : NSObject
  • The CameraController class provides functions for several camera related tasks, including setup, flash control, and such.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKCameraController)
    open class CameraController : NSObject
  • Used to determine device orientation even if orientation lock is active.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKDeviceOrientationController)
    open class DeviceOrientationController : NSObject
  • A FilterSelectionController contains everything that is needed to display a list of available filters.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKFilterSelectionController)
    open class FilterSelectionController : NSObject
  • AnimationDelegate can be used as the delegate of a CAAnimation to easily specify a completion block.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKAnimationDelegate)
    open class AnimationDelegate : NSObject, CAAnimationDelegate
  • The configuration builder object offers all properties of Configuration in a mutable version, in order to build an immutable Configuration object. To further configure the different viewcontrollers, use the configureXYZViewController methods to edit the given options.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKConfigurationBuilder)
    open class ConfigurationBuilder : NSObject
  • The default SnappingOptionsBuilder for SnappingOptions.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKSnappingOptionsOptionsBuilder)
    open class SnappingOptionsBuilder : NSObject
  • An icon generator can be used to generate various icons.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKIconGenerator)
    open class IconGenerator : NSObject
  • Represents a color and a matching name for accessibility.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKColor)
    open class Color : NSObject
  • Represents a color that can be changed with the color pipette.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKColorPipette)
    open class PipettableColor : Color
  • Represents a collection of colors.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKColorPalette)
    open class ColorPalette : NSObject
  • A class that holds a weak reference to some object.

    See more

    Declaration

    Swift

    open class WeakContainer<T>
  • A DefaultToolbarItem is a toolbar item with a label in the center and a default discard button on the left and apply button on the right. It is used in most tool controllers.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKDefaultToolbarItem)
    open class DefaultToolbarItem : ToolbarItem
  • The MediaEditPreviewController is responsible for previewing changes to visual media and displaying the asset in a scrollable container. It’s an abstract base class used by PhotoEditPreviewController and VideoEditPreviewController. You should not instantiate this class directly.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKMediaEditPreviewController)
    open class MediaEditPreviewController : ViewController
  • A MediaEditViewController 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).

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKMediaEditViewController)
    open class MediaEditViewController : ViewController
  • A SliderContainerController displays a slider at the bottom of its view. It can also contain a UIViewController. It is supposed to be contained in a tool controller and is added above a PhotoEditPreviewController.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    open class SliderContainerController<SliderType, CVC> : ViewController where SliderType : Slider, CVC : UIViewController
  • A ViewController includes some debugging helpers to ensure that no strong reference cycles exist in the controller. Those helpers are only active in Debug builds.

    Declaration

    Swift

    @objcMembers
    @objc(PESDKViewController)
    open class ViewController : UIViewController
  • A view that displays a ColorPalette within a collection view.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKColorCollectionView)
    open class ColorCollectionView : UIView
  • A ColorPipetteOverlayView is responsible to draw the UI of a ColorPipetteView. This overlay consists of a circular border that highlights the selected color and a crosshair in the middle to facilitate precise color selection.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKColorPipetteOverlayView)
    open class ColorPipetteOverlayView : UIView
  • A DimmedLabel is a subclass of Label, which allows to restrict appearance proxy calls to a subset of all labels that are instances of this class.

    Declaration

    Swift

    @objcMembers
    @objc(PESDKDimmedLabel)
    open class DimmedLabel : Label
  • A DimmingView is a subclass of UIView, which allows to restrict appearance proxy calls to a subset of all views that are instances of this class.

    Declaration

    Swift

    @objcMembers
    @objc(PESDKDimmingView)
    open class DimmingView : UIView
  • A Label is a subclass of UILabel, which allows to restrict appearance proxy calls to a subset of all labels that are instances of this class.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKLabel)
    open class Label : UILabel
  • A LineView is a subclass of UIView, which allows to restrict appearance proxy calls to a subset of all views that are instances of this class.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKLineView)
    open class LineView : UIView
  • A MarkerView is a subclass of UIView, which allows to restrict appearance proxy calls to a subset of all views that are instances of this class.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKMarkerView)
    open class MarkerView : UIView
  • A view that hosts accessory UI elements above a MenuCollectionView. It is used to define the accessory’s backgroundColor and to configure UI elements that depend on it.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKMenuAccessoryContainerView)
    open class MenuAccessoryContainerView : UIView
  • A DimmedLabel is a subclass of Label, which allows to restrict appearance proxy calls to a subset of all labels that are instances of this class.

    Declaration

    Swift

    @objcMembers
    @objc(PESDKPrimaryLabel)
    open class PrimaryLabel : Label
  • A EffectThumbnailRenderer can be used to generate thumbnails of a given input image for multiple effects.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKEffectThumbnailRenderer)
    open class EffectThumbnailRenderer : NSObject
  • This class represents a linear gradient control view. It is used within the focus tool to visualize the chosen focus parameters.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKLinearGradientView)
    open class LinearGradientView : FocusGradientView
  • A framebuilder for custom patches. Each patch consists of four groups. There are two basic layouts. The first one places the top and bottom group above the full width of the image, and the left and right group in between. The second layout works the other way around.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKCustomPatchFrameBuilder)
    open class CustomPatchFrameBuilder : NSObject, FrameBuilder
  • The menu item that is used in FrameOptionToolController.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKFrameOptionMenuItem)
    open class FrameOptionMenuItem : NSObject, MenuItem
  • The configuration for the build engine.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKCustomPatchConfiguration)
    open class CustomPatchConfiguration : NSObject
  • This class provides the methods to generate the dynamic frame-builders provided by the SDK.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKDefaultDynamicFrames)
    open class DefaultDynamicFrames : NSObject
  • This class represents a group of the images.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PESDKFrameImageGroup)
    open class FrameImageGroup : NSObject
  • This layout is included for compatibility of TextDesign serialization v3.0.0 ..< v3.1.1 Please do not use directly.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKTextDesignBlocksLight_V3_1_0)
    public class TextDesignBlocksLight_V3_1_0 : TextDesignBlocksLight
  • This layout is included for compatibility of TextDesign serialization v3.0.0 ..< v3.1.1 Please do not use directly.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKTextDesignSunshine_V3_1_0)
    public class TextDesignSunshine_V3_1_0 : TextDesignSunshine
  • A TouchingGestureRecognizer is a simple UIGestureRecognizer subclass that counts the number of touches on the associated view.

    Declaration

    Swift

    @objcMembers
    @objc(PESDKTouchingGestureRecognizer)
    open class TouchingGestureRecognizer : UIGestureRecognizer
  • Wrapper class for FloatValue. This should only be used if you are using Objective-C.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKFloatValue)
    public final class _ObjCFloatValue : NSObject
  • This class should only be used if you are using Objective-C. It is a wrapper class for AdjustmentModel. For more information about the type, please take a look at the documentation for AdjustmentModel.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKAdjustmentModel)
    public final class _ObjCAdjustmentModel : NSObject
  • This class should only be used if you are using Objective-C. It is a wrapper class for BrushSpriteModel. For more information about the type, please take a look at the documentation for BrushSpriteModel.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKBrushSpriteModel)
    public final class _ObjCBrushSpriteModel : _ObjCSpriteModel
  • This class should only be used if you are using Objective-C. It is a wrapper class for EffectFilterModel. For more information about the type, please take a look at the documentation for EffectFilterModel.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKEffectFilterModel)
    public final class _ObjCEffectFilterModel : NSObject
  • This class should only be used if you are using Objective-C. It is a wrapper class for FocusModel. For more information about the type, please take a look at the documentation for FocusModel.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKFocusModel)
    public final class _ObjCFocusModel : NSObject
  • This class should only be used if you are using Objective-C. It is a wrapper class for FrameSpriteModel. For more information about the type, please take a look at the documentation for FrameSpriteModel.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKFrameSpriteModel)
    public final class _ObjCFrameSpriteModel : _ObjCSpriteModel
  • This class should only be used if you are using Objective-C. It is a wrapper class for OverlayModel. For more information about the type, please take a look at the documentation for OverlayModel.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKOverlayModel)
    public final class _ObjCOverlayModel : NSObject
  • This class should only be used if you are using Objective-C. It is a wrapper class for PathModel. For more information about the type, please take a look at the documentation for PathModel.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKPathModel)
    public final class _ObjCPathModel : _ObjCSpriteModel
  • This class should only be used if you are using Objective-C. It is a wrapper class for PhotoEditModel. For more information about the type, please take a look at the documentation for PhotoEditModel.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKPhotoEditModel)
    public final class _ObjCPhotoEditModel : NSObject
  • This class should only be used if you are using Objective-C. It is a wrapper class for SpriteModel. For more information about the type, please take a look at the documentation for SpriteModel.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKSpriteModel)
    public class _ObjCSpriteModel : NSObject
  • This class should only be used if you are using Objective-C. It is a wrapper class for StickerSpriteModel. For more information about the type, please take a look at the documentation for StickerSpriteModel.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKStickerSpriteModel)
    public final class _ObjCStickerSpriteModel : _ObjCSpriteModel
  • This class should only be used if you are using Objective-C. It is a wrapper class for TextDesignSpriteModel. For more information about the type, please take a look at the documentation for TextDesignSpriteModel.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKTextDesignSpriteModel)
    public final class _ObjCTextDesignSpriteModel : _ObjCSpriteModel
  • This class should only be used if you are using Objective-C. It is a wrapper class for TextSpriteModel. For more information about the type, please take a look at the documentation for TextSpriteModel.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKTextSpriteModel)
    public final class _ObjCTextSpriteModel : _ObjCSpriteModel
  • This class should only be used if you are using Objective-C. It is a wrapper class for Theme. For more information about the type, please take a look at the documentation for Theme.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKTheme)
    public final class _ObjCTheme : NSObject
  • This class should only be used if you are using Objective-C. It is a wrapper class for TransformModel. For more information about the type, please take a look at the documentation for TransformModel.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKTransformModel)
    public final class _ObjCTransformModel : NSObject
  • This class should only be used if you are using Objective-C. It is a wrapper class for TrimModel. For more information about the type, please take a look at the documentation for TrimModel.

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKTrimModel)
    public final class _ObjCTrimModel : NSObject
  • Wrapper class for PhotoEditMenuItem. This should only be used if you are using Objective-C.

    See more

    Declaration

    Swift

    @available(iOS 9.0, *)
    @objcMembers
    @objc(PESDKPhotoEditMenuItem)
    public final class _ObjCPhotoEditMenuItem : NSObject