Rename SegmentVector's invalidateLast to forceNewSegmentOnTextPrepare

maplibre · Apr 8, 2024 · a405cb8 · HarelM · Apr 8, 2024 · a405cb8
1 parent ae0ead7
commit a405cb8
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 10 deletions.
diff --git a/src/data/segment.test.ts b/src/data/segment.test.ts
@@ -77,7 +77,7 @@ describe('SegmentVector', () => {
         const indexBuffer = new TriangleIndexArray();
         const segmentVector = new SegmentVector();
         const first = mockUseSegment(segmentVector, vertexBuffer, indexBuffer, 5);
-        segmentVector.invalidateLast();
+        segmentVector.forceNewSegmentOnTextPrepare();
         const second = segmentVector.createNewSegment(vertexBuffer, indexBuffer);
         second.vertexLength += 5;
         addVertices(vertexBuffer, 5);
@@ -125,7 +125,7 @@ describe('SegmentVector', () => {
         const indexBuffer = new TriangleIndexArray();
         const segmentVector = new SegmentVector();
         const first = mockUseSegment(segmentVector, vertexBuffer, indexBuffer, 5);
-        segmentVector.invalidateLast();
+        segmentVector.forceNewSegmentOnTextPrepare();
         const second = segmentVector.getOrCreateLatestSegment(vertexBuffer, indexBuffer);
         second.vertexLength += 5;
         addVertices(vertexBuffer, 5);
@@ -145,7 +145,7 @@ describe('SegmentVector', () => {
         const indexBuffer = new TriangleIndexArray();
         const segmentVector = new SegmentVector();
         const first = mockUseSegment(segmentVector, vertexBuffer, indexBuffer, 5);
-        segmentVector.invalidateLast();
+        segmentVector.forceNewSegmentOnTextPrepare();
         const second = mockUseSegment(segmentVector, vertexBuffer, indexBuffer, 5);
         const third = mockUseSegment(segmentVector, vertexBuffer, indexBuffer, 5);
         expect(first).toBeTruthy();

diff --git a/src/data/segment.ts b/src/data/segment.ts
@@ -25,7 +25,7 @@ export type Segment = {
 export class SegmentVector {
     static MAX_VERTEX_ARRAY_LENGTH: number;
     segments: Array<Segment>;
-    private _invalidateLast: boolean = false;
+    private _forceNewSegmentOnNextPrepare: boolean = false;
 
     constructor(segments: Array<Segment> = []) {
         this.segments = segments;
@@ -47,7 +47,7 @@ export class SegmentVector {
             warnOnce(`Max vertices per segment is ${SegmentVector.MAX_VERTEX_ARRAY_LENGTH}: bucket requested ${numVertices}. Consider using the \`fillLargeMeshArrays\` function if you require meshes with more than ${SegmentVector.MAX_VERTEX_ARRAY_LENGTH} vertices.`);
         }
 
-        if (!lastSegment || lastSegment.vertexLength + numVertices > SegmentVector.MAX_VERTEX_ARRAY_LENGTH || lastSegment.sortKey !== sortKey || this._invalidateLast) {
+        if (this._forceNewSegmentOnNextPrepare || !lastSegment || lastSegment.vertexLength + numVertices > SegmentVector.MAX_VERTEX_ARRAY_LENGTH || lastSegment.sortKey !== sortKey) {
             return this.createNewSegment(layoutVertexArray, indexArray, sortKey);
         } else {
             return lastSegment;
@@ -74,7 +74,9 @@ export class SegmentVector {
             segment.sortKey = sortKey;
         }
 
-        this._invalidateLast = false;
+        // If this was set, we have no need to create a new segment on next prepareSegment call,
+        // since this function already created a new, empty segment.
+        this._forceNewSegmentOnNextPrepare = false;
         this.segments.push(segment);
         return segment;
     }
@@ -90,8 +92,12 @@ export class SegmentVector {
         return this.prepareSegment(0, layoutVertexArray, indexArray, sortKey);
     }
 
-    invalidateLast() {
-        this._invalidateLast = true;
+    /**
+     * Causes the next call to {@link prepareSegment} to always return a new segment,
+     * not reusing the current segment even if the new geometry would fit it.
+     */
+    forceNewSegmentOnTextPrepare() {
+        this._forceNewSegmentOnNextPrepare = true;
     }
 
     get() {

diff --git a/src/render/fill_large_mesh_arrays.ts b/src/render/fill_large_mesh_arrays.ts
@@ -99,8 +99,8 @@ export function fillLargeMeshArrays(
         // Triangles and lines share vertex buffer, but we increment vertex counts of their segments by different amounts.
         // This can cause incorrect indices to be used if we reuse those segments, so we force the segment vector
         // to create new segments on the next `prepareSegment` call.
-        segmentsTriangles.invalidateLast();
-        segmentsLines?.invalidateLast();
+        segmentsTriangles.forceNewSegmentOnTextPrepare();
+        segmentsLines?.forceNewSegmentOnTextPrepare();
     }
 }