babylon.quarks 0.27.0 → 0.28.0

package/src/trailSettings.ts

@@ -1,5 +1,8 @@
 import type {TrailSettings, TrailTextureMode} from 'quarks.core';
 
+/** A trail's settings other than its start length and side axis, alike in code and in JSON. */
+export type TrailOptions = Omit<TrailSettings, 'startLength' | 'sideAxis'>;
+
 /**
  * The normalised values of a trail's optional settings (`TrailSettings`), each read with its
  * default for a value that is unset or out of range, so the batch, the simulation, JSON and
@@ -10,13 +13,13 @@ import type {TrailSettings, TrailTextureMode} from 'quarks.core';
 export const MAX_TRAIL_TESSELLATION = 16;
 
 /** A trail's tessellation, a whole number from 0 (the default: none) to {@link MAX_TRAIL_TESSELLATION}. */
-export function trailTessellation(settings: TrailSettings | undefined): number {
+export function trailTessellation(settings: Partial<TrailOptions> | undefined): number {
     const value = Math.round(Number(settings?.tessellation) || 0);
     return Math.min(MAX_TRAIL_TESSELLATION, Math.max(0, value));
 }
 
 /** A trail's curve tension, from 0 (the default: Catmull-Rom) to 1 (straight segments). */
-export function trailCurveTension(settings: TrailSettings | undefined): number {
+export function trailCurveTension(settings: Partial<TrailOptions> | undefined): number {
     const value = Number(settings?.curveTension) || 0;
     return Math.min(1, Math.max(0, value));
 }
@@ -24,19 +27,19 @@ export function trailCurveTension(settings: TrailSettings | undefined): number {
 const TEXTURE_MODES: readonly TrailTextureMode[] = ['stretch', 'tile', 'distributePerSegment', 'repeatPerSegment'];
 
 /** A trail's texture mode, `'stretch'` (the default) unless set to one of the others. */
-export function trailTextureMode(settings: TrailSettings | undefined): TrailTextureMode {
+export function trailTextureMode(settings: Partial<TrailOptions> | undefined): TrailTextureMode {
     const mode = settings?.textureMode;
     return mode !== undefined && TEXTURE_MODES.includes(mode) ? mode : 'stretch';
 }
 
 /** A trail's texture scale: a finite number above 0, else the default 1. */
-export function trailTextureScale(settings: TrailSettings | undefined): number {
+export function trailTextureScale(settings: Partial<TrailOptions> | undefined): number {
     const value = Number(settings?.textureScale);
     return Number.isFinite(value) && value > 0 ? value : 1;
 }
 
 /** A trail's minimum distance between samples: a finite number of at least 0, else the default 0. */
-export function trailMinVertexDistance(settings: TrailSettings | undefined): number {
+export function trailMinVertexDistance(settings: Partial<TrailOptions> | undefined): number {
     const value = Number(settings?.minVertexDistance);
     return Number.isFinite(value) && value > 0 ? value : 0;
 }
@@ -45,7 +48,7 @@ export function trailMinVertexDistance(settings: TrailSettings | undefined): num
  * How long a trail keeps a sample, in seconds: a finite number above 0, else `Infinity` (the
  * default, as 0 is: until the history is full).
  */
-export function trailLifetime(settings: TrailSettings | undefined): number {
+export function trailLifetime(settings: Partial<TrailOptions> | undefined): number {
     const value = Number(settings?.lifetime);
     return Number.isFinite(value) && value > 0 ? value : Infinity;
 }