OverlayMutableCollectionObject

Objective-C


@interface OverlayMutableCollectionObject : NSObject

Swift

class OverlayMutableCollectionObject : NSObject

This class encapsulates overlay mutable collection details.

  • Initializes and returns a newly allocated object using the model data.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithModelData:(nonnull void *)data;

  • Returns the model data.

    Declaration

    Objective-C

    - (nonnull void *)getModelData;
    • Add an overlay to the collection. If the overlay has categories, all are added to the collection.

    Declaration

    Objective-C

    - (void)add:(int)overlayId;

    Swift

    func add(_ overlayId: Int32)

    Parameters

    overlayId

    The overlay id.

  • Add an online overlay category to the collection.

    Declaration

    Objective-C

    - (void)add:(int)overlayId categoryId:(int)categoryId;

    Swift

    func add(_ overlayId: Int32, categoryId: Int32)

    Parameters

    overlayId

    The overlay id.
    categoryId

    The overlay category id in OverlayInfo.getCategories result list.

  • Remove the overlay from the collection.

    Declaration

    Objective-C

    - (void)remove:(int)overlayId;

    Swift

    func remove(_ overlayId: Int32)

    Parameters

    overlayId

    The overlay id.

  • Remove the overlay category id from the collection.

    Declaration

    Objective-C

    - (void)remove:(int)overlayId categoryId:(int)categoryId;

    Swift

    func remove(_ overlayId: Int32, categoryId: Int32)

    Parameters

    overlayId

    The overlay id.
    categoryId

    The overlay category id in OverlayInfo.getCategories result list.

  • Clear all overlays in collection.

    Declaration

    Objective-C

    - (void)clear;

    Swift

    func clear()