feat: add support of direct descandants only when retrieving particle system using @particleSystemFromScene in babylonjs-editor-tools

Author: julien-moreau

tools/src/decorators/apply.ts

@@ -3,6 +3,8 @@ import { Scene } from "@babylonjs/core/scene";
 import { Color3, Color4 } from "@babylonjs/core/Maths/math.color";
 import { Texture } from "@babylonjs/core/Materials/Textures/texture";
 import { Vector2, Vector3 } from "@babylonjs/core/Maths/math.vector";
+import { ParticleSystem } from "@babylonjs/core/Particles/particleSystem";
+import { GPUParticleSystem } from "@babylonjs/core/Particles/gpuParticleSystem";
 
 import { AdvancedDynamicTexture } from "@babylonjs/gui/2D/advancedDynamicTexture";
 
@@ -48,6 +50,7 @@ export interface ISceneDecoratorData {
 	// @fromParticleSystems
 	_ParticleSystemsFromScene: {
 		particleSystemName: string;
+		directDescendantsOnly: boolean;
 		propertyKey: string | Symbol;
 	}[];
 
@@ -108,8 +111,12 @@ export function applyDecorators(scene: Scene, object: any, script: any, instance
 
 	// @fromParticleSystems
 	ctor._ParticleSystemsFromScene?.forEach((params) => {
-		const particleSystem = scene.particleSystems?.find((particleSystem) => {
-			return particleSystem.name === params.particleSystemName;
+		const particleSystem = scene.particleSystems?.find((particleSystem: ParticleSystem | GPUParticleSystem) => {
+			if (particleSystem.name !== params.particleSystemName) {
+				return false;
+			}
+
+			return params.directDescendantsOnly ? particleSystem.emitter === object : particleSystem;
 		});
 
 		instance[params.propertyKey.toString()] = particleSystem;

tools/src/decorators/particle-systems.ts

@@ -6,12 +6,13 @@ import { ISceneDecoratorData } from "./apply";
  * from the scene and assigned to the property. Node link cant' be used in constructor.
  * This can be used only by scripts using Classes.
  * @param particleSystemName defines the name of the sound to retrieve in scene.
+ * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also global particle systems will be considered.
  */
-export function particleSystemFromScene(particleSystemName: string) {
+export function particleSystemFromScene(particleSystemName: string, directDescendantsOnly: boolean = false) {
 	return function (target: any, propertyKey: string | Symbol) {
 		const ctor = target.constructor as ISceneDecoratorData;
 
 		ctor._ParticleSystemsFromScene ??= [];
-		ctor._ParticleSystemsFromScene.push({ propertyKey, particleSystemName });
+		ctor._ParticleSystemsFromScene.push({ propertyKey, particleSystemName, directDescendantsOnly });
 	};
 }