feat(troika-core): add requestRender method as nicer shortcut

protectwise · Feb 14, 2021 · c79254c · c79254c
1 parent d995a4d
commit c79254c
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 12 deletions.
diff --git a/packages/troika-3d-text/src/facade/Text3DFacade.js b/packages/troika-3d-text/src/facade/Text3DFacade.js
@@ -71,7 +71,7 @@ class Text3DFacade extends Object3DFacade {
         mesh.geometry.boundingSphere.version++
         this.afterUpdate()
         this.notifyWorld('text3DSyncComplete')
-        this.notifyWorld('needsRender')
+        this.requestRender()
         if (this.onSyncComplete) {
           this.onSyncComplete()
         }
@@ -112,7 +112,7 @@ class Text3DFacade extends Object3DFacade {
           this.selectionStart = start
           this.selectionEnd = end
           this._updateSelection()
-          this.notifyWorld('needsRender')
+          this.requestRender()
         })
       } else {
         if (selFacade) {

diff --git a/packages/troika-3d-ui/src/facade/UIBlock3DFacade.js b/packages/troika-3d-ui/src/facade/UIBlock3DFacade.js
@@ -417,7 +417,7 @@ function wheelHandler(e) {
       facade.scrollLeft = scrollLeft
       facade.scrollTop = scrollTop
       facade.afterUpdate()
-      facade.notifyWorld('needsRender')
+      facade.requestRender()
       e._didScroll = true
     }
     e.preventDefault()
@@ -446,7 +446,7 @@ function dragHandler(e) {
           facade.scrollLeft = scrollLeft
           facade.scrollTop = scrollTop
           facade.afterUpdate()
-          facade.notifyWorld('needsRender')
+          facade.requestRender()
           e._didScroll = true
         }
       }

diff --git a/packages/troika-3d-ui/src/facade/UIImage3DFacade.js b/packages/troika-3d-ui/src/facade/UIImage3DFacade.js
@@ -38,7 +38,7 @@ class UIImage3DFacade extends Object3DFacade {
         material.map = texture
         this.aspectRatio = texture.image.width / texture.image.height
         this.afterUpdate()
-        this.notifyWorld('needsRender')
+        this.requestRender()
       })
       this._lastSrc = src
     }

diff --git a/packages/troika-3d-ui/src/flex-layout/FlexNode.js b/packages/troika-3d-ui/src/flex-layout/FlexNode.js
@@ -177,7 +177,7 @@ export const extendAsFlexNode = createClassExtender('flexNode', BaseFacadeClass
           // Final afterUpdate on the whole subtree
           this._hasActiveFlexRequest = false
           this.afterUpdate()
-          this.notifyWorld('needsRender')
+          this.requestRender()
         }
       })
     }

diff --git a/packages/troika-3d/src/facade/WorldTextureProvider.js b/packages/troika-3d/src/facade/WorldTextureProvider.js
@@ -86,7 +86,7 @@ export function makeWorldTextureProvider(WrappedFacadeClass) {
           // Trigger texture update whenever the inner world is rerendered
           innerWorld.onAfterRender = () => {
             this.worldTexture.needsUpdate = true
-            this.notifyWorld('needsRender')
+            this.requestRender()
           }
         }
       }

diff --git a/packages/troika-core/src/facade/Animatable.js b/packages/troika-core/src/facade/Animatable.js
@@ -24,7 +24,7 @@ export const extendAsAnimatable = createClassExtender('animatable', function(Bas
       this.animation$runner = new Runner()
       this.animation$runner.onTick = () => {
         this.afterUpdate()
-        this.notifyWorld('needsRender')
+        this.requestRender()
       }
     }
 
@@ -297,7 +297,7 @@ export const extendAsAnimatable = createClassExtender('animatable', function(Bas
           }
         }
         runner.onDone = () => {
-          this.notifyWorld('needsRender')
+          this.requestRender()
           this.destructor()
         }
       } else {

diff --git a/packages/troika-core/src/facade/Facade.js b/packages/troika-core/src/facade/Facade.js
@@ -76,7 +76,7 @@ export default class Facade {
     if (props && typeof props === 'object') {
       assign(this, props)
       this.afterUpdate()
-      this.notifyWorld('needsRender')
+      this.requestRender()
     }
   }
 
@@ -132,6 +132,14 @@ export default class Facade {
     }
   }
 
+  /**
+   * Notifies the top-level world manager that this object has changed in some way that affects its
+   * visible rendering, so a rendering frame will be scheduled.
+   */
+  requestRender() {
+    this.notifyWorld('needsRender')
+  }
+
   traverse(fn) {
     fn(this)
   }

diff --git a/packages/troika-core/src/facade/PointerStates.js b/packages/troika-core/src/facade/PointerStates.js
@@ -158,7 +158,7 @@ export const extendAsPointerStatesAware = createClassExtender('pointerStates', f
       parent = parent.parent
     }
     highestFacade.afterUpdate()
-    highestFacade.notifyWorld('needsRender')
+    highestFacade.requestRender()
   }
 
   return PointerStatesAware

diff --git a/packages/troika-xr/src/facade/teleport/TeleportControls.js b/packages/troika-xr/src/facade/teleport/TeleportControls.js
@@ -53,7 +53,7 @@ export class TeleportControls extends Object3DFacade {
           this.targeting = true
           markerConfig.x = tempVec3.x
           markerConfig.z = tempVec3.z
-          this.notifyWorld('needsRender')
+          this.requestRender()
           // For rotation, start with the current direction of the camera. Then rotate
           // relative to that by the last controller stick/axis position.
           tempQuat.setFromRotationMatrix(this.getCameraFacade().threeObject.matrixWorld)