@call-me-sensei/toonlab 0.1.1

package/src/toon/settings/sceneShadowSettings.js

@@ -0,0 +1,147 @@
+export const DEFAULT_SCENE_SHADOW_SETTINGS = Object.freeze({
+  defaultMinLight: 0.24,
+  defaultStrength: 0.76,
+  enabled: true,
+  eyeMinLight: 0.42,
+  eyeStrength: 0.05,
+  faceMinLight: 0.42,
+  faceStrength: 0.46,
+  shadowAreaStrength: 0.65,
+  skinMinLight: 0.34,
+  skinStrength: 0.62,
+});
+
+function firstDefined(source, keys) {
+  for (const key of keys) {
+    if (source?.[key] !== undefined) return source[key];
+  }
+  return undefined;
+}
+
+function numberOption(value, fallback, { min = -Infinity, max = Infinity } = {}) {
+  const nextValue = Number(value);
+  if (!Number.isFinite(nextValue)) return fallback;
+  return Math.min(max, Math.max(min, nextValue));
+}
+
+export function createSceneShadowSettings(options = null) {
+  const source = options || {};
+  const enabled = source.enabled !== false;
+
+  const defaultStrength = enabled
+    ? numberOption(
+      firstDefined(source, [
+        'defaultStrength',
+        'strength',
+        'receiveStrength',
+        'receivedShadowStrength',
+      ]),
+      DEFAULT_SCENE_SHADOW_SETTINGS.defaultStrength,
+      { min: 0, max: 1 },
+    )
+    : 0;
+  const defaultMinLight = enabled
+    ? numberOption(
+      firstDefined(source, [
+        'defaultMinLight',
+        'minLight',
+        'receiveMinLight',
+        'receivedShadowMinLight',
+      ]),
+      DEFAULT_SCENE_SHADOW_SETTINGS.defaultMinLight,
+      { min: 0, max: 1 },
+    )
+    : 1;
+
+  return {
+    defaultMinLight,
+    defaultStrength,
+    enabled,
+    eyeMinLight: enabled
+      ? numberOption(
+        firstDefined(source, ['eyeMinLight', 'eyeReceivedShadowMinLight']),
+        DEFAULT_SCENE_SHADOW_SETTINGS.eyeMinLight,
+        { min: 0, max: 1 },
+      )
+      : 1,
+    eyeStrength: enabled
+      ? numberOption(
+        firstDefined(source, ['eyeStrength', 'eyeReceiveStrength', 'eyeReceivedShadowStrength']),
+        DEFAULT_SCENE_SHADOW_SETTINGS.eyeStrength,
+        { min: 0, max: 1 },
+      )
+      : 0,
+    faceMinLight: enabled
+      ? numberOption(
+        firstDefined(source, ['faceMinLight', 'faceReceivedShadowMinLight']),
+        DEFAULT_SCENE_SHADOW_SETTINGS.faceMinLight,
+        { min: 0, max: 1 },
+      )
+      : 1,
+    faceStrength: enabled
+      ? numberOption(
+        firstDefined(source, ['faceStrength', 'faceReceiveStrength', 'faceReceivedShadowStrength']),
+        DEFAULT_SCENE_SHADOW_SETTINGS.faceStrength,
+        { min: 0, max: 1 },
+      )
+      : 0,
+    shadowAreaStrength: enabled
+      ? numberOption(
+        firstDefined(source, [
+          'shadowAreaStrength',
+          'directVisibilityStrength',
+          'sceneShadowBlend',
+          'shadowBlend',
+        ]),
+        DEFAULT_SCENE_SHADOW_SETTINGS.shadowAreaStrength,
+        { min: 0, max: 1 },
+      )
+      : 0,
+    skinMinLight: enabled
+      ? numberOption(
+        firstDefined(source, ['skinMinLight', 'skinReceivedShadowMinLight']),
+        DEFAULT_SCENE_SHADOW_SETTINGS.skinMinLight,
+        { min: 0, max: 1 },
+      )
+      : 1,
+    skinStrength: enabled
+      ? numberOption(
+        firstDefined(source, ['skinStrength', 'skinReceiveStrength', 'skinReceivedShadowStrength']),
+        DEFAULT_SCENE_SHADOW_SETTINGS.skinStrength,
+        { min: 0, max: 1 },
+      )
+      : 0,
+  };
+}
+
+export function resolveSceneShadowForMaterial(settings, {
+  isEye = false,
+  isFace = false,
+  isSkin = false,
+} = {}) {
+  if (isEye) {
+    return {
+      minLight: settings.eyeMinLight,
+      strength: settings.eyeStrength,
+    };
+  }
+
+  if (isFace) {
+    return {
+      minLight: settings.faceMinLight,
+      strength: settings.faceStrength,
+    };
+  }
+
+  if (isSkin) {
+    return {
+      minLight: settings.skinMinLight,
+      strength: settings.skinStrength,
+    };
+  }
+
+  return {
+    minLight: settings.defaultMinLight,
+    strength: settings.defaultStrength,
+  };
+}

package/src/toon/settings/selfShadowSettings.js

@@ -0,0 +1,221 @@
+export const SELF_SHADOW_SOURCE_MODES = Object.freeze({
+  off: 0,
+  sceneProxy: 1,
+  // Dedicated character-only orthographic shadow map rendered by
+  // characterRenderPasses.js. Materials fall back to "no self shadow" when the
+  // runtime pass is not active, so this is safe as a default source.
+  characterPass: 2,
+});
+
+export const DEFAULT_SELF_SHADOW_SETTINGS = Object.freeze({
+  defaultMinLight: 0.62,
+  defaultStrength: 0.22,
+  enabled: true,
+  eyeMinLight: 1,
+  eyeStrength: 0,
+  faceMinLight: 1,
+  faceStrength: 0,
+  hairMinLight: 0.58,
+  hairStrength: 0.26,
+  shadowAreaStrength: 0.5,
+  skinMinLight: 0.72,
+  skinStrength: 0.16,
+  sourceMode: SELF_SHADOW_SOURCE_MODES.characterPass,
+});
+
+function firstDefined(source, keys) {
+  for (const key of keys) {
+    if (source?.[key] !== undefined) return source[key];
+  }
+  return undefined;
+}
+
+function numberOption(value, fallback, { min = -Infinity, max = Infinity } = {}) {
+  const nextValue = Number(value);
+  if (!Number.isFinite(nextValue)) return fallback;
+  return Math.min(max, Math.max(min, nextValue));
+}
+
+function normalizeSourceMode(value, enabled) {
+  if (value === SELF_SHADOW_SOURCE_MODES.sceneProxy) return SELF_SHADOW_SOURCE_MODES.sceneProxy;
+  if (value === SELF_SHADOW_SOURCE_MODES.characterPass) return SELF_SHADOW_SOURCE_MODES.characterPass;
+
+  const key = String(value ?? (enabled ? 'characterPass' : 'off'))
+    .trim()
+    .replace(/[\s_-]+/g, '')
+    .toLowerCase();
+
+  if (
+    key === 'scene' ||
+    key === 'sceneshadow' ||
+    key === 'sceneproxy' ||
+    key === 'shadowmask'
+  ) {
+    return SELF_SHADOW_SOURCE_MODES.sceneProxy;
+  }
+
+  if (
+    key === 'characterpass' ||
+    key === 'character' ||
+    key === 'charpass' ||
+    key === 'pass' ||
+    key === 'shadowmap' ||
+    key === 'selfshadowmap'
+  ) {
+    return SELF_SHADOW_SOURCE_MODES.characterPass;
+  }
+
+  return SELF_SHADOW_SOURCE_MODES.off;
+}
+
+function normalizeSelfShadowOptions(options) {
+  if (options === false) return { enabled: false };
+  if (options === true) return { enabled: true };
+  if (typeof options === 'string') {
+    const key = options.trim().toLowerCase();
+    return {
+      enabled: key !== 'off' && key !== 'none' && key !== 'false' && key !== '0',
+      sourceMode: options,
+    };
+  }
+  return options || {};
+}
+
+export function createSelfShadowSettings(options = null) {
+  const source = normalizeSelfShadowOptions(options);
+  const requestedSourceMode = firstDefined(source, ['sourceMode', 'source', 'mode', 'maskSource']);
+  const enabled = source.enabled === true ||
+    (source.enabled !== false &&
+      (requestedSourceMode !== undefined || DEFAULT_SELF_SHADOW_SETTINGS.enabled));
+  const sourceMode = enabled
+    ? normalizeSourceMode(requestedSourceMode, enabled)
+    : SELF_SHADOW_SOURCE_MODES.off;
+  const active = enabled && sourceMode !== SELF_SHADOW_SOURCE_MODES.off;
+
+  return {
+    defaultMinLight: active
+      ? numberOption(
+        firstDefined(source, ['defaultMinLight', 'minLight', 'selfShadowMinLight']),
+        DEFAULT_SELF_SHADOW_SETTINGS.defaultMinLight,
+        { min: 0, max: 1 },
+      )
+      : 1,
+    defaultStrength: active
+      ? numberOption(
+        firstDefined(source, ['defaultStrength', 'strength', 'selfShadowStrength']),
+        DEFAULT_SELF_SHADOW_SETTINGS.defaultStrength,
+        { min: 0, max: 1 },
+      )
+      : 0,
+    enabled: active,
+    eyeMinLight: active
+      ? numberOption(
+        firstDefined(source, ['eyeMinLight', 'eyeSelfShadowMinLight']),
+        DEFAULT_SELF_SHADOW_SETTINGS.eyeMinLight,
+        { min: 0, max: 1 },
+      )
+      : 1,
+    eyeStrength: active
+      ? numberOption(
+        firstDefined(source, ['eyeStrength', 'eyeSelfShadowStrength']),
+        DEFAULT_SELF_SHADOW_SETTINGS.eyeStrength,
+        { min: 0, max: 1 },
+      )
+      : 0,
+    faceMinLight: active
+      ? numberOption(
+        firstDefined(source, ['faceMinLight', 'faceSelfShadowMinLight']),
+        DEFAULT_SELF_SHADOW_SETTINGS.faceMinLight,
+        { min: 0, max: 1 },
+      )
+      : 1,
+    faceStrength: active
+      ? numberOption(
+        firstDefined(source, ['faceStrength', 'faceSelfShadowStrength']),
+        DEFAULT_SELF_SHADOW_SETTINGS.faceStrength,
+        { min: 0, max: 1 },
+      )
+      : 0,
+    hairMinLight: active
+      ? numberOption(
+        firstDefined(source, ['hairMinLight', 'hairSelfShadowMinLight']),
+        DEFAULT_SELF_SHADOW_SETTINGS.hairMinLight,
+        { min: 0, max: 1 },
+      )
+      : 1,
+    hairStrength: active
+      ? numberOption(
+        firstDefined(source, ['hairStrength', 'hairSelfShadowStrength']),
+        DEFAULT_SELF_SHADOW_SETTINGS.hairStrength,
+        { min: 0, max: 1 },
+      )
+      : 0,
+    shadowAreaStrength: active
+      ? numberOption(
+        firstDefined(source, [
+          'shadowAreaStrength',
+          'selfShadowAreaStrength',
+          'areaStrength',
+          'blend',
+        ]),
+        DEFAULT_SELF_SHADOW_SETTINGS.shadowAreaStrength,
+        { min: 0, max: 1 },
+      )
+      : 0,
+    skinMinLight: active
+      ? numberOption(
+        firstDefined(source, ['skinMinLight', 'skinSelfShadowMinLight']),
+        DEFAULT_SELF_SHADOW_SETTINGS.skinMinLight,
+        { min: 0, max: 1 },
+      )
+      : 1,
+    skinStrength: active
+      ? numberOption(
+        firstDefined(source, ['skinStrength', 'skinSelfShadowStrength']),
+        DEFAULT_SELF_SHADOW_SETTINGS.skinStrength,
+        { min: 0, max: 1 },
+      )
+      : 0,
+    sourceMode,
+  };
+}
+
+export function resolveSelfShadowForMaterial(settings, {
+  isEye = false,
+  isFace = false,
+  isHair = false,
+  isSkin = false,
+} = {}) {
+  if (isEye) {
+    return {
+      minLight: settings.eyeMinLight,
+      strength: settings.eyeStrength,
+    };
+  }
+
+  if (isFace) {
+    return {
+      minLight: settings.faceMinLight,
+      strength: settings.faceStrength,
+    };
+  }
+
+  if (isSkin) {
+    return {
+      minLight: settings.skinMinLight,
+      strength: settings.skinStrength,
+    };
+  }
+
+  if (isHair) {
+    return {
+      minLight: settings.hairMinLight,
+      strength: settings.hairStrength,
+    };
+  }
+
+  return {
+    minLight: settings.defaultMinLight,
+    strength: settings.defaultStrength,
+  };
+}

package/src/toon/settings/shadowColorSettings.js

@@ -0,0 +1,238 @@
+import * as THREE from 'three';
+
+export const DEFAULT_SHADOW_COLOR_SETTINGS = Object.freeze({
+  enabled: true,
+  lowSaturationFallbackColor: [0.3764706, 0.4141177, 0.5019608, 0],
+  selfShadowAlbedoMulStrength: 0,
+  selfShadowAreaHSVStrength: 1,
+  selfShadowAreaHueOffset: 0,
+  selfShadowAreaSaturationBoost: 0.2,
+  selfShadowAreaValueMul: 0.68,
+  selfShadowTintColor: [1, 1, 1],
+  transitionAreaHueOffset: 0.01,
+  transitionAreaIntensity: 1,
+  transitionAreaSaturationBoost: 0.36,
+  transitionAreaTintColor: [1, 1, 1],
+  transitionAreaValueMul: 1,
+});
+
+export const REFERENCE_SHADOW_COLOR_SETTINGS = Object.freeze({
+  ...DEFAULT_SHADOW_COLOR_SETTINGS,
+  selfShadowAreaValueMul: 0.7,
+  transitionAreaSaturationBoost: 0.5,
+});
+
+export const SHADOW_COLOR_PRESETS = Object.freeze({
+  baseline: DEFAULT_SHADOW_COLOR_SETTINGS,
+  reference: REFERENCE_SHADOW_COLOR_SETTINGS,
+});
+
+function firstDefined(source, keys) {
+  for (const key of keys) {
+    if (source?.[key] !== undefined) return source[key];
+  }
+  return undefined;
+}
+
+function numberOption(value, fallback, { min = -Infinity, max = Infinity } = {}) {
+  const nextValue = Number(value);
+  if (!Number.isFinite(nextValue)) return fallback;
+  return THREE.MathUtils.clamp(nextValue, min, max);
+}
+
+function colorOption(value, fallback) {
+  if (value?.isColor) return value.clone();
+
+  if (Array.isArray(value) && value.length >= 3) {
+    return new THREE.Color(
+      numberOption(value[0], fallback[0] ?? fallback.r ?? 1),
+      numberOption(value[1], fallback[1] ?? fallback.g ?? 1),
+      numberOption(value[2], fallback[2] ?? fallback.b ?? 1),
+    );
+  }
+
+  if (typeof value === 'object' && value !== null) {
+    return new THREE.Color(
+      numberOption(value.r, fallback[0] ?? fallback.r ?? 1),
+      numberOption(value.g, fallback[1] ?? fallback.g ?? 1),
+      numberOption(value.b, fallback[2] ?? fallback.b ?? 1),
+    );
+  }
+
+  if (typeof value === 'string' || typeof value === 'number') {
+    try {
+      return new THREE.Color(value);
+    } catch {
+      // Fall through to the normalized fallback below.
+    }
+  }
+
+  return Array.isArray(fallback)
+    ? new THREE.Color(fallback[0], fallback[1], fallback[2])
+    : fallback.clone();
+}
+
+function vector4Option(value, fallback) {
+  if (value?.isVector4) return value.clone();
+
+  if (Array.isArray(value) && value.length >= 4) {
+    return new THREE.Vector4(
+      numberOption(value[0], fallback[0] ?? fallback.x ?? 0),
+      numberOption(value[1], fallback[1] ?? fallback.y ?? 0),
+      numberOption(value[2], fallback[2] ?? fallback.z ?? 0),
+      numberOption(value[3], fallback[3] ?? fallback.w ?? 0),
+    );
+  }
+
+  if (typeof value === 'object' && value !== null) {
+    return new THREE.Vector4(
+      numberOption(value.x ?? value.r, fallback[0] ?? fallback.x ?? 0),
+      numberOption(value.y ?? value.g, fallback[1] ?? fallback.y ?? 0),
+      numberOption(value.z ?? value.b, fallback[2] ?? fallback.z ?? 0),
+      numberOption(value.w ?? value.a, fallback[3] ?? fallback.w ?? 0),
+    );
+  }
+
+  return Array.isArray(fallback)
+    ? new THREE.Vector4(fallback[0], fallback[1], fallback[2], fallback[3])
+    : fallback.clone();
+}
+
+function resolvePresetDefaults(source) {
+  const presetName = String(firstDefined(source, ['preset', 'profile']) || 'baseline').toLowerCase();
+  return SHADOW_COLOR_PRESETS[presetName] || DEFAULT_SHADOW_COLOR_SETTINGS;
+}
+
+export function createShadowColorSettings(options = null) {
+  const source = typeof options === 'string' ? { preset: options } : options || {};
+  const presetDefaults = resolvePresetDefaults(source);
+  const enabled = source.enabled !== false;
+
+  return {
+    enabled,
+    lowSaturationFallbackColor: vector4Option(
+      firstDefined(source, [
+        'lowSaturationFallbackColor',
+        'lowSaturationFallback',
+        'fallbackColor',
+      ]),
+      presetDefaults.lowSaturationFallbackColor,
+    ),
+    selfShadowAlbedoMulStrength: enabled
+      ? numberOption(
+        firstDefined(source, [
+          'selfShadowAlbedoMulStrength',
+          'shadowAlbedoMulStrength',
+          'albedoMulStrength',
+        ]),
+        presetDefaults.selfShadowAlbedoMulStrength,
+        { min: 0, max: 1 },
+      )
+      : presetDefaults.selfShadowAlbedoMulStrength,
+    selfShadowAreaHSVStrength: enabled
+      ? numberOption(
+        firstDefined(source, [
+          'selfShadowAreaHSVStrength',
+          'shadowHSVStrength',
+          'hsvStrength',
+        ]),
+        presetDefaults.selfShadowAreaHSVStrength,
+        { min: 0, max: 1 },
+      )
+      : 0,
+    selfShadowAreaHueOffset: enabled
+      ? numberOption(
+        firstDefined(source, [
+          'selfShadowAreaHueOffset',
+          'shadowHueOffset',
+          'hueOffset',
+        ]),
+        presetDefaults.selfShadowAreaHueOffset,
+        { min: -1, max: 1 },
+      )
+      : presetDefaults.selfShadowAreaHueOffset,
+    selfShadowAreaSaturationBoost: enabled
+      ? numberOption(
+        firstDefined(source, [
+          'selfShadowAreaSaturationBoost',
+          'shadowSaturationBoost',
+          'saturationBoost',
+        ]),
+        presetDefaults.selfShadowAreaSaturationBoost,
+        { min: 0, max: 1 },
+      )
+      : 0,
+    selfShadowAreaValueMul: enabled
+      ? numberOption(
+        firstDefined(source, [
+          'selfShadowAreaValueMul',
+          'shadowValueMul',
+          'valueMul',
+        ]),
+        presetDefaults.selfShadowAreaValueMul,
+        { min: 0, max: 1 },
+      )
+      : 1,
+    selfShadowTintColor: colorOption(
+      firstDefined(source, [
+        'selfShadowTintColor',
+        'shadowTintColor',
+        'shadowTint',
+      ]),
+      presetDefaults.selfShadowTintColor,
+    ),
+    transitionAreaHueOffset: enabled
+      ? numberOption(
+        firstDefined(source, [
+          'transitionAreaHueOffset',
+          'litToShadowTransitionAreaHueOffset',
+          'transitionHueOffset',
+        ]),
+        presetDefaults.transitionAreaHueOffset,
+        { min: -1, max: 1 },
+      )
+      : presetDefaults.transitionAreaHueOffset,
+    transitionAreaIntensity: enabled
+      ? numberOption(
+        firstDefined(source, [
+          'transitionAreaIntensity',
+          'litToShadowTransitionAreaIntensity',
+          'transitionIntensity',
+        ]),
+        presetDefaults.transitionAreaIntensity,
+        { min: 0, max: 32 },
+      )
+      : 0,
+    transitionAreaSaturationBoost: enabled
+      ? numberOption(
+        firstDefined(source, [
+          'transitionAreaSaturationBoost',
+          'litToShadowTransitionAreaSaturationBoost',
+          'transitionSaturationBoost',
+        ]),
+        presetDefaults.transitionAreaSaturationBoost,
+        { min: 0, max: 1 },
+      )
+      : 0,
+    transitionAreaTintColor: colorOption(
+      firstDefined(source, [
+        'transitionAreaTintColor',
+        'litToShadowTransitionAreaTintColor',
+        'transitionTintColor',
+        'transitionTint',
+      ]),
+      presetDefaults.transitionAreaTintColor,
+    ),
+    transitionAreaValueMul: enabled
+      ? numberOption(
+        firstDefined(source, [
+          'transitionAreaValueMul',
+          'litToShadowTransitionAreaValueMul',
+          'transitionValueMul',
+        ]),
+        presetDefaults.transitionAreaValueMul,
+        { min: 0, max: 1 },
+      )
+      : 1,
+  };
+}