OverlayInfoObject

Objective-C


@interface OverlayInfoObject : NSObject

Swift

class OverlayInfoObject : NSObject

This class encapsulates overlay info 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;

  • Get the unique ID of the overlay.

    Declaration

    Objective-C

    - (int)getUid;

    Swift

    func getUid() -> Int32

  • Get the name of the overlay.

    Declaration

    Objective-C

    - (nonnull NSString *)getName;

    Swift

    func getName() -> String

  • Returns the image of the item.

    Declaration

    Objective-C

    - (nullable UIImage *)getImage:(CGFloat)height;

    Swift

    func getImage(_ height: CGFloat) -> UIImage?

    Parameters

    height

    The desired image height.

  • Gets the overlay categories.

    Declaration

    Objective-C

    - (nonnull NSArray<OverlayCategoryObject *> *)getCategories;

    Swift

    func getCategories() -> [OverlayCategoryObject]

    Return Value

    empty if no categories are available.

  • Gets the overlay category by id.

    Declaration

    Objective-C

    - (nullable OverlayCategoryObject *)getCategory:(int)categoryId;

    Swift

    func getCategory(_ categoryId: Int32) -> OverlayCategoryObject?

    Return Value

    empty if no category is found.

  • Check if a category has subcategories.

    Declaration

    Objective-C

    - (BOOL)hasCategories:(int)categoryId;

    Swift

    func hasCategories(_ categoryId: Int32) -> Bool