@3driseai/3drise-core 1.0.19 → 1.0.21

package/dist/properties/registry.js

@@ -0,0 +1,343 @@
+import { LIGHTS_ANIMATABLE } from '../data/lightsDefaults.js';
+import { GENERATIVE_PARTICLES_ANIMATABLE } from '../data/particlesDefaults.js';
+import { EFFECTS_ANIMATABLE } from '../data/effectsDefaults.js';
+import { GRIDS_ANIMATABLE } from '../data/gridsDefaults.js';
+import { CLOUD_ANIMATABLE_PROPERTIES } from '../environment/cloudConfigs.js';
+import { skyOptionalProperties, cloudDeckOptionalProperties, cirrusOptionalProperties, oceanSurfaceOptionalProperties, terrainOptionalProperties, rainOptionalProperties, cloudsOptionalProperties, textOptionalProperties, plainOptionalProperties, pathOptionalProperties, edgesOptionalProperties, } from './tables/optionalProperties.js';
+import { SHAPE_CONTROLS, MODE_CONTROLS } from './tables/geometryProperties.js';
+import { LIGHT_PROPERTIES, SHADOW_PROPERTIES } from './tables/lightProperties.js';
+import { PARTICLES_PROPERTIES } from './tables/particlesProperties.js';
+import { EFFECT_PROPERTIES } from './tables/effectsProperties.js';
+import { GRID_PROPERTIES } from './tables/gridProperties.js';
+import { MATERIAL_PROPERTY_BOUNDS } from './tables/materialBounds.js';
+// =============================================================================
+// Data owned here (was inline in getAnimatableProperties / the timeline)
+// =============================================================================
+/** Rain object knobs driven per frame. */
+export const RAIN_ANIMATABLE_KEYS = ['color', 'size', 'opacity', 'speed', 'windStrength', 'windDirection', 'turbulence'];
+/** Material keys that are engine bookkeeping, never a property. */
+const MATERIAL_INTERNAL = new Set(['handlers', 'apply', 'uHasTexture', 'u_time', 'u_mouse', 'u_resolution']);
+/** Material keys that are settable but never per frame (identity, render state). */
+const MATERIAL_STRUCTURAL = new Set([
+    'materialType', 'materialVariant', 'materialName', 'name', 'side', 'visible', 'map',
+    'wireframe', 'transparent', 'flatShading',
+]);
+/**
+ * Objects that own their shader: their materialSettings (if any) never reach the
+ * renderer, so they have no material properties. They animate through config.
+ */
+export const SELF_MANAGED_MATERIAL_TYPES = new Set(['effect', 'grid', 'light', 'particles']);
+const CAMERA_SPECS = [
+    { key: 'position', name: 'position', label: 'Position', kind: 'vec3', domain: 'camera', animatable: true },
+    { key: 'controls.target', name: 'target', label: 'Target', kind: 'vec3', domain: 'camera', animatable: true },
+    { key: 'fov', name: 'fov', label: 'Field of view', kind: 'number', domain: 'camera', min: 10, max: 120, step: 1, unit: 'deg', animatable: true },
+];
+const TRANSFORM_SPECS = [
+    { key: 'meshSettings.position', name: 'position', label: 'Position', kind: 'vec3', domain: 'transform', animatable: true },
+    { key: 'meshSettings.rotation', name: 'rotation', label: 'Rotation', kind: 'vec3', domain: 'transform', animatable: true },
+    { key: 'meshSettings.scale', name: 'scale', label: 'Scale', kind: 'vec3', domain: 'transform', animatable: true },
+    { key: 'meshSettings.visible', name: 'visible', label: 'Visible', kind: 'boolean', domain: 'transform', animatable: true },
+];
+// =============================================================================
+// Helpers
+// =============================================================================
+/** camelCase → "Title Case" (same as toAnimatableLabel). */
+export const propertyLabel = (key) => key.replace(/([A-Z])/g, ' $1').replace(/^./, s => s.toUpperCase()).trim();
+export function getSettingAtPath(obj, path) {
+    let cur = obj;
+    for (const part of path.split('.')) {
+        if (cur === null || cur === undefined)
+            return undefined;
+        cur = cur[part];
+    }
+    return cur;
+}
+const HEX = /^#([0-9a-f]{3}|[0-9a-f]{6})$/i;
+/** Kind of a value found on settings (material keys and table-only knobs have no spec to say). */
+export function kindOfValue(key, v) {
+    if (Array.isArray(v)) {
+        if (v.every(n => typeof n === 'number'))
+            return v.length === 3 ? 'vec3' : v.length === 2 ? 'vec2' : null;
+        return null;
+    }
+    if (typeof v === 'number')
+        return 'number';
+    if (typeof v === 'boolean')
+        return 'boolean';
+    if (typeof v === 'string') {
+        if (HEX.test(v))
+            return 'color';
+        return /map$|texture/i.test(key) ? 'texture' : 'string';
+    }
+    if (v === null && /map$|texture/i.test(key))
+        return 'texture';
+    return null;
+}
+const OPTIONAL_KIND = {
+    number: 'number', string: 'string', boolean: 'boolean', color: 'color',
+    vector3: 'vec3', vector2: 'vec2', select: 'select',
+};
+const toOptions = (p) => p.options?.length ? p.options.map((value, i) => (p.optionLabels?.[i] ? { value, label: p.optionLabels[i] } : { value })) : undefined;
+/** One controller row → spec. `animatable` is decided by the caller's rule. */
+function fromOptional(p, prefix, domain, animatable) {
+    const spec = {
+        key: `${prefix}${p.name}`,
+        name: p.name,
+        label: p.label ?? propertyLabel(p.name),
+        kind: OPTIONAL_KIND[p.type] ?? 'number',
+        domain,
+        animatable,
+    };
+    if (p.description)
+        spec.description = p.description;
+    if (p.min !== undefined)
+        spec.min = p.min;
+    if (p.max !== undefined)
+        spec.max = p.max;
+    if (p.step !== undefined)
+        spec.step = p.step;
+    if (p.unit)
+        spec.unit = p.unit;
+    if (p.default !== undefined)
+        spec.default = p.default;
+    const options = toOptions(p);
+    if (options)
+        spec.options = options;
+    if (p.tab)
+        spec.group = p.tab;
+    return spec;
+}
+/**
+ * Controller rows → specs, for panels whose element is not in the registry's
+ * element list (stars, fog, rain environment, gallery…). Numbers / colours count
+ * as animatable unless the row says otherwise; panels ignore the flag.
+ */
+export function toPropertySpecs(list, prefix = '', domain = 'config') {
+    return list.map(p => fromOptional(p, prefix, domain, envAnimatable(p)));
+}
+/** Environment rule: numbers / colours animate unless the schema says otherwise; switches never. */
+const envAnimatable = (p) => p.name !== 'enabled' && (p.type === 'number' || p.type === 'color') && p.animatable !== false;
+const envSpecs = (list, prefix, domain) => list.map(p => fromOptional(p, prefix, domain, envAnimatable(p)));
+// =============================================================================
+// Object providers
+// =============================================================================
+function materialSpecs(material, prefix, domain) {
+    if (!material || typeof material !== 'object')
+        return [];
+    const out = [];
+    for (const [name, value] of Object.entries(material)) {
+        if (MATERIAL_INTERNAL.has(name))
+            continue;
+        const kind = kindOfValue(name, value);
+        if (!kind)
+            continue;
+        const bounds = MATERIAL_PROPERTY_BOUNDS[name];
+        const spec = {
+            key: `${prefix}${name}`,
+            name,
+            label: bounds?.label ?? propertyLabel(name),
+            kind,
+            domain,
+            animatable: !MATERIAL_STRUCTURAL.has(name) && (kind === 'number' || kind === 'color' || kind === 'boolean' || kind === 'vec3'),
+        };
+        if (bounds && kind === 'number') {
+            spec.min = bounds.min;
+            spec.max = bounds.max;
+            spec.step = bounds.step;
+        }
+        out.push(spec);
+    }
+    return out;
+}
+function edgesSpecs(obj) {
+    const edges = obj?.edgesSettings;
+    if (!edges)
+        return [];
+    const out = [];
+    for (const p of edgesOptionalProperties) {
+        // A size knob only exists for the edge type that draws it.
+        if (p.name === 'tubeRadius' && edges.type !== 'tube')
+            continue;
+        if (p.name === 'cubeSize' && edges.type !== 'cube')
+            continue;
+        out.push(fromOptional(p, 'edgesSettings.', 'edges', false));
+    }
+    out.push(...materialSpecs(edges.materialSettings, 'edgesSettings.materialSettings.', 'edges'));
+    return out;
+}
+/** Geometry shape / display mode controls → structural specs. */
+function controlSpecs(controls, prefix, group) {
+    return (controls ?? []).map(c => {
+        const spec = {
+            key: `${prefix}${c.key}`,
+            name: c.key,
+            label: c.label,
+            kind: c.type === 'range' ? 'number' : c.type === 'toggle' ? 'boolean' : 'string',
+            domain: 'config',
+            group,
+            animatable: false,
+            default: c.default,
+        };
+        if (c.type === 'range') {
+            spec.min = c.min;
+            spec.max = c.max;
+            spec.step = c.step;
+            if (c.unit)
+                spec.unit = c.unit;
+        }
+        return spec;
+    });
+}
+const tableOf = (rows) => new Map((rows ?? []).map(r => [r.value, r.label]));
+/** The config family of an object: by object type, else by config.type (as getAnimatableProperties does). */
+function familyOf(obj) {
+    const t = obj?.config?.type;
+    const type = obj?.type;
+    const light = () => ({ domain: 'light', list: LIGHT_PROPERTIES[t] ?? [], animatable: tableOf(LIGHTS_ANIMATABLE[t]) });
+    const particles = () => ({ domain: 'particles', list: PARTICLES_PROPERTIES[t] ?? [], animatable: tableOf(GENERATIVE_PARTICLES_ANIMATABLE[t]) });
+    const effect = () => ({ domain: 'effect', list: EFFECT_PROPERTIES[t] ?? [], animatable: tableOf(EFFECTS_ANIMATABLE[t]) });
+    const grid = () => ({ domain: 'grid', list: GRID_PROPERTIES[t] ?? [], animatable: tableOf(GRIDS_ANIMATABLE[t]) });
+    if (t) {
+        if (type === 'light')
+            return light();
+        if (type === 'particles')
+            return particles();
+        if (type === 'effect')
+            return effect();
+        if (type === 'grid')
+            return grid();
+        if (t === 'rain')
+            return { domain: 'rain', list: rainOptionalProperties, animatable: new Map(RAIN_ANIMATABLE_KEYS.map(k => [k, propertyLabel(k)])) };
+        if (t === 'clouds')
+            return { domain: 'clouds', list: cloudsOptionalProperties, animatable: new Map(CLOUD_ANIMATABLE_PROPERTIES.map(k => [k, propertyLabel(k)])) };
+        // Older objects carry a generative config under another object type.
+        if (LIGHTS_ANIMATABLE[t])
+            return light();
+        if (EFFECTS_ANIMATABLE[t])
+            return effect();
+        if (GRIDS_ANIMATABLE[t])
+            return grid();
+        if (GENERATIVE_PARTICLES_ANIMATABLE[t])
+            return particles();
+    }
+    if (type === 'text')
+        return { domain: 'config', list: textOptionalProperties, animatable: null };
+    if (type === 'plain')
+        return { domain: 'config', list: plainOptionalProperties, animatable: null };
+    if (type === 'path')
+        return { domain: 'config', list: pathOptionalProperties, animatable: null };
+    return null;
+}
+function configSpecs(obj) {
+    // Created shapes: the shape's own knobs (by config.type) and its display mode's.
+    if (obj?.type === 'mesh' && obj.config?.type && SHAPE_CONTROLS[obj.config.type]) {
+        return [
+            ...controlSpecs(SHAPE_CONTROLS[obj.config.type], 'config.', 'shape'),
+            ...controlSpecs(MODE_CONTROLS[obj.modeConfig?.mode ?? 'solid'], 'modeConfig.', 'mode'),
+        ];
+    }
+    const family = familyOf(obj);
+    if (!family)
+        return [];
+    const { domain, list, animatable } = family;
+    const out = [];
+    const seen = new Set();
+    for (const p of list) {
+        const spec = fromOptional(p, 'config.', domain, !!animatable?.has(p.name));
+        out.push(spec);
+        seen.add(p.name);
+    }
+    // Knobs the renderer drives per frame that the panel does not list.
+    for (const [name, label] of animatable ?? []) {
+        if (seen.has(name))
+            continue;
+        const kind = kindOfValue(name, obj?.config?.[name]) ?? 'number';
+        out.push({ key: `config.${name}`, name, label: label || propertyLabel(name), kind, domain, animatable: true });
+    }
+    if (domain === 'light') {
+        for (const p of SHADOW_PROPERTIES[obj.config.type] ?? []) {
+            out.push({ ...fromOptional(p, 'config.shadow.', 'shadow', false), group: 'shadow' });
+        }
+    }
+    return out;
+}
+function objectSpecs(obj) {
+    if (!obj)
+        return [];
+    const ownsMaterial = !SELF_MANAGED_MATERIAL_TYPES.has(obj.type);
+    return [
+        ...TRANSFORM_SPECS,
+        ...(ownsMaterial ? materialSpecs(obj.materialSettings, 'materialSettings.', 'material') : []),
+        ...edgesSpecs(obj),
+        ...configSpecs(obj),
+    ];
+}
+// =============================================================================
+// Environment providers
+// =============================================================================
+function environmentSpecs(element, settings) {
+    switch (element) {
+        case 'sky':
+            return envSpecs(skyOptionalProperties, '', 'sky');
+        case 'clouds':
+            return [
+                ...envSpecs(cloudDeckOptionalProperties(settings?.config?.deckType), 'config.', 'clouds'),
+                ...envSpecs(cirrusOptionalProperties, 'cirrus.', 'cirrus'),
+            ];
+        case 'ocean':
+            return envSpecs(oceanSurfaceOptionalProperties(settings?.config?.waterType, settings?.config?.host), 'config.', 'ocean');
+        case 'terrain':
+            return envSpecs(terrainOptionalProperties(settings?.config?.terrainType), 'config.', 'terrain');
+        default:
+            return [];
+    }
+}
+// =============================================================================
+// API
+// =============================================================================
+/** Every property that applies to this element (structural and animatable). */
+export function getPropertySpecs(element, settings) {
+    if (element === 'object')
+        return objectSpecs(settings);
+    if (element === 'camera')
+        return CAMERA_SPECS.map(s => ({ ...s }));
+    return environmentSpecs(element, settings);
+}
+/**
+ * The property's layer is on: a hidden layer's knobs change nothing, so nothing
+ * offers them for animation (edges switched off, cloud deck / cirrus disabled).
+ */
+export function isPropertyLive(element, spec, settings) {
+    if (spec.domain === 'edges')
+        return settings?.edgesSettings?.enabled !== false;
+    if (element === 'clouds')
+        return spec.domain === 'cirrus' ? !!settings?.cirrus?.enabled : !!settings?.config?.enabled;
+    return true;
+}
+/** Properties that can be driven per frame on this element right now. */
+export function getAnimatableSpecs(element, settings) {
+    return getPropertySpecs(element, settings).filter(s => s.animatable && isPropertyLive(element, s, settings));
+}
+/**
+ * Object config families the animation timeline keys. The V2 applier drives
+ * `config.*` through the object's live config handle, which these four register;
+ * rain and the legacy cloud object have per-frame knobs for the keyframe /
+ * mouse-move systems only.
+ */
+export const TRACK_CONFIG_DOMAINS = new Set(['light', 'particles', 'effect', 'grid']);
+/** What an animation clip can key on this element (timeline track picker, AI clips). */
+export function getTrackSpecs(element, settings) {
+    const specs = getAnimatableSpecs(element, settings);
+    if (element !== 'object')
+        return specs;
+    return specs.filter(s => s.domain === 'transform' || s.domain === 'material' || s.domain === 'edges' || TRACK_CONFIG_DOMAINS.has(s.domain));
+}
+export function getPropertySpec(element, settings, key) {
+    return getPropertySpecs(element, settings).find(s => s.key === key);
+}
+/** Specs with the element's current values. */
+export function describeProperties(element, settings) {
+    return getPropertySpecs(element, settings).map(s => ({ ...s, value: getSettingAtPath(settings, s.key) }));
+}
+/** The registry element for an animation / timeline state: env keys and camera as-is, anything else is an object id. */
+export const elementOfState = (state) => state === 'camera' || state === 'sky' || state === 'clouds' || state === 'ocean' || state === 'terrain' ? state : 'object';

package/dist/properties/tables/effectsProperties.d.ts

@@ -0,0 +1,40 @@
+import type { OptionalProperty } from './optionalProperties';
+import type { GenerativeEffectType } from '../../types/generativeEffects';
+export declare const moleculesEffectProperties: OptionalProperty[];
+export declare const shockwaveEffectProperties: OptionalProperty[];
+export declare const auraEffectProperties: OptionalProperty[];
+export declare const dataStreamEffectProperties: OptionalProperty[];
+export declare const constellationEffectProperties: OptionalProperty[];
+export declare const hologramEffectProperties: OptionalProperty[];
+export declare const portalEffectProperties: OptionalProperty[];
+export declare const dnaHelixEffectProperties: OptionalProperty[];
+export declare const orbEffectProperties: OptionalProperty[];
+export declare const lightningEffectProperties: OptionalProperty[];
+export declare const auroraEffectProperties: OptionalProperty[];
+export declare const fireEffectProperties: OptionalProperty[];
+export declare const forcefieldEffectProperties: OptionalProperty[];
+export declare const neuralNetworkEffectProperties: OptionalProperty[];
+export declare const blackHoleEffectProperties: OptionalProperty[];
+export declare const iceCrystalsEffectProperties: OptionalProperty[];
+export declare const smokePlumeEffectProperties: OptionalProperty[];
+export declare const volumetricFogEffectProperties: OptionalProperty[];
+export declare const smokeRingEffectProperties: OptionalProperty[];
+export declare const fieldLinesEffectProperties: OptionalProperty[];
+export declare const strangeAttractorEffectProperties: OptionalProperty[];
+export declare const harmonicShellEffectProperties: OptionalProperty[];
+export declare const galaxyEffectProperties: OptionalProperty[];
+export declare const fireflySwarmEffectProperties: OptionalProperty[];
+export declare const murmurationEffectProperties: OptionalProperty[];
+export declare const planetaryRingsEffectProperties: OptionalProperty[];
+export declare const waterCausticsEffectProperties: OptionalProperty[];
+export declare const iceHaloEffectProperties: OptionalProperty[];
+export declare const fallingLeavesEffectProperties: OptionalProperty[];
+export declare const lichtenbergEffectProperties: OptionalProperty[];
+export declare const dandelionSeedsEffectProperties: OptionalProperty[];
+export declare const flaresEffectProperties: OptionalProperty[];
+export declare const sparklesBurstEffectProperties: OptionalProperty[];
+export declare const bubblesEffectProperties: OptionalProperty[];
+export declare const glyphsEffectProperties: OptionalProperty[];
+export declare const smokeRibbonEffectProperties: OptionalProperty[];
+export declare const EFFECT_PROPERTIES: Record<GenerativeEffectType, OptionalProperty[]>;
+//# sourceMappingURL=effectsProperties.d.ts.map

package/dist/properties/tables/effectsProperties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"effectsProperties.d.ts","sourceRoot":"","sources":["../../../src/properties/tables/effectsProperties.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAY1E,eAAO,MAAM,yBAAyB,EAAE,gBAAgB,EAcvD,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,gBAAgB,EAevD,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,gBAAgB,EAWlD,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,gBAAgB,EAaxD,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,gBAAgB,EAU3D,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,gBAAgB,EAUtD,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,gBAAgB,EAcpD,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,gBAAgB,EAUtD,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,gBAAgB,EAYjD,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,gBAAgB,EASvD,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,gBAAgB,EAQpD,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,gBAAgB,EAclD,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,gBAAgB,EAQxD,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,gBAAgB,EAS3D,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,gBAAgB,EAcvD,CAAC;AAEF,eAAO,MAAM,2BAA2B,EAAE,gBAAgB,EAYzD,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,gBAAgB,EAWxD,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,gBAAgB,EAa3D,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,gBAAgB,EAYvD,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,gBAAgB,EAaxD,CAAC;AAEF,eAAO,MAAM,gCAAgC,EAAE,gBAAgB,EAa9D,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,gBAAgB,EAW3D,CAAC;AAMF,eAAO,MAAM,sBAAsB,EAAE,gBAAgB,EAapD,CAAC;AAEF,eAAO,MAAM,4BAA4B,EAAE,gBAAgB,EAY1D,CAAC;AAEF,eAAO,MAAM,2BAA2B,EAAE,gBAAgB,EAWzD,CAAC;AAEF,eAAO,MAAM,8BAA8B,EAAE,gBAAgB,EAe5D,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,gBAAgB,EAW3D,CAAC;AAEF,eAAO,MAAM,uBAAuB,EAAE,gBAAgB,EAWrD,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,gBAAgB,EAY3D,CAAC;AAEF,eAAO,MAAM,2BAA2B,EAAE,gBAAgB,EAWzD,CAAC;AAEF,eAAO,MAAM,8BAA8B,EAAE,gBAAgB,EAY5D,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,gBAAgB,EASpD,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,gBAAgB,EAY3D,CAAC;AAEF,eAAO,MAAM,uBAAuB,EAAE,gBAAgB,EASrD,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,gBAAgB,EAapD,CAAC;AAEF,eAAO,MAAM,2BAA2B,EAAE,gBAAgB,EAmBzD,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,MAAM,CAAC,oBAAoB,EAAE,gBAAgB,EAAE,CAqC9E,CAAC"}