@fps-games/vfx 0.1.1

package/packages/resource.particle.viscous_oil_suction/assets/runtime/top_disk_suction/particleEmitter.v1.js

@@ -0,0 +1,424 @@
+export const runtimeId = "particleEmitter/topDiskSuction/v1";
+
+export const runtimeContract = {
+  runtimeId,
+  kind: "particleEmitter",
+  emitterFields: {
+    capacity: "Maximum Babylon particle capacity.",
+    particleTexturePath: "Package-relative particle texture path used to load the Babylon ParticleSystem.particleTexture.",
+    blendMode: "Babylon particle blend mode label: ADD, STANDARD, MULTIPLY, or ONEONE.",
+    shape: "Emitter shape definition generated by the Cocos conversion stage.",
+    renderColor: "Converted particle color inputs: one base color plus RGB/alpha intensity before writing Babylon color1/color2/colorDead.",
+    alphaKeys: "Color alpha gradients sampled over normalized particle lifetime.",
+    sizeKeys: "Size gradients sampled over normalized particle lifetime.",
+    velocityOverLifetime: "Cocos VelocityOvertimeModule vector velocity sampled over normalized particle lifetime.",
+    topDiskSuction: "Reusable behavior config for sampling particles on a top disk and directing them toward a target center.",
+  },
+  runtimeBindings: {
+    "ParticleSystem.particleTexture": "Texture loaded from emitter.particleTexturePath through urlForPackagePath.",
+    "ParticleSystem.blendMode": "Mapped from emitter.blendMode.",
+    "ParticleSystem.manualEmitCount": "emitter.manualEmitCount when emitRate is 0.",
+    "ParticleSystem.emitRate": "emitter.emitRate for sustained emitters.",
+    "ParticleSystem.shape": "Mapped from emitter.shape.type and shape parameters.",
+    "ParticleSystem.startPositionFunction": "Overridden when shape.emitMode is topDiskSuctionToTarget to sample a top disk.",
+    "ParticleSystem.startDirectionFunction": "Overridden when shape.emitMode is topDiskSuctionToTarget to aim particles toward the target center.",
+    "ParticleSystem.colorGradient": "emitter.alphaKeys applied to the final ParticleSystem.color1.",
+    "ParticleSystem.sizeGradient": "emitter.sizeKeys multiplied by emitter.maxSize.",
+    "ParticleSystem.updateFunction": "Wrapped when emitter.velocityOverLifetime exists to add Cocos local/world velocity-over-lifetime displacement.",
+  },
+};
+
+const BABYLON_PARTICLE_UPDATE_SPEED_UNIT = 0.01;
+
+function num(value, fallback = 0) {
+  const next = Number(value);
+  return Number.isFinite(next) ? next : fallback;
+}
+
+function readColor(BABYLON, value, fallback = new BABYLON.Color4(1, 1, 1, 1)) {
+  if (!value) return fallback;
+  return new BABYLON.Color4(num(value.r, fallback.r), num(value.g, fallback.g), num(value.b, fallback.b), num(value.a, fallback.a));
+}
+
+function applyRenderColorIntensity(BABYLON, color, renderColor = {}) {
+  const colorIntensity = Math.max(0, num(renderColor.colorIntensity, 1));
+  const alphaIntensity = Math.max(0, num(renderColor.alphaIntensity, colorIntensity));
+  return new BABYLON.Color4(
+    color.r * colorIntensity,
+    color.g * colorIntensity,
+    color.b * colorIntensity,
+    Math.min(1, color.a * alphaIntensity)
+  );
+}
+
+function particleColors(BABYLON, emitter) {
+  const renderColor = emitter.renderColor;
+  const baseColor = readColor(BABYLON, renderColor?.color, new BABYLON.Color4(1, 1, 1, 1));
+  const color1 = applyRenderColorIntensity(BABYLON, baseColor, renderColor);
+  return {
+    color1,
+    color2: color1,
+    colorDead: new BABYLON.Color4(color1.r, color1.g, color1.b, 0),
+  };
+}
+
+function readVec(BABYLON, value, fallback = new BABYLON.Vector3(0, 0, 0)) {
+  if (!value) return fallback;
+  return new BABYLON.Vector3(num(value.x, fallback.x), num(value.y, fallback.y), num(value.z, fallback.z));
+}
+
+function readScaleVec(BABYLON, value, fallback = new BABYLON.Vector3(1, 1, 1)) {
+  if (!value) return fallback;
+  return new BABYLON.Vector3(num(value.x, fallback.x), num(value.y, fallback.y), num(value.z, fallback.z));
+}
+
+function degreesToRadians(value) {
+  return num(value, 0) * Math.PI / 180;
+}
+
+function createEmitterTransform(BABYLON, scene, emitter, index) {
+  const transform = emitter.transform || emitter.cocosSource?.transform || {};
+  const node = new BABYLON.TransformNode(`particle-emitter-transform-${emitter.name || index}`, scene);
+  node.position = readVec(BABYLON, transform.position, BABYLON.Vector3.Zero());
+  node.rotation = new BABYLON.Vector3(
+    degreesToRadians(transform.rotation?.x),
+    degreesToRadians(transform.rotation?.y),
+    degreesToRadians(transform.rotation?.z)
+  );
+  node.scaling = readScaleVec(BABYLON, transform.scale, new BABYLON.Vector3(1, 1, 1));
+  return node;
+}
+
+function blendMode(BABYLON, value) {
+  if (value === "STANDARD") return BABYLON.ParticleSystem.BLENDMODE_STANDARD;
+  if (value === "MULTIPLY") return BABYLON.ParticleSystem.BLENDMODE_MULTIPLY;
+  if (value === "ONEONE") return BABYLON.ParticleSystem.BLENDMODE_ONEONE;
+  return BABYLON.ParticleSystem.BLENDMODE_ADD;
+}
+
+function billboardMode(BABYLON, value) {
+  if (!value || BABYLON.ParticleSystem[value] === undefined) return undefined;
+  return BABYLON.ParticleSystem[value];
+}
+
+function coneAxisBasis(BABYLON, axisDirection) {
+  const yAxis = readVec(BABYLON, axisDirection, new BABYLON.Vector3(0, 1, 0));
+  if (yAxis.lengthSquared() < 1e-6) yAxis.set(0, 1, 0);
+  yAxis.normalize();
+  const helper = Math.abs(BABYLON.Vector3.Dot(yAxis, new BABYLON.Vector3(0, 1, 0))) > 0.98
+    ? new BABYLON.Vector3(1, 0, 0)
+    : new BABYLON.Vector3(0, 1, 0);
+  const xAxis = BABYLON.Vector3.Cross(helper, yAxis).normalize();
+  const zAxis = BABYLON.Vector3.Cross(yAxis, xAxis).normalize();
+  return { xAxis, yAxis, zAxis };
+}
+
+function setFromConeBasis(basis, x, y, z, out) {
+  out.copyFrom(basis.xAxis).scaleInPlace(x);
+  out.addInPlace(basis.yAxis.scale(y));
+  out.addInPlace(basis.zAxis.scale(z));
+}
+
+function applyCocosConeEmitFunctions(BABYLON, system, radius, angle, radiusRange, axisDirection, length, emitFrom, directionScale = 1) {
+  const safeRadius = Math.max(0, radius);
+  const safeLength = Math.max(0.001, num(length, 1));
+  const halfAngle = Math.min(Math.PI, Math.max(0, angle));
+  const basis = coneAxisBasis(BABYLON, axisDirection);
+  const localPosition = new BABYLON.Vector3();
+  const localDirection = new BABYLON.Vector3();
+  const radialPoint = new BABYLON.Vector3();
+  const emitMode = Number(emitFrom);
+  const emitFromMode = Number.isFinite(emitMode) ? emitMode : 0;
+  const emitFromShell = emitFromMode === 2;
+  const emitFromVolume = emitFromMode === 3;
+  const speedDirectionScale = directionScale < 0 ? -1 : 1;
+  const innerRadius = safeRadius * Math.max(0, 1 - radiusRange);
+
+  function sampleRadialPoint(out, forceShell = false) {
+    const phi = Math.random() * Math.PI * 2;
+    const innerSq = forceShell ? safeRadius * safeRadius : innerRadius * innerRadius;
+    const outerSq = safeRadius * safeRadius;
+    const r = forceShell
+      ? safeRadius
+      : Math.sqrt(Math.max(0, innerSq + Math.random() * Math.max(0, outerSq - innerSq)));
+    setFromConeBasis(
+      basis,
+      r * Math.cos(phi),
+      0,
+      r * Math.sin(phi),
+      out
+    );
+  }
+
+  function directionFromRadialPoint(point, out) {
+    out.copyFrom(point).scaleInPlace(Math.sin(halfAngle) * speedDirectionScale);
+    out.addInPlace(basis.yAxis.scale(Math.cos(halfAngle) * Math.max(0.0001, safeRadius)));
+    if (out.lengthSquared() > 1e-6) out.normalize();
+    else out.copyFrom(basis.yAxis);
+  }
+
+  function sampleCocosConePositionAndDirection(positionOut, directionOut) {
+    sampleRadialPoint(radialPoint, emitFromShell);
+    directionFromRadialPoint(radialPoint, directionOut);
+    positionOut.copyFrom(radialPoint);
+    if (emitFromVolume) {
+      const axisComponent = Math.max(0.0001, BABYLON.Vector3.Dot(directionOut, basis.yAxis));
+      positionOut.addInPlace(directionOut.scale(speedDirectionScale * safeLength * Math.random() / axisComponent));
+    }
+  }
+
+  system.startPositionFunction = (worldMatrix, positionToUpdate, particle, isLocal) => {
+    sampleCocosConePositionAndDirection(localPosition, localDirection);
+    particle._cocosConeLocalDirection = particle._cocosConeLocalDirection || new BABYLON.Vector3();
+    particle._cocosConeLocalDirection.copyFrom(localDirection);
+    if (isLocal) positionToUpdate.copyFrom(localPosition);
+    else BABYLON.Vector3.TransformCoordinatesToRef(localPosition, worldMatrix, positionToUpdate);
+  };
+
+  system.startDirectionFunction = (worldMatrix, directionToUpdate, particle, isLocal) => {
+    if (particle._cocosConeLocalDirection) localDirection.copyFrom(particle._cocosConeLocalDirection);
+    else {
+      sampleRadialPoint(radialPoint, emitFromShell);
+      directionFromRadialPoint(radialPoint, localDirection);
+    }
+    if (isLocal) directionToUpdate.copyFrom(localDirection);
+    else BABYLON.Vector3.TransformNormalToRef(localDirection, worldMatrix, directionToUpdate);
+    if (directionToUpdate.lengthSquared() > 1e-6) directionToUpdate.normalize();
+  };
+}
+
+function applyTopDiskSuctionEmitFunctions(BABYLON, system, radius, radiusRange, axisDirection, length, transformScale, preserveWorldShapeSize = false) {
+  const safeRadius = Math.max(0, radius);
+  const safeLength = Math.max(0.001, num(length, 1));
+  const basis = coneAxisBasis(BABYLON, axisDirection);
+  const innerRadius = safeRadius * Math.max(0, 1 - radiusRange);
+  const localPosition = new BABYLON.Vector3();
+  const localDirection = new BABYLON.Vector3();
+  const scaledPosition = new BABYLON.Vector3();
+  const targetCenter = BABYLON.Vector3.Zero();
+  const safeScale = new BABYLON.Vector3(
+    Math.max(0.0001, Math.abs(num(transformScale?.x, 1))),
+    Math.max(0.0001, Math.abs(num(transformScale?.y, 1))),
+    Math.max(0.0001, Math.abs(num(transformScale?.z, 1)))
+  );
+  const inverseScale = new BABYLON.Vector3(
+    1 / safeScale.x,
+    1 / safeScale.y,
+    1 / safeScale.z
+  );
+
+  function sampleTopDiskPosition(out) {
+    const phi = Math.random() * Math.PI * 2;
+    const innerSq = innerRadius * innerRadius;
+    const outerSq = safeRadius * safeRadius;
+    const r = Math.sqrt(Math.max(0, innerSq + Math.random() * Math.max(0, outerSq - innerSq)));
+    setFromConeBasis(
+      basis,
+      r * Math.cos(phi),
+      -safeLength,
+      r * Math.sin(phi),
+      out
+    );
+    if (preserveWorldShapeSize) out.multiplyInPlace(inverseScale);
+  }
+
+  function directionToTargetCenter(position, out) {
+    if (preserveWorldShapeSize) {
+      scaledPosition.copyFrom(position).multiplyInPlace(safeScale);
+      targetCenter.subtractToRef(scaledPosition, out);
+    } else {
+      targetCenter.subtractToRef(position, out);
+    }
+    if (out.lengthSquared() > 1e-6) out.normalize();
+    else out.copyFrom(basis.yAxis);
+  }
+
+  system.startPositionFunction = (worldMatrix, positionToUpdate, particle, isLocal) => {
+    sampleTopDiskPosition(localPosition);
+    particle._cocosConeLocalDirection = particle._cocosConeLocalDirection || new BABYLON.Vector3();
+    directionToTargetCenter(localPosition, particle._cocosConeLocalDirection);
+    if (isLocal) positionToUpdate.copyFrom(localPosition);
+    else BABYLON.Vector3.TransformCoordinatesToRef(localPosition, worldMatrix, positionToUpdate);
+  };
+
+  system.startDirectionFunction = (worldMatrix, directionToUpdate, particle, isLocal) => {
+    if (particle._cocosConeLocalDirection) localDirection.copyFrom(particle._cocosConeLocalDirection);
+    else {
+      sampleTopDiskPosition(localPosition);
+      directionToTargetCenter(localPosition, localDirection);
+    }
+    if (isLocal) directionToUpdate.copyFrom(localDirection);
+    else BABYLON.Vector3.TransformNormalToRef(localDirection, worldMatrix, directionToUpdate);
+    if (directionToUpdate.lengthSquared() > 1e-6) directionToUpdate.normalize();
+  };
+}
+
+function applyEmitterShape(BABYLON, system, emitter) {
+  const shape = emitter.shape || {};
+  const type = shape.type;
+  const radius = num(shape.radius, 1);
+  const radiusRange = Math.min(1, Math.max(0, num(shape.radiusRange, 1)));
+  const angle = num(shape.angle, Math.PI / 4);
+  const length = num(shape.length, 1);
+  const topDiskSuction = emitter.topDiskSuction || {};
+  const topDiskRadius = num(topDiskSuction.topDiskRadius, radius);
+  const topDiskRadiusRange = Math.min(1, Math.max(0, num(topDiskSuction.topDiskRadiusRange, radiusRange)));
+  const suctionLength = num(topDiskSuction.suctionLength, length);
+  const direction1 = readVec(BABYLON, shape.direction1, new BABYLON.Vector3(0, 1, 0));
+  const direction2 = readVec(BABYLON, shape.direction2, new BABYLON.Vector3(0, 1, 0));
+  const boxMin = readVec(BABYLON, shape.minEmitBox, new BABYLON.Vector3(-radius * 0.5, -radius * 0.5, -radius * 0.5));
+  const boxMax = readVec(BABYLON, shape.maxEmitBox, new BABYLON.Vector3(radius * 0.5, radius * 0.5, radius * 0.5));
+
+  if (type === "Box") {
+    system.createBoxEmitter(direction1, direction2, boxMin, boxMax);
+  } else if (type === "SphereDirected") {
+    system.createDirectedSphereEmitter(radius, direction1, direction2);
+  } else if (type === "Sphere") {
+    system.createSphereEmitter(radius, radiusRange);
+  } else if (type === "Hemisphere") {
+    system.createHemisphericEmitter(radius, radiusRange);
+  } else if (type === "Cone") {
+    const dirSpread = direction1.subtract(direction2).lengthSquared();
+    if (dirSpread < 1e-4) {
+      system.createConeEmitter(Math.max(0.001, radius), angle);
+      if (shape.emitMode === "topDiskSuctionToTarget") {
+        applyTopDiskSuctionEmitFunctions(BABYLON, system, topDiskRadius, topDiskRadiusRange, direction1, suctionLength, emitter.transform?.scale, shape.preserveWorldShapeSize === true);
+      } else {
+        applyCocosConeEmitFunctions(BABYLON, system, radius, angle, radiusRange, direction1, length, shape.emitFrom, shape.directionScale);
+      }
+    } else {
+      system.createDirectedConeEmitter(Math.max(0.001, radius), angle, direction1, direction2);
+    }
+  }
+}
+
+function addGradients(BABYLON, system, emitter, color1) {
+  for (const key of emitter.alphaKeys || []) {
+    const time = Math.min(1, Math.max(0, num(key.time, 0)));
+    const alpha = Math.min(1, Math.max(0, num(key.alpha, 1)));
+    system.addColorGradient?.(time, new BABYLON.Color4(color1.r, color1.g, color1.b, Math.min(1, color1.a * alpha)));
+  }
+  for (const key of emitter.sizeKeys || []) {
+    const time = Math.min(1, Math.max(0, num(key.time, 0)));
+    const size = Math.max(0.001, num(key.size, 1) * num(emitter.maxSize, 1));
+    system.addSizeGradient?.(time, size);
+  }
+}
+
+function sampleValueKeys(keys, time, fallback = 0) {
+  if (!Array.isArray(keys) || keys.length === 0) return fallback;
+  const sorted = [...keys].sort((a, b) => num(a.time, 0) - num(b.time, 0));
+  if (time <= num(sorted[0].time, 0)) return num(sorted[0].value, fallback);
+  for (let index = 1; index < sorted.length; index += 1) {
+    const prev = sorted[index - 1];
+    const next = sorted[index];
+    const prevTime = num(prev.time, 0);
+    const nextTime = num(next.time, 1);
+    if (time <= nextTime) {
+      const span = Math.max(0.0001, nextTime - prevTime);
+      const ratio = (time - prevTime) / span;
+      return num(prev.value, fallback) + (num(next.value, fallback) - num(prev.value, fallback)) * ratio;
+    }
+  }
+  return num(sorted[sorted.length - 1].value, fallback);
+}
+
+function rangeAverage(range, fallback = 1) {
+  if (!range) return fallback;
+  return (num(range.min, fallback) + num(range.max, fallback)) * 0.5;
+}
+
+function applyVelocityOverLifetime(BABYLON, system, emitterTransform, emitter) {
+  const config = emitter.velocityOverLifetime;
+  if (!config?.axes || typeof system.updateFunction !== "function") return;
+  const baseUpdate = system.updateFunction.bind(system);
+  const localVelocity = new BABYLON.Vector3();
+  const worldVelocity = new BABYLON.Vector3();
+  const speedModifier = rangeAverage(config.speedModifier, 1);
+  const isLocalSpace = config.space === 0 || config.space === "local";
+
+  system.updateFunction = (particles) => {
+    baseUpdate(particles);
+    const worldMatrix = emitterTransform.getWorldMatrix();
+    for (const particle of particles) {
+      const lifeRatio = particle.lifeTime > 0 ? Math.min(1, Math.max(0, particle.age / particle.lifeTime)) : 0;
+      localVelocity.set(
+        sampleValueKeys(config.axes.x, lifeRatio, 0),
+        sampleValueKeys(config.axes.y, lifeRatio, 0),
+        sampleValueKeys(config.axes.z, lifeRatio, 0)
+      );
+      localVelocity.scaleInPlace(speedModifier * system.updateSpeed);
+      if (isLocalSpace) BABYLON.Vector3.TransformNormalToRef(localVelocity, worldMatrix, worldVelocity);
+      else worldVelocity.copyFrom(localVelocity);
+      particle.position.addInPlace(worldVelocity);
+    }
+  };
+}
+
+function playbackSpeed(emitter) {
+  return Math.max(0.001, num(emitter.updateSpeed, BABYLON_PARTICLE_UPDATE_SPEED_UNIT) / BABYLON_PARTICLE_UPDATE_SPEED_UNIT);
+}
+
+function runtimeDuration(emitter) {
+  return Math.max(0.1, num(emitter.runtime?.stopAfterSeconds, 3) / playbackSpeed(emitter));
+}
+
+export async function createParticleEmitterRuntime({ BABYLON, scene, emitter, index = 0, urlForPackagePath, shouldStart = false }) {
+  if (!BABYLON) throw new Error("createParticleEmitterRuntime requires BABYLON.");
+  if (!scene) throw new Error("createParticleEmitterRuntime requires scene.");
+  if (!emitter) throw new Error("createParticleEmitterRuntime requires emitter.");
+
+  const capacity = Math.max(1, Math.round(num(emitter.capacity, 100)));
+  const system = new BABYLON.ParticleSystem(`particle-emitter-${emitter.name || index}`, capacity, scene);
+  const textureUrl = urlForPackagePath ? urlForPackagePath(emitter.particleTexturePath) : emitter.particleTexturePath;
+  system.particleTexture = new BABYLON.Texture(textureUrl, scene);
+  system.particleTexture.hasAlpha = true;
+  const emitterTransform = createEmitterTransform(BABYLON, scene, emitter, index);
+  system.emitter = emitterTransform;
+  system.blendMode = blendMode(BABYLON, emitter.blendMode);
+  system.isLocal = emitter.isLocal === true;
+  system.minSize = Math.max(0.001, num(emitter.minSize, 1));
+  system.maxSize = Math.max(system.minSize, num(emitter.maxSize, system.minSize));
+  system.minScaleX = Math.max(0.001, num(emitter.minScaleX, 1));
+  system.maxScaleX = Math.max(system.minScaleX, num(emitter.maxScaleX, system.minScaleX));
+  system.minScaleY = Math.max(0.001, num(emitter.minScaleY, 1));
+  system.maxScaleY = Math.max(system.minScaleY, num(emitter.maxScaleY, system.minScaleY));
+  system.minLifeTime = Math.max(0.02, num(emitter.minLifeTime, 0.55));
+  system.maxLifeTime = Math.max(system.minLifeTime, num(emitter.maxLifeTime, system.minLifeTime));
+  system.minEmitPower = Math.max(0, num(emitter.minEmitPower, 1));
+  system.maxEmitPower = Math.max(system.minEmitPower, num(emitter.maxEmitPower, system.minEmitPower));
+  system.updateSpeed = Math.max(0.00001, num(emitter.updateSpeed, BABYLON_PARTICLE_UPDATE_SPEED_UNIT));
+  system.gravity = readVec(BABYLON, emitter.gravity, new BABYLON.Vector3(0, -6, 0));
+  system.emitRate = Math.max(0, num(emitter.emitRate, 0));
+  if (system.emitRate <= 0) system.manualEmitCount = Math.max(0, Math.round(num(emitter.manualEmitCount, 0)));
+
+  const colors = particleColors(BABYLON, emitter);
+  system.color1 = colors.color1;
+  system.color2 = colors.color2;
+  system.colorDead = colors.colorDead;
+  system.minInitialRotation = num(emitter.minInitialRotation, 0);
+  system.maxInitialRotation = num(emitter.maxInitialRotation, system.minInitialRotation);
+  system.minAngularSpeed = num(emitter.minAngularSpeed, 0);
+  system.maxAngularSpeed = num(emitter.maxAngularSpeed, system.minAngularSpeed);
+
+  const nextBillboardMode = billboardMode(BABYLON, emitter.billboardMode);
+  if (nextBillboardMode !== undefined) system.billboardMode = nextBillboardMode;
+
+  applyEmitterShape(BABYLON, system, emitter);
+  addGradients(BABYLON, system, emitter, system.color1);
+  applyVelocityOverLifetime(BABYLON, system, emitterTransform, emitter);
+
+  const preview = {
+    start: () => system.start(),
+    stop: () => system.stop(),
+    dispose: () => {
+      system.dispose();
+      emitterTransform.dispose();
+    },
+    isStarted: () => system.isStarted(),
+    duration: runtimeDuration(emitter),
+    system,
+  };
+  if (shouldStart) preview.start();
+  return preview;
+}