Add LottieAnimationView.maskAnimationToBounds configuration (#2008)

Sources/Private/CoreAnimation/CoreAnimationLayer.swift

@@ -19,6 +19,7 @@ final class CoreAnimationLayer: BaseAnimationLayer {
     imageProvider: AnimationImageProvider,
     textProvider: AnimationTextProvider,
     fontProvider: AnimationFontProvider,
+    maskAnimationToBounds: Bool,
     compatibilityTrackerMode: CompatibilityTracker.Mode,
     logger: LottieLogger)
     throws
@@ -31,7 +32,7 @@ final class CoreAnimationLayer: BaseAnimationLayer {
     compatibilityTracker = CompatibilityTracker(mode: compatibilityTrackerMode, logger: logger)
     valueProviderStore = ValueProviderStore(logger: logger)
     super.init()
-    masksToBounds = true
+    masksToBounds = maskAnimationToBounds
     setup()
     try setupChildLayers()
   }

Sources/Private/MainThread/LayerContainers/MainThreadAnimationLayer.swift

@@ -23,6 +23,7 @@ final class MainThreadAnimationLayer: CALayer, RootAnimationLayer {
     imageProvider: AnimationImageProvider,
     textProvider: AnimationTextProvider,
     fontProvider: AnimationFontProvider,
+    maskAnimationToBounds: Bool,
     logger: LottieLogger)
   {
     layerImageProvider = LayerImageProvider(imageProvider: imageProvider, assets: animation.assetLibrary?.imageAssets)
@@ -31,7 +32,7 @@ final class MainThreadAnimationLayer: CALayer, RootAnimationLayer {
     animationLayers = []
     self.logger = logger
     super.init()
-    masksToBounds = true
+    masksToBounds = maskAnimationToBounds
     bounds = animation.bounds
     let layers = animation.layers.initializeCompositionLayers(
       assetLibrary: animation.assetLibrary,

Sources/Public/Animation/LottieAnimationView.swift

@@ -454,6 +454,13 @@ open class LottieAnimationView: LottieAnimationViewBase {
     }
   }
 
+  /// Whether or not the animation is masked to the bounds. Defaults to true.
+  public var maskAnimationToBounds = true {
+    didSet {
+      animationLayer?.masksToBounds = maskAnimationToBounds
+    }
+  }
+
   /// Returns `true` if the animation is currently playing.
   public var isAnimationPlaying: Bool {
     guard let animationLayer = animationLayer else {
@@ -1134,6 +1141,7 @@ open class LottieAnimationView: LottieAnimationViewBase {
       imageProvider: imageProvider.cachedImageProvider,
       textProvider: textProvider,
       fontProvider: fontProvider,
+      maskAnimationToBounds: maskAnimationToBounds,
       logger: logger)
   }
 
@@ -1144,6 +1152,7 @@ open class LottieAnimationView: LottieAnimationViewBase {
         imageProvider: imageProvider.cachedImageProvider,
         textProvider: textProvider,
         fontProvider: fontProvider,
+        maskAnimationToBounds: maskAnimationToBounds,
         compatibilityTrackerMode: .track,
         logger: logger)
 
@@ -1179,6 +1188,7 @@ open class LottieAnimationView: LottieAnimationViewBase {
         imageProvider: imageProvider.cachedImageProvider,
         textProvider: textProvider,
         fontProvider: fontProvider,
+        maskAnimationToBounds: maskAnimationToBounds,
         compatibilityTrackerMode: .abort,
         logger: logger)
 

Tests/AutomaticEngineTests.swift

@@ -30,6 +30,7 @@ final class AutomaticEngineTests: XCTestCase {
         imageProvider: BundleImageProvider(bundle: Bundle.main, searchPath: nil),
         textProvider: DefaultTextProvider(),
         fontProvider: DefaultFontProvider(),
+        maskAnimationToBounds: true,
         compatibilityTrackerMode: .track,
         logger: .shared))