Handle a property mapping between the parent and the child for editor rendering.

D8H · D8H · commit 99287ddf54c7 · 2025-03-10T16:53:21.000+01:00
diff --git a/Extensions/BBText/JsExtension.js b/Extensions/BBText/JsExtension.js
@@ -485,14 +485,16 @@ module.exports = {
         instance,
         associatedObjectConfiguration,
         pixiContainer,
-        pixiResourcesLoader
+        pixiResourcesLoader,
+        propertyOverridings
       ) {
         super(
           project,
           instance,
           associatedObjectConfiguration,
           pixiContainer,
-          pixiResourcesLoader
+          pixiResourcesLoader,
+          propertyOverridings
         );
 
         const bbTextStyles = {
@@ -532,7 +534,9 @@ module.exports = {
           gd.ObjectJsImplementation
         );
 
-        const rawText = object.content.text;
+        const rawText = this._propertyOverridings.has('Text')
+          ? this._propertyOverridings.get('Text')
+          : object.content.text;
         if (rawText !== this._pixiObject.text) {
           this._pixiObject.text = rawText;
         }
diff --git a/Extensions/BitmapText/JsExtension.js b/Extensions/BitmapText/JsExtension.js
@@ -624,14 +624,16 @@ module.exports = {
         instance,
         associatedObjectConfiguration,
         pixiContainer,
-        pixiResourcesLoader
+        pixiResourcesLoader,
+        propertyOverridings
       ) {
         super(
           project,
           instance,
           associatedObjectConfiguration,
           pixiContainer,
-          pixiResourcesLoader
+          pixiResourcesLoader,
+          propertyOverridings
         );
 
         // We'll track changes of the font to trigger the loading of the new font.
@@ -657,8 +659,9 @@ module.exports = {
 
         // Update the rendered text properties (note: Pixi is only
         // applying changes if there were changed).
-        const rawText = object.content.text;
-        this._pixiObject.text = rawText;
+        this._pixiObject.text = this._propertyOverridings.has('Text')
+          ? this._propertyOverridings.get('Text')
+          : object.content.text;
 
         const align = object.content.align;
         this._pixiObject.align = align;
diff --git a/Extensions/JsExtensionTypes.d.ts b/Extensions/JsExtensionTypes.d.ts
@@ -15,6 +15,7 @@ class RenderedInstance {
   _pixiContainer: PIXI.Container;
   _pixiResourcesLoader: Class<PixiResourcesLoader>;
   _pixiObject: PIXI.DisplayObject | null;
+  _propertyOverridings: Map<string, string>;
   wasUsed: boolean;
 
   /** Set to true when onRemovedFromScene is called. Allows to cancel promises/asynchronous operations (notably: waiting for a resource load). */
@@ -25,7 +26,8 @@ class RenderedInstance {
     instance: gdInitialInstance,
     associatedObjectConfiguration: gdObjectConfiguration,
     pixiContainer: PIXI.Container,
-    pixiResourcesLoader: Class<PixiResourcesLoader>
+    pixiResourcesLoader: Class<PixiResourcesLoader>,
+    propertyOverridings: Map<string, string> = new Map<string, string>()
   );
 
   /**
diff --git a/newIDE/app/src/ObjectsRendering/ObjectsRenderingService.js b/newIDE/app/src/ObjectsRendering/ObjectsRenderingService.js
@@ -83,7 +83,8 @@ const ObjectsRenderingService = {
     instance: gdInitialInstance,
     associatedObjectConfiguration: gdObjectConfiguration,
     pixiContainer: PIXI.Container,
-    threeGroup: THREE.Group | null
+    threeGroup: THREE.Group | null,
+    propertyOverridings: Map<string, string> = new Map<string, string>()
   ): RenderedInstance | Rendered3DInstance {
     const objectType = associatedObjectConfiguration.getType();
     if (threeGroup && this.renderers3D.hasOwnProperty(objectType)) {
@@ -101,7 +102,8 @@ const ObjectsRenderingService = {
         instance,
         associatedObjectConfiguration,
         pixiContainer,
-        PixiResourcesLoader
+        PixiResourcesLoader,
+        propertyOverridings
       );
     else {
       if (project.hasEventsBasedObject(objectType)) {
@@ -135,7 +137,8 @@ const ObjectsRenderingService = {
             associatedObjectConfiguration,
             pixiContainer,
             threeGroup,
-            PixiResourcesLoader
+            PixiResourcesLoader,
+            propertyOverridings
           );
         }
       }
diff --git a/newIDE/app/src/ObjectsRendering/Renderers/Rendered3DInstance.js b/newIDE/app/src/ObjectsRendering/Renderers/Rendered3DInstance.js
@@ -19,14 +19,16 @@ export default class Rendered3DInstance {
   _threeObject: THREE.Object3D | null;
   wasUsed: boolean;
   _wasDestroyed: boolean;
+  _propertyOverridings: Map<string, string>;
 
   constructor(
     project: gdProject,
     instance: gdInitialInstance,
     associatedObjectConfiguration: gdObjectConfiguration,
     pixiContainer: PIXI.Container,
     threeGroup: THREE.Group,
-    pixiResourcesLoader: Class<PixiResourcesLoader>
+    pixiResourcesLoader: Class<PixiResourcesLoader>,
+    propertyOverridings: Map<string, string> = new Map<string, string>()
   ) {
     this._pixiObject = null;
     this._threeObject = null;
@@ -36,6 +38,7 @@ export default class Rendered3DInstance {
     this._threeGroup = threeGroup;
     this._project = project;
     this._pixiResourcesLoader = pixiResourcesLoader;
+    this._propertyOverridings = propertyOverridings;
     this.wasUsed = true; //Used by InstancesRenderer to track rendered instance that are not used anymore.
     this._wasDestroyed = false;
   }
diff --git a/newIDE/app/src/ObjectsRendering/Renderers/RenderedCustomObjectInstance.js b/newIDE/app/src/ObjectsRendering/Renderers/RenderedCustomObjectInstance.js
@@ -26,6 +26,42 @@ const getVariant = (
     : eventBasedObject.getDefaultVariant();
 };
 
+type PropertyMappingRule = {
+  targetChild: string,
+  targetProperty: string,
+  sourceProperty: string,
+};
+
+const getPropertyMappingRules = (
+  eventBasedObject: gdEventsBasedObject
+): Array<PropertyMappingRule> => {
+  const properties = eventBasedObject.getPropertyDescriptors();
+  if (!properties.has('_PropertyMapping')) {
+    return [];
+  }
+  const extraInfos = properties
+    .get('_PropertyMapping')
+    .getExtraInfo()
+    .toJSArray();
+  return extraInfos
+    .map(extraInfo => {
+      const mapping = extraInfo.split('=');
+      if (mapping.length < 2) {
+        return null;
+      }
+      const targetPath = mapping[0].split('.');
+      if (mapping.length < 2) {
+        return null;
+      }
+      return {
+        targetChild: targetPath[0],
+        targetProperty: targetPath[1],
+        sourceProperty: mapping[1],
+      };
+    })
+    .filter(Boolean);
+};
+
 /**
  * Renderer for gd.CustomObject (the class is not exposed to newIDE)
  */
@@ -39,22 +75,25 @@ export default class RenderedCustomObjectInstance extends Rendered3DInstance
 
   layoutedInstances = new Map<number, LayoutedInstance>();
   renderedInstances = new Map<number, RenderedInstance | Rendered3DInstance>();
+  _propertyMappingRules: Array<PropertyMappingRule>;
 
   constructor(
     project: gdProject,
     instance: gdInitialInstance,
     associatedObjectConfiguration: gdObjectConfiguration,
     pixiContainer: PIXI.Container,
     threeGroup: THREE.Group,
-    pixiResourcesLoader: Class<PixiResourcesLoader>
+    pixiResourcesLoader: Class<PixiResourcesLoader>,
+    propertyOverridings: Map<string, string>
   ) {
     super(
       project,
       instance,
       associatedObjectConfiguration,
       pixiContainer,
       threeGroup,
-      pixiResourcesLoader
+      pixiResourcesLoader,
+      propertyOverridings
     );
 
     // Setup the PIXI object:
@@ -83,6 +122,7 @@ export default class RenderedCustomObjectInstance extends Rendered3DInstance
     if (!eventBasedObject) {
       return;
     }
+    this._propertyMappingRules = getPropertyMappingRules(eventBasedObject);
     this._isRenderedIn3D = eventBasedObject.isRenderedIn3D();
 
     // Functor used to render an instance
@@ -160,9 +200,32 @@ export default class RenderedCustomObjectInstance extends Rendered3DInstance
       if (variant) {
         const childObjects = variant.getObjects();
         if (childObjects.hasObjectNamed(instance.getObjectName())) {
-          childObjectConfiguration = childObjects
-            .getObject(instance.getObjectName())
-            .getConfiguration();
+          const childObject = childObjects.getObject(instance.getObjectName());
+          childObjectConfiguration = childObject.getConfiguration();
+        }
+      }
+      // Apply property mapping rules on the child instance.
+      const childPropertyOverridings = new Map<string, string>();
+      const customObjectConfiguration = gd.asCustomObjectConfiguration(
+        this._associatedObjectConfiguration
+      );
+      for (const propertyMappingRule of this._propertyMappingRules) {
+        if (propertyMappingRule.targetChild !== instance.getObjectName()) {
+          continue;
+        }
+        const sourceValue = this._propertyOverridings.has(
+          propertyMappingRule.sourceProperty
+        )
+          ? this._propertyOverridings.get(propertyMappingRule.sourceProperty)
+          : customObjectConfiguration
+              .getProperties()
+              .get(propertyMappingRule.sourceProperty)
+              .getValue();
+        if (sourceValue !== undefined) {
+          childPropertyOverridings.set(
+            propertyMappingRule.targetProperty,
+            sourceValue
+          );
         }
       }
       //...so let's create a renderer.
@@ -172,7 +235,8 @@ export default class RenderedCustomObjectInstance extends Rendered3DInstance
             instance,
             childObjectConfiguration,
             this._pixiObject,
-            this._threeObject
+            this._threeObject,
+            childPropertyOverridings
           )
         : new RenderedUnknownInstance(
             this._project,
diff --git a/newIDE/app/src/ObjectsRendering/Renderers/RenderedInstance.js b/newIDE/app/src/ObjectsRendering/Renderers/RenderedInstance.js
@@ -15,20 +15,23 @@ export default class RenderedInstance {
   _pixiObject: PIXI.DisplayObject;
   wasUsed: boolean;
   _wasDestroyed: boolean;
+  _propertyOverridings: Map<string, string>;
 
   constructor(
     project: gdProject,
     instance: gdInitialInstance,
     associatedObjectConfiguration: gdObjectConfiguration,
     pixiContainer: PIXI.Container,
-    pixiResourcesLoader: Class<PixiResourcesLoader>
+    pixiResourcesLoader: Class<PixiResourcesLoader>,
+    propertyOverridings: Map<string, string> = new Map<string, string>()
   ) {
     this._pixiObject = null;
     this._instance = instance;
     this._associatedObjectConfiguration = associatedObjectConfiguration;
     this._pixiContainer = pixiContainer;
     this._project = project;
     this._pixiResourcesLoader = pixiResourcesLoader;
+    this._propertyOverridings = propertyOverridings;
     this.wasUsed = true; //Used by InstancesRenderer to track rendered instance that are not used anymore.
     this._wasDestroyed = false;
   }
diff --git a/newIDE/app/src/ObjectsRendering/Renderers/RenderedTextInstance.js b/newIDE/app/src/ObjectsRendering/Renderers/RenderedTextInstance.js
@@ -38,14 +38,16 @@ export default class RenderedTextInstance extends RenderedInstance {
     instance: gdInitialInstance,
     associatedObjectConfiguration: gdObjectConfiguration,
     pixiContainer: PIXI.Container,
-    pixiResourcesLoader: Class<PixiResourcesLoader>
+    pixiResourcesLoader: Class<PixiResourcesLoader>,
+    propertyOverridings: Map<string, string>
   ) {
     super(
       project,
       instance,
       associatedObjectConfiguration,
       pixiContainer,
-      pixiResourcesLoader
+      pixiResourcesLoader,
+      propertyOverridings
     );
 
     const style = new PIXI.TextStyle({
@@ -84,7 +86,9 @@ export default class RenderedTextInstance extends RenderedInstance {
     const textObjectConfiguration = gd.asTextObjectConfiguration(
       this._associatedObjectConfiguration
     );
-    this._pixiObject.text = textObjectConfiguration.getText();
+    this._pixiObject.text = this._propertyOverridings.has('Text')
+      ? this._propertyOverridings.get('Text')
+      : textObjectConfiguration.getText();
 
     //Update style, only if needed to avoid destroying text rendering performances
     if (
