MAParticleOverlayOptions.h 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
  1. //
  2. // MAParticleOverlayOptions.h
  3. // MAMapKit
  4. //
  5. // Created by liubo on 2018/9/18.
  6. // Copyright © 2018年 Amap. All rights reserved.
  7. //
  8. #import "MAConfig.h"
  9. #import "MAShape.h"
  10. #import "MAOverlay.h"
  11. #pragma mark - MAParticleOverlayType
  12. ///天气类型
  13. typedef NS_ENUM(NSInteger, MAParticleOverlayType)
  14. {
  15. MAParticleOverlayTypeSunny = 1, ///<晴天
  16. MAParticleOverlayTypeRain, ///<雨天
  17. MAParticleOverlayTypeSnowy, ///<雪天
  18. MAParticleOverlayTypeHaze, ///<雾霾
  19. };
  20. #pragma mark - MAParticleVelocityGenerate
  21. ///粒子的速度生成类. since 6.5.0
  22. @protocol MAParticleVelocityGenerate <NSObject>
  23. @required
  24. ///X轴方向上的速度变化率
  25. - (CGFloat)getX;
  26. ///Y轴方向上的速度变化率
  27. - (CGFloat)getY;
  28. ///Z轴方向上的速度变化率
  29. - (CGFloat)getZ;
  30. @end
  31. #pragma mark - MAParticleRandomVelocityGenerate
  32. ///粒子的随机速度生成类. since 6.5.0
  33. @interface MAParticleRandomVelocityGenerate : NSObject <MAParticleVelocityGenerate>
  34. /**
  35. * @brief 根据速度范围值生成粒子的速度变化类
  36. * @param x1 起始的速度x值
  37. * @param y1 起始的速度y值
  38. * @param z1 起始的速度z值
  39. * @param x2 结束的速度x值
  40. * @param y2 结束的速度y值
  41. * @param z2 结束的速度z值
  42. * @return 生成粒子的颜色变化类
  43. */
  44. - (instancetype)initWithBoundaryValueX1:(float)x1 Y1:(float)y1 Z1:(float)z1 X2:(float)x2 Y2:(float)y2 Z2:(float)z2;
  45. @end
  46. #pragma mark - MAParticleColorGenerate
  47. ///粒子的颜色生成类. since 6.5.0
  48. @protocol MAParticleColorGenerate <NSObject>
  49. @required
  50. ///生成的颜色值,需为包含四个float值的数组。
  51. - (float *)getColor;
  52. @end
  53. #pragma mark - MAParticleRandomColorGenerate
  54. ///粒子的随机颜色生成类. since 6.5.0
  55. @interface MAParticleRandomColorGenerate : NSObject <MAParticleColorGenerate>
  56. /**
  57. * @brief 根据颜色范围值生成粒子的颜色变化类
  58. * @param r1 起始的颜色r值
  59. * @param g1 起始的颜色g值
  60. * @param b1 起始的颜色b值
  61. * @param a1 起始的颜色a值
  62. * @param r2 结束的颜色r值
  63. * @param g2 结束的颜色g值
  64. * @param b2 结束的颜色b值
  65. * @param a2 结束的颜色a值
  66. * @return 生成粒子的颜色变化类
  67. */
  68. - (instancetype)initWithBoundaryColorR1:(float)r1 G1:(float)g1 B1:(float)b1 A1:(float)a1 R2:(float)r2 G2:(float)g2 B2:(float)b2 A2:(float)a2;
  69. @end
  70. #pragma mark - MAParticleRotationGenerate
  71. ///粒子的角度生成类. since 6.5.0
  72. @protocol MAParticleRotationGenerate <NSObject>
  73. @required
  74. ///生成的角度值
  75. - (float)getRotate;
  76. @end
  77. #pragma mark - MAParticleConstantRotationGenerate
  78. ///粒子的固定角度生成类. since 6.5.0
  79. @interface MAParticleConstantRotationGenerate : NSObject <MAParticleRotationGenerate>
  80. /**
  81. * @brief 根据角度生成粒子的角度变化类
  82. * @param rotate 固定的角度
  83. * @return 生成粒子的角度变化类
  84. */
  85. - (instancetype)initWithRotate:(float)rotate;
  86. @end
  87. #pragma mark - MAParticleSizeGenerate
  88. ///粒子的大小生成类. since 6.5.0
  89. @protocol MAParticleSizeGenerate <NSObject>
  90. @required
  91. ///X轴上变化比例
  92. - (float)getSizeX:(float)timeFrame;
  93. ///Y轴上变化比例
  94. - (float)getSizeY:(float)timeFrame;
  95. ///Z轴上变化比例
  96. - (float)getSizeZ:(float)timeFrame;
  97. @end
  98. #pragma mark - MAParticleCurveSizeGenerate
  99. ///粒子的大小变化类. since 6.5.0
  100. @interface MAParticleCurveSizeGenerate : NSObject <MAParticleSizeGenerate>
  101. /**
  102. * @brief 根据三个轴上的变化比例生成粒子的大小变化类
  103. * @param x X轴上变化比例
  104. * @param y Y轴上变化比例
  105. * @param z Z轴上变化比例
  106. * @return 生成粒子的大小变化类
  107. */
  108. - (instancetype)initWithCurveX:(float)x Y:(float)y Z:(float)z;
  109. @end
  110. #pragma mark - MAParticleEmissionModule
  111. ///粒子的发射率类,每隔多少时间发射粒子数量,越多会越密集. since 6.5.0
  112. @interface MAParticleEmissionModule : NSObject
  113. /**
  114. * @brief 根据发射数量和发射间隔生成粒子的发射率类。关系为:"发射数量为rate粒子->等待rateTime间隔->发射数量为rate粒子->等待rateTime间隔"循环
  115. * @param rate 发射数量(不能为0)
  116. * @param rateTime 发射间隔
  117. * @return 生成粒子的发射率类
  118. */
  119. - (instancetype)initWithEmissionRate:(int)rate rateTime:(int)rateTime;
  120. @end
  121. #pragma mark - MAParticleShapeModule
  122. ///粒子的发射区域模型协议. since 6.5.0
  123. @protocol MAParticleShapeModule <NSObject>
  124. @required
  125. ///新生成的发射点坐标,需为包含三个float值的数组。
  126. - (float *)getPoint;
  127. ///坐标是否按比例生成
  128. - (BOOL)isRatioEnable;
  129. @end
  130. #pragma mark - MAParticleSinglePointShapeModule
  131. ///粒子的发射单个点区域模型. since 6.5.0
  132. @interface MAParticleSinglePointShapeModule : NSObject <MAParticleShapeModule>
  133. /**
  134. * @brief 生成粒子的发射矩形区域模型,以比例的形式设置发射区域
  135. * @param x x坐标比例
  136. * @param y y坐标比例
  137. * @param z z坐标比例
  138. * @param isUseRatio 是否按比例
  139. * @return 新生成的粒子发射单个点区域模型
  140. */
  141. - (instancetype)initWithShapeX:(float)x Y:(float)y Z:(float)z useRatio:(BOOL)isUseRatio;
  142. @end
  143. #pragma mark - MAParticleRectShapeModule
  144. ///粒子的发射矩形区域模型. since 6.5.0
  145. @interface MAParticleRectShapeModule : NSObject <MAParticleShapeModule>
  146. /**
  147. * @brief 生成粒子的发射矩形区域模型,以比例的形式设置发射区域。
  148. * @param left 左边距比例
  149. * @param top 上边距比例
  150. * @param right 右边距比例
  151. * @param bottom 下边距比例
  152. * @param isUseRatio 是否按比例
  153. * @return 新生成的粒子发射矩形区域模型
  154. */
  155. - (instancetype)initWithLeft:(float)left top:(float)top right:(float)right bottom:(float)bottom useRatio:(BOOL)isUseRatio;
  156. @end
  157. #pragma mark - MAParticleOverLifeModule
  158. ///粒子生命周期过程中状态变化,包含速度、旋转和颜色的变化. since 6.5.0
  159. @interface MAParticleOverLifeModule : NSObject
  160. /**
  161. * @brief 设置粒子生命周期过程中速度的变化
  162. * @param velocity 遵循MAParticleVelocityGenerate协议的速度生成类
  163. */
  164. - (void)setVelocityOverLife:(id<MAParticleVelocityGenerate>)velocity;
  165. /**
  166. * @brief 设置粒子生命周期过程中角度的变化
  167. * @param rotation 遵循MAParticleRotationGenerate协议的角度生成类
  168. */
  169. - (void)setRotationOverLife:(id<MAParticleRotationGenerate>)rotation;
  170. /**
  171. * @brief 设置粒子生命周期过程中大小的变化
  172. * @param size 遵循MAParticleSizeGenerate协议的大小生成类
  173. */
  174. - (void)setSizeOverLife:(id<MAParticleSizeGenerate>)size;
  175. /**
  176. * @brief 设置粒子生命周期过程中颜色的变化
  177. * @param color 遵循MAParticleColorGenerate协议的颜色生成类
  178. */
  179. - (void)setColorOverLife:(id<MAParticleColorGenerate>)color;
  180. @end
  181. #pragma mark - MAParticleOverlayOptions
  182. ///该类用于定义一个粒子覆盖物显示选项. since 6.5.0
  183. @interface MAParticleOverlayOptions : NSObject
  184. ///option选项是否可见. (默认YES)
  185. @property (nonatomic, assign) BOOL visibile;
  186. ///粒子系统存活时间. (默认5000,单位毫秒)
  187. @property (nonatomic, assign) NSTimeInterval duration;
  188. ///粒子系统是否循环. (默认YES)
  189. @property (nonatomic, assign) BOOL loop;
  190. ///粒子系统的粒子最大数量. (默认100)
  191. @property (nonatomic, assign) NSInteger maxParticles;
  192. ///粒子系统的粒子图标. (默认nil)
  193. @property (nonatomic, strong) UIImage *icon;
  194. ///每个粒子的初始大小. (默认(32.f*[[UIScreen mainScreen] nativeScale], 32.f*[[UIScreen mainScreen] nativeScale]),单位:OpenGLESPixels数量,计算方式为: OpenGLESPixels = ScreenPoint数量 * [[UIScreen mainScreen] nativeScale])
  195. @property (nonatomic, assign) CGSize startParticleSize;
  196. ///每个粒子的存活时间. (默认5000,单位毫秒)
  197. @property (nonatomic, assign) NSTimeInterval particleLifeTime;
  198. ///每个粒子的初始颜色. (默认nil)
  199. @property (nonatomic, strong) id<MAParticleColorGenerate> particleStartColor;
  200. ///每个粒子的初始速度. (默认nil)
  201. @property (nonatomic, strong) id<MAParticleVelocityGenerate> particleStartSpeed;
  202. ///粒子的发射率,参考 MAParticleEmissionModule 类. (默认nil)
  203. @property (nonatomic, strong) MAParticleEmissionModule *particleEmissionModule;
  204. ///粒子的发射区域模型. (默认nil)
  205. @property (nonatomic, strong) id<MAParticleShapeModule> particleShapeModule;
  206. ///粒子生命周期过程,参考 MAParticleOverLifeModule 类. (默认nil)
  207. @property (nonatomic, strong) MAParticleOverLifeModule *particleOverLifeModule;
  208. @end
  209. #pragma mark - MAParticleOverlayOptionsFactory
  210. ///该类用于根据指定的天气类型,生成SDK内置的天气粒子覆盖物显示选项option. since 6.5.0
  211. @interface MAParticleOverlayOptionsFactory : NSObject
  212. /**
  213. * @brief 根据指定的天气类型生成粒子覆盖物显示选项option
  214. * @param particleType 天气类型
  215. * @return 新生成的粒子覆盖物显示选项option
  216. */
  217. + (NSArray<MAParticleOverlayOptions *> *)particleOverlayOptionsWithType:(MAParticleOverlayType)particleType;
  218. @end