ImageDatabaseObject

Objective-C


@interface ImageDatabaseObject : NSObject

Swift

class ImageDatabaseObject : NSObject

This class encapsulates image db object information.

  • Returns the image by providing the ID.

    Declaration

    Objective-C

    - (nullable ImageObject *)getImageById:(unsigned int)identifier;

    Swift

    func getImageById(_ identifier: UInt32) -> ImageObject?

  • Returns the image by providing the image index.

    Declaration

    Objective-C

    - (nullable ImageObject *)getImageByIndex:(int)index;

    Swift

    func getImageBy(_ index: Int32) -> ImageObject?

  • Returns the number of images.

    Declaration

    Objective-C

    - (int)getImageCount;

    Swift

    func getImageCount() -> Int32

  • Import a new image. The supported formats are: PNG.

    Declaration

    Objective-C

    - (void)import:(nonnull UIImage *)image;

    Swift

    func `import`(_ image: UIImage)

  • Remove an image from the database by providing the ID.

    Note

    Only images imported with Image::import function can be deleted.

    Declaration

    Objective-C

    - (BOOL)removeImageWithIndex:(int)imageId;

    Swift

    func removeImage(with imageId: Int32) -> Bool

  • Get default green pin image object.

    Declaration

    Objective-C

    - (nullable ImageObject *)getPinStartImage;

    Swift

    func getPinStartImage() -> ImageObject?

  • Get default red pin image object.

    Declaration

    Objective-C

    - (nullable ImageObject *)getPinStopImage;

    Swift

    func getPinStopImage() -> ImageObject?