Classes

The following classes are available globally.

  • AnimationDelegate can be used as the delegate of a CAAnimation to easily specify a completion block.

    See more

    Declaration

    Swift

    @objc(IMGLYAnimationDelegate) open class AnimationDelegate: NSObject, CAAnimationDelegate
  • A TextLabel is used to show text that has been added to an image and provides improved support for accessibility.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    @objc(IMGLYFilterSelectionController) open class FilterSelectionController: NSObject
  • The CameraViewController class provides a dialog to perform serveral tasks regarding the camera. These include taking photos, switching on the flash, and such.

    See more

    Declaration

    Swift

    @objc(IMGLYCameraViewController) open class CameraViewController: UIViewController
  • A RoundGenerator generates a round stamp image with a given hardness.

    See more

    Declaration

    Swift

    @objc(IMGLYRoundGenerator) open class RoundGenerator: StampGenerator
  • Applies a linear focus to an instance of CIImage.

    See more

    Declaration

    Swift

    @objc(IMGLYLinearFocusFilter) open class LinearFocusFilter: CIFilter
  • A BrushColorToolController is reponsible for displaying the UI to adjust the color of the brush that will be drawn on the image.

    Declaration

    Swift

    @objc(IMGLYBrushColorToolController) open class BrushColorToolController: ColorToolController
  • The CameraController class provides functions for serveral camera related tasks, including setup, flash control, and such.

    See more

    Declaration

    Swift

    @objc(IMGLYCameraController) open class CameraController: NSObject
  • 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

    @objc(IMGLYFontImporter) open class FontImporter: NSObject
  • The PhotoEffect class describes an effect that can be applied to a photo.

    See more

    Declaration

    Swift

    @objc(IMGLYPhotoEffect) open class PhotoEffect: NSObject
  • A TextOptionsToolController is reponsible for displaying the UI to adjust text that has been added to an image.

    Declaration

    Swift

    @objc(IMGLYTextOptionsToolController) open class TextOptionsToolController: StackLayoutToolController
  • A StickerCategory represents one category of stickers. Each category has a preview image and multiple stickers associated with it. To support accessibility you should also set its accessibilityLabel.

    See more

    Declaration

    Swift

    @objc(IMGLYStickerCategory) open class StickerCategory: NSObject
  • A ColorCollectionViewCell is a cell that shows a solid color and an image view on top of that color when the cell is selected. It also has a selectionIndicator to show whether or not the cell is currently selected.

    See more

    Declaration

    Swift

    @objc(IMGLYColorCollectionViewCell) open class ColorCollectionViewCell: UICollectionViewCell
  • The FontSelectorView is a subclass of UIScrollView that presents a scrollable list of fonts.

    See more

    Declaration

    Swift

    @objc(IMGLYFontSelectorView) open class FontSelectorView: UIScrollView
  • A SliderTooltip object is a visual element that displays a Slider’s current value above the thumb image while dragging.

    See more

    Declaration

    Swift

    open class SliderTooltip: UIView
  • A frame data source provides the frames that should be displayed in the frame tool.

    See more

    Declaration

    Swift

    @objc(IMGLYFrameDataSource) open class FrameDataSource: NSObject
  • An AdjustToolController is reponsible for displaying the UI to adjust the brightness, contrast and saturation of an image.

    Declaration

    Swift

    @objc(IMGLYAdjustToolController) open class AdjustToolController: StackLayoutToolController
  • A CropHandleView represents the interactive, draggable part of a crop rect.

    See more

    Declaration

    Swift

    @objc(IMGLYCropHandleView) open class CropHandleView: UIView
  • The CropOverlayView is added above the CropAndStraightenView to display the UI elements to adjust the crop rect and hosts the mask views to dim the content that is outside the crop rect.

    See more

    Declaration

    Swift

    @objc(IMGLYCropOverlayView) open class CropOverlayView: UIView
  • A TooltipSlider object is a visual control used to select a single value from a continuous range of values. Sliders are always displayed as horizontal bars. An indicator, or thumb, notes the current value of the slider and can be moved by the user to change the setting. A vertical indicator, or neutral point, notes the default, unchanged value of the slider. Additionally a TooltipSlider also presents a tooltip above the thumb image that displays the current selected value while dragging.

    See more

    Declaration

    Swift

    open class TooltipSlider: Slider
  • Builds a four patch frame, by spiltting the frame asset in four pieces and paint it onto the UIImage. The pieces are cropped at the insides to match the image ratio. The input image must have a ratio of 1:1. The algorithm to place and crop, each piece, leaves the sides of the asset uncropped that touch the longer side of the image. The other sides get cropped, starting from the middle, so that the corners of the asset, is touching the corners of the composet image. One could say the asset that is used as base, for the composition is pushed together along the x or y axis, depending on the ratio of, the given size.

    See more

    Declaration

    Swift

    @objc(IMGLYFourPatchFrameBuilder) open class FourPatchFrameBuilder: NSObject, FrameBuilder
  • A BorderedCollectionViewCell is a cell that shows a border around the cell.

    See more

    Declaration

    Swift

    @objc(IMGLYBorderedCollectionViewCell) open class BorderedCollectionViewCell: UICollectionViewCell
  • A ToolbarButton should be used within an instance of Toolbar. It automatically styles itself to display touch events.

    Declaration

    Swift

    @objc(IMGLYToolbarButton) open class ToolbarButton: Button
  • A Sticker represents a single sticker in a sticker category. Each sticker needs an image and a thumbnail image. If no thumbnail is provided, it is automatically generated.

    See more

    Declaration

    Swift

    @objc(IMGLYSticker) open class Sticker: NSObject
  • A ScalePicker provides an UI element to pick values.

    See more

    Declaration

    Swift

    @objc(IMGLYScalePicker) open class ScalePicker: UIView
  • The CanvasView is responsible for presenting a painting and handling touch events related to paintings.

    See more

    Declaration

    Swift

    @objc(IMGLYCanvasView) open class CanvasView: GLKView
  • This class represents a circle gradient control view. It is used within the focus tool to visualize the chosen focus parameters.

    Declaration

    Swift

    @objc(IMGLYCircleGradientView) open class CircleGradientView: FocusGradientView
  • This class provides the methods to generate the dynamic frame-builders provided by the SDK.

    See more

    Declaration

    Swift

    @objc(IMGLYDefaultDynamicFrames) open class DefaultDynamicFrames: NSObject
  • A MenuCollectionView is a subclass of UICollectionView configured to be used as the menu of a tool controller.

    See more

    Declaration

    Swift

    @objc(IMGLYMenuCollectionView) open class MenuCollectionView: UICollectionView
  • A view that extends the default UIView by passthrough views.

    See more

    Declaration

    Swift

    @objc(IMGLYView) open class View: UIView
  • A FilterCollectionViewCell is a cell that shows an image (usually with a filter applied to it) and a label at the bottom. When selected the cell has an overlay, a label for the intensity and an selection indicator.

    See more

    Declaration

    Swift

    @objc(IMGLYFilterCollectionViewCell) open class FilterCollectionViewCell: UICollectionViewCell
  • A ToolbarItem hosts views which are displayed in the toolbar of a ToolbarController. If the toolbar controller is embedded into an UINavigationController, those views are added to the navigation controller’s navigation bar.

    See more

    Declaration

    Swift

    @objc(IMGLYToolbarItem) open class ToolbarItem: NSObject
  • 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

    @objc(IMGLYDefaultToolbarItem) open class DefaultToolbarItem: ToolbarItem
  • A GradientView shows a linear gradient from its top to its bottom.

    See more

    Declaration

    Swift

    @objc(IMGLYGradientView) open class GradientView: UIView
  • 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

    @objc(IMGLYTool) open class Tool: NSObject
  • A Button is a subclass of UIButton, which supports running a closure for a given control event and has the ability to specify a touch area inset.

    See more

    Declaration

    Swift

    @objc(IMGLYButton) open class Button: UIButton
  • A sticker category data source provides the sticker categories that should be displayed in the sticker tool.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    @objc(IMGLYPainting) open class Painting: NSObject
  • A PhotoEditViewController is responsible for presenting and rendering an edited image.

    See more

    Declaration

    Swift

    @objc(IMGLYPhotoEditViewController) open class PhotoEditViewController: UIViewController
  • A Texture manages an OpenGL texture. It is responsible for allocating and deallocting the necessary memory.

    See more

    Declaration

    Swift

    @objc(IMGLYTexture) open class Texture: NSObject
  • A StickerColorToolController is responsible for displaying the UI to adjust the color of a sticker that has been added to an image.

    Declaration

    Swift

    @objc(IMGLYStickerColorToolController) open class StickerColorToolController: ColorToolController
  • This class represents a group of the images.

    See more

    Declaration

    Swift

    @objc(IMGLYFrameImageGroup) open class FrameImageGroup: NSObject
  • The configuration for the build engine.

    See more

    Declaration

    Swift

    @objc(IMGLYCustomPatchConfiguration) open class CustomPatchConfiguration: NSObject
  • 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

    @objc(IMGLYCustomPatchFrameBuilder) open class CustomPatchFrameBuilder: NSObject, FrameBuilder
  • A BoxedMenuItem wraps a MenuItem so that it can be used from Objective-C. Please see the documentation of MenuItem for more details.

    See more

    Declaration

    Swift

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

    Declaration

    Swift

    @objc(IMGLYBrush) open class Brush: NSObject
  • The ColorPickerView provides a way to pick colors. It contains three elements - a hue picker, a brightness and saturation picker and an alpha picker. It has full support for wide colors.

    See more

    Declaration

    Swift

    @objc(IMGLYColorPickerView) open class ColorPickerView: UIControl
  • An icon generator can be used to generate various icons.

    Declaration

    Swift

    @objc(IMGLYIconGenerator) open class IconGenerator: NSObject
  • This class represents a rectangle gradient control view. It is used within the focus tool to visualize the chosen focus parameters.

    Declaration

    Swift

    @objc(IMGLYBoxGradientView) open class BoxGradientView: FocusGradientView
  • A VideoRecordButton is a button that can be used to start a video recording. It animates between a ‘Start recording’ and a ‘Stop recording’ state.

    See more

    Declaration

    Swift

    public final class VideoRecordButton: UIControl
  • A PhotoEditToolController is the base class for any tool controllers. Subclass this class if you want to add additional tools to the editor.

    See more

    Declaration

    Swift

    @objc(IMGLYPhotoEditToolController) open class PhotoEditToolController: UIViewController, ToolbarItemProviding
  • A TextFontToolController is responsible for displaying the UI to adjust the font of text that has been added to an image.

    Declaration

    Swift

    @objc(IMGLYTextFontToolController) open class TextFontToolController: StackLayoutToolController
  • An Configuration defines behaviour and look of all view controllers provided by the imglyKit. It uses the builder pattern to create an immutable object via a closure. To configure the different editors and viewControllers contained in the SDK, edit their options in the corresponding configure*ViewController method of the ConfigurationBuilder.

    See more

    Declaration

    Swift

    @objc(IMGLYConfiguration) open class Configuration: NSObject
  • 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

    @objc(IMGLYConfigurationBuilder) open class ConfigurationBuilder: NSObject
  • A BoxedPhotoEditModel holds information about any modification that should be applied to an image. The actual PhotoEditModel is a struct and not exposable to Objective-C. This class boxes the actual PhotoEditModel for Objective-C compatibility.

    See more

    Declaration

    Swift

    @objc(IMGLYBoxedPhotoEditModel) open class BoxedPhotoEditModel: NSObject
  • A PhotoEditRenderer takes a CIImage and a PhotoEditModel as input and takes care of applying all necessary effects and filters to the image. The output image can then be rendered into an EAGLContext or converted into a CGImage instance.

    See more

    Declaration

    Swift

    @objc(IMGLYPhotoEditRenderer) open class PhotoEditRenderer: NSObject
  • A Frame represents a unique frame, which can have multiple images for different aspect ratios. The matching image for the current aspect ratio will be used automatically. Each frame neeeds at least one image and one thumbnail image. If no thumbnail is provide, it is automatically generated.

    See more

    Declaration

    Swift

    @objc(IMGLYFrame) open class Frame: NSObject
  • LUTConverter creates the color cube data needed for a CIColorCube filter by reading the LUT from an identity image and an effect image and interpolating between them.

    See more

    Declaration

    Swift

    @objc(IMGLYLUTConverter) open class LUTConverter: NSObject
  • A FocusToolController is reponsible for displaying the UI to adjust the focus of an image.

    Declaration

    Swift

    @objc(IMGLYFocusToolController) open class FocusToolController: StackLayoutToolController
  • The CropAndStraightenView class provides support for displaying, zooming, rotating and cropping an image.

    See more

    Declaration

    Swift

    @objc(IMGLYCropAndStraightenView) open class CropAndStraightenView: UIView
  • A sticker data source provides the stickers that should be displayed in the sticker tool.

    See more

    Declaration

    Swift

    @objc(IMGLYStickerDataSource) open class StickerDataSource: NSObject
  • A Font represents meta information about a font, that should be loaded into the SDK. If a font has a long name, the displayName can be used to substitude it within the UI. The font name is used by iOS to identify the font. This is usualy the filename of the font. But it can be different. To be sure use the font in a sandbox project, and get its ‘fontName’ attribute.

    See more

    Declaration

    Swift

    @objc(IMGLYFont) open class Font: NSObject
  • UndoController is a general-purpose recorder of operations for undo and redo.

    Note

    You register an undo operation by specifying the object that’s changing (or the owner of that object), along with a method to invoke to revert its state, and the arguments for that method. When performing undo an UndoController saves the operations reverted so that you can redo the undos. It differs from Foundation’s NSUndoManager in that groups are not created automatically for each cycle of the run loop and that each step of a group can be undone rather than just the whole group.
    See more

    Declaration

    Swift

    @objc(IMGLYUndoController) open class UndoController: NSObject
  • A LabelCaptionCollectionViewCell is a cell that displays two labels, one at the top and one at the bottom.

    See more

    Declaration

    Swift

    @objc(IMGLYLabelCaptionCollectionViewCell) open class LabelCaptionCollectionViewCell: UICollectionViewCell
  • A Slider object is a visual control used to select a single value from a continuous range of values. Sliders are always displayed as horizontal bars. An indicator, or thumb, notes the current value of the slider and can be moved by the user to change the setting. A vertical indicator, or neutral point, notes the default, unchanged value of the slider.

    See more

    Declaration

    Swift

    @objc(IMGLYSlider) open class Slider: UIControl
  • A ProgressView is an activity indicator that is shown on top of all other views in a HUD style and temporarily blocks all user interaction with other views.

    See more

    Declaration

    Swift

    @objc(IMGLYDefaultProgressView) open class DefaultProgressView: NSObject, ProgressView
  • A StackLayoutToolController presents a workspace view at the top and an accessory view at the bottom. The accessory view is usually used for the menu, while the workspace view hosts any other controls.

    See more

    Declaration

    Swift

    @objc(IMGLYStackLayoutToolController) open class StackLayoutToolController: PhotoEditToolController
  • Applies a radial focus to an instance of CIImage.

    See more

    Declaration

    Swift

    @objc(IMGLYRadialFocusFilter) open class RadialFocusFilter: CIFilter
  • An IconCaptionCollectionViewCell is a cell that shows an icon and a label.

    See more

    Declaration

    Swift

    @objc(IMGLYIconCaptionCollectionViewCell) open class IconCaptionCollectionViewCell: UICollectionViewCell
  • A FilterToolController is reponsible for displaying the UI to apply an effect filter to an image.

    Declaration

    Swift

    @objc(IMGLYFilterToolController) open class FilterToolController: StackLayoutToolController
  • A SeparatorCollectionViewCell is a cell that shows a single 1 pt wide vertical line. It is usually used to represent a seperator between other cells.

    See more

    Declaration

    Swift

    @objc(IMGLYSeparatorCollectionViewCell) open class SeparatorCollectionViewCell: UICollectionViewCell
  • A StickerImageView displays an instance of Sticker and provides improved support for accessibility.

    See more

    Declaration

    Swift

    @objc(IMGLYStickerImageView) open class StickerImageView: UIImageView
  • A ColorToolController is reponsible for displaying the UI to adjust the color of an element that has been added to an image.

    Declaration

    Swift

    @objc(IMGLYColorToolController) open class ColorToolController: StackLayoutToolController
  • A CropMaskView is a view that blurs the content behind it.

    See more

    Declaration

    Swift

    @objc(IMGLYCropMaskView) open class CropMaskView: UIView
  • A TextColorToolController is reponsible for displaying the UI to adjust the text color of text that has been added to an image.

    See more

    Declaration

    Swift

    @objc(IMGLYTextColorToolController) open class TextColorToolController: ColorToolController
  • A LicenseModel represents all properties of a license.

    See more

    Declaration

    Swift

    public class LicenseModel: NSObject
  • A ToolbarController is the container view controller for a PhotoEditViewController and its associated tool controllers. It usually displays a toolbar at bottom and has methods to transition between various tools. If it is embedded inside a UINavigationController it uses the navigation controllers navigation bar instead of its own toolbar at the bottom.

    See more

    Declaration

    Swift

    @objc(IMGLYToolbarController) open class ToolbarController: UIViewController
  • Applies clarity to an instance of CIImage.

    See more

    Declaration

    Swift

    @objc(IMGLYClarityFilter) open class ClarityFilter: CIFilter
  • This class represents a gradient control view. It is used within the focus tool to visualize the chosen focus parameters.

    See more

    Declaration

    Swift

    @objc(IMGLYFocusGradientView) open class FocusGradientView: UIControl
  • A FreehandTool is responsible for creating vertices for a freehand drawing.

    See more

    Declaration

    Swift

    @objc(IMGLYFreehandTool) open class FreehandTool: Tool
  • A PhotoEffectThumbnailRenderer can be used to generate thumbnails of a given input image for multiple photo effects.

    See more

    Declaration

    Swift

    @objc(IMGLYPhotoEffectThumbnailRenderer) open class PhotoEffectThumbnailRenderer: NSObject
  • Used to determine device orientation even if orientation lock is active.

    See more

    Declaration

    Swift

    @objc(IMGLYDeviceOrientationController) open class DeviceOrientationController: NSObject
  • A StickerCollectionViewCell is a cell that has an image view and an activity indicator in its center.

    See more

    Declaration

    Swift

    @objc(IMGLYIconCollectionViewCell) open class StickerCollectionViewCell: UICollectionViewCell
  • A BrushToolController is reponsible for displaying the UI to draw a painting on top of an image.

    Declaration

    Swift

    @objc(IMGLYBrushToolController) open class BrushToolController: StackLayoutToolController
  • An OverlayController manages all overlays that have been added to an image and hosts the overlay’s container view.

    See more

    Declaration

    Swift

    @objc(IMGLYOverlayController) open class OverlayController: NSObject
  • A TouchingGestureRecognizer is a simple UIGestureRecognizer subclass that counts the number of touches on the associated view.

    Declaration

    Swift

    @objc(IMGLYTouchingGestureRecognizer) open class TouchingGestureRecognizer: UIGestureRecognizer