MBMMapOptions.h 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. // This file is generated and will be overwritten automatically.
  2. #import <Foundation/Foundation.h>
  3. #import <MapboxCoreMaps/MBMConstrainMode.h>
  4. #import <MapboxCoreMaps/MBMContextMode.h>
  5. #import <MapboxCoreMaps/MBMNorthOrientation.h>
  6. #import <MapboxCoreMaps/MBMViewportMode.h>
  7. @class MBMGlyphsRasterizationOptions;
  8. @class MBMSize;
  9. /** Describes the map option values. */
  10. NS_SWIFT_NAME(MapOptions)
  11. __attribute__((visibility ("default")))
  12. @interface MBMMapOptions : NSObject
  13. // This class provides custom init which should be called
  14. - (nonnull instancetype)init NS_UNAVAILABLE;
  15. // This class provides custom init which should be called
  16. + (nonnull instancetype)new NS_UNAVAILABLE;
  17. - (nonnull instancetype)initWithContextMode:(nullable NSNumber *)contextMode
  18. constrainMode:(nullable NSNumber *)constrainMode
  19. viewportMode:(nullable NSNumber *)viewportMode
  20. orientation:(nullable NSNumber *)orientation
  21. crossSourceCollisions:(nullable NSNumber *)crossSourceCollisions
  22. optimizeForTerrain:(nullable NSNumber *)optimizeForTerrain
  23. size:(nullable MBMSize *)size
  24. glyphsRasterizationOptions:(nullable MBMGlyphsRasterizationOptions *)glyphsRasterizationOptions NS_REFINED_FOR_SWIFT;
  25. - (nonnull instancetype)initWithContextMode:(nullable NSNumber *)contextMode
  26. constrainMode:(nullable NSNumber *)constrainMode
  27. viewportMode:(nullable NSNumber *)viewportMode
  28. orientation:(nullable NSNumber *)orientation
  29. crossSourceCollisions:(nullable NSNumber *)crossSourceCollisions
  30. optimizeForTerrain:(nullable NSNumber *)optimizeForTerrain
  31. size:(nullable MBMSize *)size
  32. pixelRatio:(float)pixelRatio
  33. glyphsRasterizationOptions:(nullable MBMGlyphsRasterizationOptions *)glyphsRasterizationOptions NS_REFINED_FOR_SWIFT;
  34. /**
  35. * The map context mode. This can be used to optimizations
  36. * if we know that the drawing context is not shared with other code.
  37. */
  38. @property (nonatomic, readonly, nullable) NSNumber *contextMode NS_REFINED_FOR_SWIFT;
  39. /**
  40. * The map constrain mode. This can be used to limit the map
  41. * to wrap around the globe horizontally. By default, it is set to
  42. * `HeightOnly`.
  43. */
  44. @property (nonatomic, readonly, nullable) NSNumber *constrainMode NS_REFINED_FOR_SWIFT;
  45. /**
  46. * The viewport mode. This can be used to flip the vertical
  47. * orientation of the map as some devices may use inverted orientation.
  48. */
  49. @property (nonatomic, readonly, nullable) NSNumber *viewportMode NS_REFINED_FOR_SWIFT;
  50. /**
  51. * The orientation of the Map. By default, it is set to
  52. * `Upwards`.
  53. */
  54. @property (nonatomic, readonly, nullable) NSNumber *orientation NS_REFINED_FOR_SWIFT;
  55. /**
  56. * Specify whether to enable cross-source symbol collision detection
  57. * or not. By default, it is set to `true`.
  58. */
  59. @property (nonatomic, readonly, nullable) NSNumber *crossSourceCollisions NS_REFINED_FOR_SWIFT;
  60. /**
  61. * With terrain on, if `true`, the map will render for performance
  62. * priority, which may lead to layer reordering allowing to maximize
  63. * performance (layers that are draped over terrain will be drawn first,
  64. * including fill, line, background, hillshade and raster). Any layers that
  65. * are positioned after symbols are draped last, over symbols. Otherwise, if
  66. * set to `false`, the map will always be drawn for layer order priority.
  67. * By default, it is set to `true`.
  68. */
  69. @property (nonatomic, readonly, nullable) NSNumber *optimizeForTerrain NS_REFINED_FOR_SWIFT;
  70. /**
  71. * The size to resize the map object and renderer backend.
  72. * The size is given in `platform pixel` units. macOS and iOS platforms use
  73. * device-independent pixel units, while other platforms, such as Android,
  74. * use screen pixel units.
  75. */
  76. @property (nonatomic, readonly, nullable) MBMSize *size NS_REFINED_FOR_SWIFT;
  77. /** The custom pixel ratio. By default, it is set to 1.0 */
  78. @property (nonatomic, readonly) float pixelRatio;
  79. /** Glyphs rasterization options to use for client-side text rendering. */
  80. @property (nonatomic, readonly, nullable) MBMGlyphsRasterizationOptions *glyphsRasterizationOptions;
  81. @end