Skip to content

MatrixBetweenProperty

Under Construction

This documentation is auto-generated, and is a work in progress. Please see the source code at https://github.com/phetsims/scenery/blob/main/js/util/MatrixBetweenProperty.ts for the most up-to-date information.

Overview

A Property that, if there is a unique path from one Node to another (A => root => B, or A => B, or B => A), will contain the transformation matrix from A to B's coordinate frame (local coordinate frames by default).

If there is no unique path, the value will be null.

@author Jonathan Olson <jonathan.olson@colorado.edu>

Class MatrixBetweenProperty

import { MatrixBetweenProperty } from 'scenerystack/scenery';

Constructor

new MatrixBetweenProperty( from : Node, to : Node, providedOptions? : MatrixBetweenPropertyOptions )

Instance Methods

dispose()

Type MatrixBetweenPropertyOptions

import type { MatrixBetweenPropertyOptions } from 'scenerystack/scenery';
  • fromCoordinateFrame?: CoordinateFrame
    Which coordinate frames we want to be converting from/to, for each node
  • toCoordinateFrame?: CoordinateFrame

Source Code

See the source for MatrixBetweenProperty.ts in the scenery repository.