Track the number of tiles loading since loading had finished previously

[gkjohnson]

Fix #906

TODO

• Rename inCacheBeforeReset - inCacheSinceLoad?
• Consider exposing convenience members / function - loadProgress / loadProgressSinceCompletion, getLoadProgress( sinceLoad = true )

[gkjohnson]

cc @sguimmara This should be what you're looking for regarding #906. Test it out and let me know what you think. Calculating the load percent since the last load completed should work like so:

const active = tiles.stats.downloading + tiles.stats.parsing;
const total = tiles.stats.inCacheSinceLoad;
console.log( ( 100 * ( 1.0 - active / total ) ).toFixed( 2 ) );

Thought inCacheSinceLoad will reset to 0 once a load has completed so you'll have to check for that case to avoid dividing by 0.

I'm open to any suggestions for exposing both load percents as public members, as well.

[sguimmara]

That seems to do the job ! Thanks. Just one slight change: if total is zero, the value is NaN. In my case, I consider that if total is zero, then the progress is 100%.

[sguimmara]

I also updated TilesRendererBase.d.ts with the following additions:

+ export type Statistics = {
+	inCacheSinceLoad: number,
+	inCache: number,
+	parsing: number,
+	downloading: number,
+	failed: number,
+	inFrustum: number,
+	used: number,
+	active: number,
+	visible: number,
+ };

export class TilesRendererBase {

	readonly rootTileSet : object | null;
	readonly root : object | null;

+	stats: Statistics;

But that might not be a good idea to expose the stats if we use a method to query the progress instead

[gkjohnson]

I'd like to expose this as a member but I'm struggling with naming. Perhaps both percentages don't need to be exposed and "loadPercent" is enough.

[sguimmara]

I'd like to expose this as a member but I'm struggling with naming. Perhaps both percentages don't need to be exposed and "loadPercent" is enough.

I wouldn't expose a percentage (as in the [0, 100] range), but a normalized value in the [0, 1] range though.

What about a .getLoadingProgress() method ?

[gkjohnson]

I wouldn't expose a percentage (as in the [0, 100] range), but a normalized value in the [0, 1] range though.

I plan to expose it as [0, 1]

What about a .getLoadingProgress() method ?

Is this preferred to a tiles.loadPercent or loadProgress getter?

[sguimmara]

Is this preferred to a tiles.loadPercent or loadProgress getter?

Will loadPercent avoid NaN values ? If so, then let's use it directly.

[gkjohnson]

Will loadPercent avoid NaN values ? If so, then let's use it directly.

Yes it returns 1 if the total in cache value is 0.