transformRootInstance/filterRootInstance docs, see #366

phetsims · Jul 24, 2024 · 9805a61 · 9805a61
1 parent c4c3183
commit 9805a61
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 14 deletions.
diff --git a/js/display/BackboneDrawable.js b/js/display/BackboneDrawable.js
@@ -21,7 +21,9 @@ class BackboneDrawable extends Drawable {
    *
    * @param {Display} display
    * @param {Instance} backboneInstance
-   * @param {Instance} transformRootInstance
+   * @param {Instance} transformRootInstance - All transforms of this instance and its ancestors will already have been
+   *                                           applied. This block will only be responsible for applying transforms of
+   *                                           this instance's descendants.
    * @param {number} renderer
    * @param {boolean} isDisplayRoot
    */

diff --git a/js/display/CanvasBlock.js b/js/display/CanvasBlock.js
@@ -21,8 +21,12 @@ class CanvasBlock extends FittedBlock {
    *
    * @param {Display} display
    * @param {number} renderer - See Renderer.js for more information
-   * @param {Instance} transformRootInstance
-   * @param {Instance} filterRootInstance
+   * @param {Instance} transformRootInstance - All transforms of this instance and its ancestors will already have been
+   *                                           applied. This block will only be responsible for applying transforms of
+   *                                           this instance's descendants.
+   * @param {Instance} filterRootInstance - All filters (visibility/opacity/filters) of this instance and its ancestors
+   *                                        will already have been applied. This block will only be responsible for
+   *                                        applying filters of this instance's descendants.
    */
   constructor( display, renderer, transformRootInstance, filterRootInstance ) {
     super();
@@ -35,8 +39,12 @@ class CanvasBlock extends FittedBlock {
    *
    * @param {Display} display
    * @param {number} renderer
-   * @param {Instance} transformRootInstance
-   * @param {Instance} filterRootInstance
+   * @param {Instance} transformRootInstance - All transforms of this instance and its ancestors will already have been
+   *                                           applied. This block will only be responsible for applying transforms of
+   *                                           this instance's descendants.
+   * @param {Instance} filterRootInstance - All filters (visibility/opacity/filters) of this instance and its ancestors
+   *                                        will already have been applied. This block will only be responsible for
+   *                                        applying filters of this instance's descendants.
    */
   initialize( display, renderer, transformRootInstance, filterRootInstance ) {
     super.initialize( display, renderer, transformRootInstance, FittedBlock.COMMON_ANCESTOR );

diff --git a/js/display/FittedBlock.js b/js/display/FittedBlock.js
@@ -19,7 +19,9 @@ class FittedBlock extends Block {
    *
    * @param {Display} display
    * @param {number} renderer
-   * @param {Instance} transformRootInstance
+   * @param {Instance} transformRootInstance - All transforms of this instance and its ancestors will already have been
+   *                                           applied. This block will only be responsible for applying transforms of
+   *                                           this instance's descendants.
    * @param {FittedBlock.Fit} preferredFit
    * @returns {FittedBlock} - For chaining
    */

diff --git a/js/display/SVGBlock.js b/js/display/SVGBlock.js
@@ -17,8 +17,12 @@ class SVGBlock extends FittedBlock {
    *
    * @param {Display} display - the scenery Display this SVGBlock will appear in
    * @param {number} renderer - the bitmask for the renderer, see Renderer.js
-   * @param {Instance} transformRootInstance - TODO: Documentation https://github.com/phetsims/scenery/issues/1581
-   * @param {Instance} filterRootInstance - TODO: Documentation
+   * @param {Instance} transformRootInstance - All transforms of this instance and its ancestors will already have been
+   *                                           applied. This block will only be responsible for applying transforms of
+   *                                           this instance's descendants.
+   * @param {Instance} filterRootInstance - All filters (visibility/opacity/filters) of this instance and its ancestors
+   *                                        will already have been applied. This block will only be responsible for
+   *                                        applying filters of this instance's descendants.
    */
   constructor( display, renderer, transformRootInstance, filterRootInstance ) {
     super();
@@ -31,8 +35,12 @@ class SVGBlock extends FittedBlock {
    *
    * @param {Display} display - the scenery Display this SVGBlock will appear in
    * @param {number} renderer - the bitmask for the renderer, see Renderer.js
-   * @param {Instance} transformRootInstance - TODO: Documentation https://github.com/phetsims/scenery/issues/1581
-   * @param {Instance} filterRootInstance - TODO: Documentation
+   * @param {Instance} transformRootInstance - All transforms of this instance and its ancestors will already have been
+   *                                           applied. This block will only be responsible for applying transforms of
+   *                                           this instance's descendants.
+   * @param {Instance} filterRootInstance - All filters (visibility/opacity/filters) of this instance and its ancestors
+   *                                        will already have been applied. This block will only be responsible for
+   *                                        applying filters of this instance's descendants.
    * @returns {FittedBlock}
    */
   initialize( display, renderer, transformRootInstance, filterRootInstance ) {

diff --git a/js/display/WebGLBlock.js b/js/display/WebGLBlock.js
@@ -20,8 +20,12 @@ class WebGLBlock extends FittedBlock {
    *
    * @param {Display} display
    * @param {number} renderer
-   * @param {Instance} transformRootInstance
-   * @param {Instance} filterRootInstance
+   * @param {Instance} transformRootInstance - All transforms of this instance and its ancestors will already have been
+   *                                           applied. This block will only be responsible for applying transforms of
+   *                                           this instance's descendants.
+   * @param {Instance} filterRootInstance - All filters (visibility/opacity/filters) of this instance and its ancestors
+   *                                        will already have been applied. This block will only be responsible for
+   *                                        applying filters of this instance's descendants.
    */
   constructor( display, renderer, transformRootInstance, filterRootInstance ) {
     super();
@@ -34,8 +38,12 @@ class WebGLBlock extends FittedBlock {
    *
    * @param {Display} display
    * @param {number} renderer
-   * @param {Instance} transformRootInstance
-   * @param {Instance} filterRootInstance
+   * @param {Instance} transformRootInstance - All transforms of this instance and its ancestors will already have been
+   *                                           applied. This block will only be responsible for applying transforms of
+   *                                           this instance's descendants.
+   * @param {Instance} filterRootInstance - All filters (visibility/opacity/filters) of this instance and its ancestors
+   *                                        will already have been applied. This block will only be responsible for
+   *                                        applying filters of this instance's descendants.
    * @returns {WebGLBlock} - For chaining
    */
   initialize( display, renderer, transformRootInstance, filterRootInstance ) {