Clip text if it goes beyond the Y bounds of paragraph text

lottie/src/main/java/com/airbnb/lottie/model/layer/TextLayer.java

@@ -35,6 +35,7 @@
 import java.util.Map;
 
 public class TextLayer extends BaseLayer {
+
   // Capacity is 2 because emojis are 2 characters. Some are longer in which case, the capacity will
   // be expanded but that should be pretty rare.
   private final StringBuilder stringBuilder = new StringBuilder(2);
@@ -203,8 +204,9 @@ private void drawTextWithGlyphs(
 
         canvas.save();
 
-        offsetCanvas(canvas, documentData, lineIndex, line.width);
-        drawGlyphTextLine(line.text, documentData, font, canvas, parentScale, fontScale, tracking);
+        if (offsetCanvas(canvas, documentData, lineIndex, line.width)) {
+          drawGlyphTextLine(line.text, documentData, font, canvas, parentScale, fontScale, tracking);
+        }
 
         canvas.restore();
       }
@@ -271,20 +273,24 @@ private void drawTextWithFont(DocumentData documentData, Font font, Canvas canva
 
         canvas.save();
 
-        offsetCanvas(canvas, documentData, lineIndex, line.width);
-        drawFontTextLine(line.text, documentData, canvas, tracking);
+        if (offsetCanvas(canvas, documentData, lineIndex, line.width)) {
+          drawFontTextLine(line.text, documentData, canvas, tracking);
+        }
 
         canvas.restore();
       }
     }
   }
 
-  private void offsetCanvas(Canvas canvas, DocumentData documentData, int lineIndex, float lineWidth) {
+  private boolean offsetCanvas(Canvas canvas, DocumentData documentData, int lineIndex, float lineWidth) {
     PointF position = documentData.boxPosition;
     PointF size = documentData.boxSize;
     float dpScale = Utils.dpScale();
     float lineStartY = position == null ? 0f : documentData.lineHeight * dpScale + position.y;
     float lineOffset = (lineIndex * documentData.lineHeight * dpScale) + lineStartY;
+    if (size != null && position != null && lineOffset >= position.y + size.y + documentData.size) {
+      return false;
+    }
     float lineStart = position == null ? 0f : position.x;
     float boxWidth = size == null ? 0f : size.x;
     switch (documentData.justification) {
@@ -298,6 +304,7 @@ private void offsetCanvas(Canvas canvas, DocumentData documentData, int lineInde
         canvas.translate(lineStart + boxWidth / 2f - lineWidth / 2f, lineOffset);
         break;
     }
+    return true;
   }
 
   @Nullable
@@ -608,6 +615,7 @@ public <T> void addValueCallback(T property, @Nullable LottieValueCallback<T> ca
   }
 
   private static class TextSubLine {
+
     private String text = "";
     private float width = 0f;
 

snapshot-tests/src/main/assets/Tests/SzFont.json

@@ -0,0 +1 @@
+{"v":"5.12.1","fr":60,"ip":0,"op":60,"w":400,"h":400,"nm":"Comp 1","ddd":0,"assets":[],"fonts":{"list":[{"origin":0,"fPath":"","fClass":"","fFamily":"Helvetica","fWeight":"","fStyle":"Regular","fName":"Helvetica","ascent":72.8994140625}]},"layers":[{"ddd":0,"ind":1,"ty":5,"nm":"1 test test 2 test test 3 test test 4 test test 5 test test","sr":1,"ks":{"o":{"a":0,"k":100,"ix":11},"r":{"a":0,"k":0,"ix":10},"p":{"a":0,"k":[198,252,0],"ix":2,"l":2},"a":{"a":0,"k":[0,0,0],"ix":1,"l":2},"s":{"a":0,"k":[100,100,100],"ix":6,"l":2}},"ao":0,"t":{"d":{"k":[{"s":{"sz":[280,218],"ps":[-140,-138],"s":48,"f":"Helvetica","t":"1 test test\u00032 test test\u00033 test test\u00034 test test\u00035 test test","ca":0,"j":2,"tr":0,"lh":48,"ls":0,"fc":[0,0,0],"sc":[1,0,0],"sw":1,"of":true},"t":0}]},"p":{},"m":{"g":1,"a":{"a":0,"k":[0,0],"ix":2}},"a":[]},"ip":0,"op":60,"st":0,"ct":1,"bm":0},{"ddd":0,"ind":2,"ty":4,"nm":"Shape Layer 1","sr":1,"ks":{"o":{"a":0,"k":100,"ix":11},"r":{"a":0,"k":0,"ix":10},"p":{"a":0,"k":[206,226,0],"ix":2,"l":2},"a":{"a":0,"k":[0,0,0],"ix":1,"l":2},"s":{"a":0,"k":[83.632,89.231,100],"ix":6,"l":2}},"ao":0,"shapes":[{"ty":"gr","it":[{"ty":"rc","d":1,"s":{"a":0,"k":[294.844,243.43],"ix":2},"p":{"a":0,"k":[0,0],"ix":3},"r":{"a":0,"k":0,"ix":4},"nm":"Rectangle Path 1","mn":"ADBE Vector Shape - Rect","hd":false},{"ty":"st","c":{"a":0,"k":[1,1,1,1],"ix":3},"o":{"a":0,"k":100,"ix":4},"w":{"a":0,"k":2,"ix":5},"lc":1,"lj":1,"ml":4,"bm":0,"nm":"Stroke 1","mn":"ADBE Vector Graphic - Stroke","hd":false},{"ty":"fl","c":{"a":0,"k":[1,0,0,1],"ix":4},"o":{"a":0,"k":100,"ix":5},"r":1,"bm":0,"nm":"Fill 1","mn":"ADBE Vector Graphic - Fill","hd":false},{"ty":"tr","p":{"a":0,"k":[-8.279,-24.092],"ix":2},"a":{"a":0,"k":[0,0],"ix":1},"s":{"a":0,"k":[87.802,91.523],"ix":3},"r":{"a":0,"k":0,"ix":6},"o":{"a":0,"k":100,"ix":7},"sk":{"a":0,"k":0,"ix":4},"sa":{"a":0,"k":0,"ix":5},"nm":"Transform"}],"nm":"Rectangle 1","np":3,"cix":2,"bm":0,"ix":1,"mn":"ADBE Vector Group","hd":false}],"ip":0,"op":60,"st":0,"ct":1,"bm":0}],"markers":[],"props":{}}

snapshot-tests/src/main/assets/Tests/SzGlyph.json

@@ -0,0 +1 @@
+{"v":"5.12.1","fr":60,"ip":0,"op":60,"w":400,"h":400,"nm":"Comp 1","ddd":0,"assets":[],"fonts":{"list":[{"fName":"Helvetica","fFamily":"Helvetica","fStyle":"Regular","ascent":72.8994140625}]},"layers":[{"ddd":0,"ind":1,"ty":5,"nm":"1 test test 2 test test 3 test test 4 test test 5 test test","sr":1,"ks":{"o":{"a":0,"k":100,"ix":11},"r":{"a":0,"k":0,"ix":10},"p":{"a":0,"k":[198,252,0],"ix":2,"l":2},"a":{"a":0,"k":[0,0,0],"ix":1,"l":2},"s":{"a":0,"k":[100,100,100],"ix":6,"l":2}},"ao":0,"t":{"d":{"k":[{"s":{"sz":[280,218],"ps":[-140,-138],"s":48,"f":"Helvetica","t":"1 test test\u00032 test test\u00033 test test\u00034 test test\u00035 test test","ca":0,"j":2,"tr":0,"lh":48,"ls":0,"fc":[0,0,0],"sc":[1,0,0],"sw":1,"of":true},"t":0}]},"p":{},"m":{"g":1,"a":{"a":0,"k":[0,0],"ix":2}},"a":[]},"ip":0,"op":60,"st":0,"ct":1,"bm":0},{"ddd":0,"ind":2,"ty":4,"nm":"Shape Layer 1","sr":1,"ks":{"o":{"a":0,"k":100,"ix":11},"r":{"a":0,"k":0,"ix":10},"p":{"a":0,"k":[206,226,0],"ix":2,"l":2},"a":{"a":0,"k":[0,0,0],"ix":1,"l":2},"s":{"a":0,"k":[83.632,89.231,100],"ix":6,"l":2}},"ao":0,"shapes":[{"ty":"gr","it":[{"ty":"rc","d":1,"s":{"a":0,"k":[294.844,243.43],"ix":2},"p":{"a":0,"k":[0,0],"ix":3},"r":{"a":0,"k":0,"ix":4},"nm":"Rectangle Path 1","mn":"ADBE Vector Shape - Rect","hd":false},{"ty":"st","c":{"a":0,"k":[1,1,1,1],"ix":3},"o":{"a":0,"k":100,"ix":4},"w":{"a":0,"k":2,"ix":5},"lc":1,"lj":1,"ml":4,"bm":0,"nm":"Stroke 1","mn":"ADBE Vector Graphic - Stroke","hd":false},{"ty":"fl","c":{"a":0,"k":[1,0,0,1],"ix":4},"o":{"a":0,"k":100,"ix":5},"r":1,"bm":0,"nm":"Fill 1","mn":"ADBE Vector Graphic - Fill","hd":false},{"ty":"tr","p":{"a":0,"k":[-8.279,-24.092],"ix":2},"a":{"a":0,"k":[0,0],"ix":1},"s":{"a":0,"k":[87.802,91.523],"ix":3},"r":{"a":0,"k":0,"ix":6},"o":{"a":0,"k":100,"ix":7},"sk":{"a":0,"k":0,"ix":4},"sa":{"a":0,"k":0,"ix":5},"nm":"Transform"}],"nm":"Rectangle 1","np":3,"cix":2,"bm":0,"ix":1,"mn":"ADBE Vector Group","hd":false}],"ip":0,"op":60,"st":0,"ct":1,"bm":0}],"markers":[],"props":{},"chars":[{"ch":"1","size":48,"style":"Regular","w":48.24,"data":{"shapes":[{"ty":"gr","it":[{"ind":0,"ty":"sh","ix":1,"ks":{"a":0,"k":{"i":[[0,0],[0,0],[0,0],[0,0],[0,0],[2.506,-1.448],[6.348,-0.618],[0,0]],"o":[[0,0],[0,0],[0,0],[0,0],[-1.237,5.404],[-2.507,1.449],[0,0],[0,0]],"v":[[26.025,-49.512],[26.025,0],[35.4,0],[35.4,-69.629],[28.467,-69.629],[22.852,-59.351],[9.57,-56.25],[9.57,-49.512]],"c":true},"ix":2},"nm":"1","mn":"ADBE Vector Shape - Group","hd":false}],"nm":"1","np":3,"cix":2,"bm":0,"ix":1,"mn":"ADBE Vector Group","hd":false}]},"fFamily":"Helvetica"},{"ch":" ","size":48,"style":"Regular","w":27.78,"data":{},"fFamily":"Helvetica"},{"ch":"t","size":48,"style":"Regular","w":27.78,"data":{"shapes":[{"ty":"gr","it":[{"ind":0,"ty":"sh","ix":1,"ks":{"a":0,"k":{"i":[[0,0],[0,0],[0,0],[0,0],[0,0],[-1.465,-2.1],[-4.102,0],[-1.091,0.13],[-1.009,0.293],[0,0],[0.488,-0.021],[0.423,0],[0.684,0.359],[0,1.823],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0]],"o":[[0,0],[0,0],[0,0],[0,0],[0,3.353],[1.465,2.1],[1.27,0],[1.09,-0.13],[0,0],[-0.652,0.087],[-0.488,0.021],[-1.595,0],[-1.237,-0.618],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0]],"v":[[8.203,-52.295],[1.123,-52.295],[1.123,-45.117],[8.203,-45.117],[8.203,-10.498],[10.4,-2.319],[18.75,0.83],[22.29,0.635],[25.439,0],[25.439,-6.982],[23.73,-6.819],[22.363,-6.787],[18.945,-7.324],[17.09,-10.986],[17.09,-45.117],[25.439,-45.117],[25.439,-52.295],[17.09,-52.295],[17.09,-66.895],[8.203,-66.895]],"c":true},"ix":2},"nm":"t","mn":"ADBE Vector Shape - Group","hd":false}],"nm":"t","np":3,"cix":2,"bm":0,"ix":1,"mn":"ADBE Vector Group","hd":false}]},"fFamily":"Helvetica"},{"ch":"e","size":48,"style":"Regular","w":55.62,"data":{"shapes":[{"ty":"gr","it":[{"ind":0,"ty":"sh","ix":1,"ks":{"a":0,"k":{"i":[[3.688,0],[4.529,-5.241],[0,-8.398],[-4.497,-4.736],[-6.47,0],[-2.1,0.52],[-2.65,2.605],[-1.286,2.361],[-0.228,1.921],[0,0],[1.518,-1.765],[4.554,0],[2.325,3.215],[0.162,5.321],[0,0],[0.517,2.409],[1.747,2.637],[3.461,1.742]],"o":[[-7.312,0],[-4.53,5.241],[0,8.529],[4.497,4.736],[2.649,0],[3.909,-0.912],[1.582,-1.497],[1.286,-2.36],[0,0],[-0.633,2.322],[-2.713,3.041],[-4.877,0],[-2.325,-3.215],[0,0],[0,-5.273],[-0.583,-3.516],[-1.812,-2.766],[-3.462,-1.741]],"v":[[28.022,-53.467],[10.261,-45.605],[3.467,-25.146],[10.211,-5.249],[26.661,1.855],[33.784,1.074],[43.622,-4.199],[47.925,-9.985],[50.195,-16.406],[41.553,-16.406],[38.326,-10.275],[27.425,-5.713],[16.621,-10.535],[12.891,-23.34],[50.928,-23.34],[50.151,-34.863],[46.657,-44.092],[38.747,-50.854]],"c":true},"ix":2},"nm":"e","mn":"ADBE Vector Shape - Group","hd":false},{"ind":1,"ty":"sh","ix":2,"ks":{"a":0,"k":{"i":[[0,0],[-2.711,2.914],[-4.002,0],[-2.389,-4.231],[-0.356,-3.809]],"o":[[0.161,-4.492],[2.711,-2.913],[5.584,0],[1.291,2.279],[0,0]],"v":[[13.086,-30.322],[17.395,-41.431],[27.466,-45.801],[39.425,-39.453],[41.895,-30.322]],"c":true},"ix":2},"nm":"e","mn":"ADBE Vector Shape - Group","hd":false}],"nm":"e","np":5,"cix":2,"bm":0,"ix":1,"mn":"ADBE Vector Group","hd":false}]},"fFamily":"Helvetica"},{"ch":"s","size":48,"style":"Regular","w":50,"data":{"shapes":[{"ty":"gr","it":[{"ind":0,"ty":"sh","ix":1,"ks":{"a":0,"k":{"i":[[0,0],[-3.279,-3.532],[-7.877,0],[-3.576,3.385],[0,4.655],[3.418,2.246],[6.434,1.53],[0,0],[1.326,0.811],[0,2.271],[-1.749,1.265],[-3.399,0],[-2.066,-2.298],[-0.167,-1.974],[0,0],[2.21,2.93],[7.983,0],[3.612,-3.059],[0,-4.948],[-3.838,-2.376],[-4.532,-1.106],[0,0],[-1.291,-0.716],[0,-2.246],[2.525,-1.416],[3.322,0],[2.259,2.832],[0.266,2.93]],"o":[[0.23,5.209],[3.279,3.532],[7.317,0],[3.576,-3.385],[0,-4.817],[-2.19,-1.432],[0,0],[-2.587,-0.618],[-2.299,-1.363],[0,-2.075],[1.749,-1.265],[5.098,0],[1.266,1.619],[0,0],[0.065,-3.385],[-3.529,-4.622],[-6.104,0],[-3.613,3.06],[0,4.199],[2.15,1.367],[0,0],[3.804,0.945],[2.018,1.172],[0,2.962],[-2.525,1.416],[-5.582,0],[-1.23,-1.562],[0,0]],"v":[[3.223,-16.406],[8.488,-3.296],[25.221,2.002],[41.56,-3.076],[46.924,-15.137],[41.797,-25.732],[28.862,-30.176],[22.942,-31.592],[17.072,-33.736],[13.623,-39.185],[16.247,-44.196],[23.969,-46.094],[34.716,-42.646],[36.865,-37.256],[45.166,-37.256],[41.948,-46.729],[24.679,-53.662],[10.106,-49.072],[4.688,-37.061],[10.444,-27.197],[20.467,-23.486],[27.563,-21.729],[35.205,-19.238],[38.232,-14.111],[34.444,-7.544],[25.674,-5.42],[13.912,-9.668],[11.67,-16.406]],"c":true},"ix":2},"nm":"s","mn":"ADBE Vector Shape - Group","hd":false}],"nm":"s","np":3,"cix":2,"bm":0,"ix":1,"mn":"ADBE Vector Group","hd":false}]},"fFamily":"Helvetica"},{"ch":"\u0003","size":48,"style":"Regular","w":0,"fFamily":"Helvetica"},{"ch":"2","size":48,"style":"Regular","w":55.62,"data":{"shapes":[{"ty":"gr","it":[{"ind":0,"ty":"sh","ix":1,"ks":{"a":0,"k":{"i":[[0.325,-6.022],[0,0],[0,0],[0,0],[-3.255,2.832],[-3.191,1.758],[0,0],[-2.279,2.312],[0,5.599],[3.694,4.33],[8.008,0],[3.809,-6.77],[0.098,-6.087],[0,0],[-1.237,2.449],[-6.023,0],[-2.441,-2.397],[0,-4.077],[2.669,-2.707],[4.199,-2.441],[0,0],[2.164,-4.459]],"o":[[0,0],[0,0],[0,0],[0.846,-3.45],[1.823,-1.595],[0,0],[5.891,-3.288],[3.938,-3.971],[0,-5.305],[-3.695,-4.329],[-9.636,0],[-2.148,3.841],[0,0],[0.13,-4.341],[2.311,-4.57],[4.069,0],[2.441,2.397],[0,3.49],[-1.693,1.729],[0,0],[-6.283,3.646],[-2.165,4.46]],"v":[[3.125,0],[51.123,0],[51.123,-8.301],[12.939,-8.301],[19.092,-17.725],[26.611,-22.754],[33.301,-26.465],[45.557,-34.863],[51.465,-49.219],[45.923,-63.672],[28.369,-70.166],[8.203,-60.01],[4.834,-45.117],[13.77,-45.117],[15.82,-55.302],[28.32,-62.158],[38.086,-58.562],[41.748,-48.851],[37.744,-39.556],[28.906,-33.301],[19.531,-27.881],[6.86,-15.723]],"c":true},"ix":2},"nm":"2","mn":"ADBE Vector Shape - Group","hd":false}],"nm":"2","np":3,"cix":2,"bm":0,"ix":1,"mn":"ADBE Vector Group","hd":false}]},"fFamily":"Helvetica"},{"ch":"3","size":48,"style":"Regular","w":55.62,"data":{"shapes":[{"ty":"gr","it":[{"ind":0,"ty":"sh","ix":1,"ks":{"a":0,"k":{"i":[[-8.269,0],[-4.395,4.199],[0,6.673],[2.067,2.881],[3.678,1.009],[-1.433,1.66],[0,4.297],[3.906,3.174],[7.129,0],[3.58,-6.51],[0,-5.208],[0,0],[-1.237,2.148],[-5.859,0],[-2.474,-1.888],[0,-3.483],[3.711,-1.823],[3.288,0],[0.618,0.033],[0.911,0.098],[0,0],[-0.603,0.017],[-0.586,0],[-2.946,-1.92],[0,-4.817],[2.799,-2.473],[4.622,0],[2.278,3.679],[0.391,4.525],[0,0],[-3.728,-4.541]],"o":[[8.073,0],[4.395,-4.199],[0,-4.166],[-2.068,-2.881],[2.278,-0.944],[2.311,-2.669],[0,-6.022],[-3.906,-3.174],[-9.017,0],[-2.084,3.646],[0,0],[0.163,-3.971],[2.246,-3.906],[3.288,0],[2.473,1.888],[0,4.688],[-2.116,1.042],[-0.716,0],[-0.619,-0.032],[0,0],[0.618,-0.032],[0.602,-0.016],[5.241,0],[2.946,1.921],[0,3.906],[-2.8,2.474],[-5.957,0],[-1.302,-2.051],[0,0],[0,6.511],[3.727,4.541]],"v":[[25.977,1.904],[44.678,-4.395],[51.27,-20.703],[48.169,-31.274],[39.551,-37.109],[45.117,-41.016],[48.584,-51.465],[42.725,-65.259],[26.172,-70.02],[7.275,-60.254],[4.15,-46.973],[12.842,-46.973],[14.941,-56.152],[27.1,-62.012],[35.742,-59.18],[39.453,-51.123],[33.887,-41.357],[25.781,-39.795],[23.779,-39.844],[21.484,-40.039],[21.484,-32.275],[23.315,-32.349],[25.098,-32.373],[37.378,-29.492],[41.797,-19.385],[37.598,-9.814],[26.465,-6.104],[14.111,-11.621],[11.572,-21.484],[2.393,-21.484],[7.983,-4.907]],"c":true},"ix":2},"nm":"3","mn":"ADBE Vector Shape - Group","hd":false}],"nm":"3","np":3,"cix":2,"bm":0,"ix":1,"mn":"ADBE Vector Group","hd":false}]},"fFamily":"Helvetica"},{"ch":"4","size":48,"style":"Regular","w":55.62,"data":{"shapes":[{"ty":"gr","it":[{"ind":0,"ty":"sh","ix":1,"ks":{"a":0,"k":{"i":[[0,0],[0,0],[0,0]],"o":[[0,0],[0,0],[0,0]],"v":[[10.645,-24.756],[33.057,-56.515],[33.057,-24.756]],"c":true},"ix":2},"nm":"4","mn":"ADBE Vector Shape - Group","hd":false},{"ind":1,"ty":"sh","ix":2,"ks":{"a":0,"k":{"i":[[0,0],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0]],"o":[[0,0],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0]],"v":[[41.992,0],[41.992,-17.09],[52.295,-17.09],[52.295,-24.756],[41.992,-24.756],[41.992,-70.117],[34.57,-70.117],[2.539,-25.684],[2.539,-17.09],[33.203,-17.09],[33.203,0]],"c":true},"ix":2},"nm":"4","mn":"ADBE Vector Shape - Group","hd":false}],"nm":"4","np":5,"cix":2,"bm":0,"ix":1,"mn":"ADBE Vector Group","hd":false}]},"fFamily":"Helvetica"},{"ch":"5","size":48,"style":"Regular","w":55.62,"data":{"shapes":[{"ty":"gr","it":[{"ind":0,"ty":"sh","ix":1,"ks":{"a":0,"k":{"i":[[0,0],[-4.379,-3.206],[-5.697,0],[-4.086,5.046],[0,6.609],[4.459,4.134],[6.413,0],[2.604,-1.074],[1.627,-1.237],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0],[-2.165,1.172],[-3.027,0],[-2.979,-2.669],[0,-4.883],[2.506,-3.32],[5.208,0],[2.083,0.977],[0.586,5.013]],"o":[[0.52,6.641],[4.378,3.206],[8.952,0],[4.085,-5.045],[0,-6.348],[-4.46,-4.134],[-3.418,0],[-1.465,0.619],[0,0],[0,0],[0,0],[0,0],[0,0],[0,0],[1.53,-2.083],[2.164,-1.172],[4.166,0],[2.979,2.67],[0,4.037],[-2.507,3.32],[-2.734,0],[-4.07,-1.92],[0,0]],"v":[[3.223,-17.822],[10.571,-3.052],[25.684,1.758],[45.239,-5.811],[51.367,-23.291],[44.678,-39.014],[28.369,-45.215],[19.336,-43.604],[14.697,-40.82],[17.676,-60.254],[47.412,-60.254],[47.412,-68.75],[11.086,-68.75],[5.762,-31.104],[13.379,-30.664],[18.921,-35.547],[26.709,-37.305],[37.427,-33.301],[41.895,-21.973],[38.135,-10.938],[26.562,-5.957],[19.336,-7.422],[12.354,-17.822]],"c":true},"ix":2},"nm":"5","mn":"ADBE Vector Shape - Group","hd":false}],"nm":"5","np":3,"cix":2,"bm":0,"ix":1,"mn":"ADBE Vector Group","hd":false}]},"fFamily":"Helvetica"}]}