@physion/app / Exports / Node

Class: Node

Base class for all nodes in Physion.

Hierarchy

CoreObject

↳ Node

↳↳ AnimatedSpriteNode

↳↳ GraphicsNode

↳↳ GraphNode

↳↳ LaserNode

↳↳ LightNode

↳↳ ParticleEmitterNode

↳↳ ParticleGroupNode

↳↳ ParticleLifeNode

↳↳ Scene

↳↳ SpriteNode

↳↳ TilingSpriteNode

Constructors

constructor

• new Node(): Node

Constructs a new instance

A newly constructed node:

Has no parent (i.e. Node.parent is undefined)
Has no children (i.e. Node.children array is empty)
Has a position of Node.x = 0, Node.y = 0 and an Node.angle of 0 degrees
Is not ()|selected
Has no scripts attached (i.e. Node.scripts array is empty)

Returns

Node

Overrides

CoreObject.constructor

Properties

userData

• userData: Record<string, unknown>

EVT_CHILD_ADDED

▪ Static Readonly EVT_CHILD_ADDED: "childAdded"

The name of the event that is emitted whenever a child is added to this node.

The argument supplied is the child that was just added to this node.

EVT_CHILD_REMOVED

▪ Static Readonly EVT_CHILD_REMOVED: "childRemoved"

The name of the event that is emitted whenever a child is removed from this node.

The argument supplied is the child that was just removed from this node.

EVT_CHILD_REORDERED

▪ Static Readonly EVT_CHILD_REORDERED: "childReordered"

The name of the event that is emitted whenever a child of this node is reordered.

The arguments supplied are: (1) The child that was just reordered (2) the old index of the child and (3) the new index of the child.

EVT_NAME_CHANGED

▪ Static Readonly EVT_NAME_CHANGED: "nameChanged"

The name of the event that is emitted whenever the name of this object changes.

The argument suplied is the new CoreObject.name of the object.

Inherited from

CoreObject.EVT_NAME_CHANGED

EVT_PROPERTY_CHANGED

▪ Static Readonly EVT_PROPERTY_CHANGED: "propertyChanged"

The name of the event that is emitted whenever a property of this object changes.

The arguments supplied are: (1) The name of the property that has changed and (2) the new value of that property.

Inherited from

CoreObject.EVT_PROPERTY_CHANGED

EVT_TRANSFORM_CHANGED

▪ Static Readonly EVT_TRANSFORM_CHANGED: "transformChanged"

The name of the event that is emitted whenever the x, y or angle properties of this Node are changed.

Note that this event is not emitted when x, y or angle properties are changed as a result of an update().

ID_LENGTH

▪ Static Readonly ID_LENGTH: 12

Inherited from

CoreObject.ID_LENGTH

MAX_NAME_LENGTH

▪ Static Readonly MAX_NAME_LENGTH: 128

Inherited from

CoreObject.MAX_NAME_LENGTH

Accessors

alpha

• get alpha(): number

Node's alpha

This value is between 0 (transparent) and 1.0 (opaque). This property can be considered as the "master" opacity of the node. Defaults to 1 (fully opaque)

Returns

number

• set alpha(v): void

Parameters

Name	Type
`v`	`number`

Returns

void

angle

• get angle(): number

Node's angle (in degrees)

Returns

number

• set angle(v): void

Parameters

Name	Type
`v`	`number`

Returns

void

childCount

• get childCount(): number

Returns the number of children this node contains.

Returns

number

children

• get children(): Node[]

Returns the children of this node.

Returns

Node[]

flags

• get flags(): CoreObjectFlags

Returns

CoreObjectFlags

Inherited from

CoreObject.flags

id

• get id(): string

Object's (unique) id

Note that the id of the object cannot be set (it is automatically assigned upon construction)

Returns

string

Inherited from

CoreObject.id

metaObject

• get metaObject(): MetaObject

Returns the MetaObject that describes this class

Returns

MetaObject

Overrides

CoreObject.metaObject

name

• get name(): string

The object's name

The object's name is a free text value which defaults to an empty string.

Note that when the name of the object changes, the CoreObject.EVT_NAME_CHANGED signal will be emitted.

Returns

string

Inherited from

CoreObject.name

• set name(v): void

Parameters

Name	Type
`v`	`string`

Returns

void

Inherited from

CoreObject.name

parent

• get parent(): undefined | Node

Returns the parent of this node (or undefined if this node has no parent).

Returns

undefined | Node

scripts

• get scripts(): IScript[]

Returns

IScript[]

• set scripts(v): void

Parameters

Name	Type
`v`	`IScript`[]

Returns

void

ttl

• get ttl(): number

Node's time-to-live, in milliseconds.

A value of -1 (the default) means this node has no ttl and will never be automatically removed. Any other value counts down while the simulation is running; once it reaches 0 the node (and any nodes that depend on it) is removed from the Scene.

Has no effect on the Scene node itself, which never counts down or gets removed via ttl.

Returns

number

• set ttl(v): void

Parameters

Name	Type
`v`	`number`

Returns

void

visualFilters

• get visualFilters(): IVisualFilters

The visual effects drawn over this node and its children, keyed by types.VisualFilterKey. See VisualFiltersMixin.

Returns

IVisualFilters

• set visualFilters(v): void

Parameters

Name	Type
`v`	`IVisualFilters`

Returns

void

x

• get x(): number

Node's x position (in meters)

Returns

number

• set x(v): void

Parameters

Name	Type
`v`	`number`

Returns

void

y

• get y(): number

Node's y position (in meters)

Returns

number

• set y(v): void

Parameters

Name	Type
`v`	`number`

Returns

void

Methods

addChild

▸ addChild(child): boolean

Adds the given child to this node.

If the given child is already contained in this node or it already has a Node.parent then this method will fail (false will be returned).

Otherwise the child will be added to this node and the Node.EVT_CHILD_ADDED signal will be emitted.

Parameters

Name	Type	Description
`child`	`Node`	The child to be added to this node.

Returns

boolean

True on success otherwise false.

addChildren

▸ addChildren(children): void

Convenience method for adding multiple children to this node.

Parameters

Name	Type
`children`	`Node`[]

Returns

void

addScript

▸ addScript(assetId, params?): undefined | IScript

Adds a new script to this node.

Convenience wrapper around the scripts property, which validates the entry and rejects it if malformed. An entry whose asset is not available yet stays inert until it is.

Parameters

Name	Type	Description
`assetId`	`string`	The id of the script's TextAsset.
`params`	`ScriptParams`	Initial values for the script's editable properties.

Returns

undefined | IScript

A copy of the added script entry, or undefined if it was rejected. Use its id with getNodeScript() or removeScript().

callMethodForAllNodeScripts

▸ callMethodForAllNodeScripts<T>(methodName, ...args): void

Type parameters

Name	Type
`T`	extends `NodeScriptMethodName`

Parameters

Name	Type
`methodName`	`T`
`...args`	`Parameters`<`NonNullable`<`INodeScriptValue`[`T`]>>

Returns

void

canAddChild

▸ canAddChild(child): boolean

Returns true if the given child can be added to this node

Parameters

Name	Type
`child`	`Node`

Returns

boolean

canRemoveChild

▸ canRemoveChild(child): boolean

Returns true if the given child can be removed from this node

Parameters

Name	Type
`child`	`Node`

Returns

boolean

childIndex

▸ childIndex(child): number

Returns the index of the given child (or -1 if child is not contained in thie node).

Parameters

Name	Type
`child`	`Node`

Returns

number

clone

▸ clone(): Node

Creates and returns a clone of this node.

The clone returned will have the same property values as this node except from its CoreObject.id.

Returns

Node

A clone of this node.

containsChild

▸ containsChild(child): boolean

Returns true if this node contains the given child

Parameters

Name	Type
`child`	`Node`

Returns

boolean

destroy

▸ destroy(): void

Returns

void

findAncestorByClassName

▸ findAncestorByClassName(className): undefined | Node

Parameters

Name	Type
`className`	`string`

Returns

undefined | Node

findChildById

▸ findChildById(id): undefined | Node

Finds and returns the child with the given id.

Parameters

Name	Type	Description
`id`	`string`	The CoreObject.id of the child to search for.

Returns

undefined | Node

The child with the given id or undefined if no such child exists.

findChildByName

▸ findChildByName(name): undefined | Node

Finds and returns the first child node with the given name.

Parameters

Name	Type	Description
`name`	`string`	The CoreObject.name of the child to search for.

Returns

undefined | Node

The first child with the given name or undefined if no such child exists.

findDescendantById

▸ findDescendantById(id): undefined | Node

Finds and returns the descendant with the given id.

Parameters

Name	Type	Description
`id`	`string`	The CoreObject.id of the descendant to search for.

Returns

undefined | Node

The descendant with the given id or undefined if no such descendant exists.

findSceneAssetById

▸ findSceneAssetById(id): undefined | Asset

Finds and returns the asset specified by the given id. Note that the node needs to be parented to a Scene for this method to work.

Parameters

Name	Type	Description
`id`	`string`	The id of the asset to search for.

Returns

undefined | Asset

The matched Asset of undefined if no such asset exists in the scene.

findSceneAssetByName

▸ findSceneAssetByName(name): undefined | Asset

Finds and returns the asset specified by the given name. Note that the node needs to be parented to a Scene for this method to work. Asset names are not unique, so if more than one asset shares the given name the first match is returned.

Parameters

Name	Type	Description
`name`	`string`	The name of the asset to search for.

Returns

undefined | Asset

The matched Asset or undefined if no such asset exists in the scene.

findSceneNode

▸ findSceneNode(): undefined | Node

Uses the Node.findAncestorByClassName to find the Scene that this node is added to. If this node has not yet been added to a scene then this method will return undefined.

Returns

undefined | Node

fromScreen

▸ fromScreen(position, from?, skipUpdate?): IPointData

Parameters

Name	Type
`position`	`IPoint`
`from?`	`Node`
`skipUpdate?`	`boolean`

Returns

IPointData

getAncestors

▸ getAncestors(): Node[]

Returns the ancestors of this node

Returns

Node[]

getAssetIds

▸ getAssetIds(): string[]

Returns the ids of the assets that are used by this Node.

Returns

string[]

The ids of the assets that are used by this Node.

getBoundingRect

▸ getBoundingRect(): Rectangle

Returns the bounding rectangle of this node in local coordinates.

The default implementation returns the local bounds of the underlying PIXI container but subclasses can re-implement this method to return their custom bounding rectangle.

Returns

Rectangle

getDependencies

▸ getDependencies(): Node[]

Returns the nodes this node depends on. If this node is not added to a [[Scene]] then an empty array will be returned.

Returns

Node[]

Array of nodes this node depends on.

getDependencyIds

▸ getDependencyIds(): string[]

Returns the IDs of all nodes this node depends on. Subclasses that have dependencies (e.g. JointNode) should re-implement this method and return the IDs of the nodes that they depend on. The default implementation returns an empty array.

Returns

string[]

Array of node IDs this node depends on.

getDependents

▸ getDependents(): Node[]

Returns all Nodes that depend on this node. If this node is not added to a [[Scene]] then an empty array will be returned.

Returns

Node[]

Array of Nodes that have this node as a dependency

getDescendants

▸ getDescendants(reversed?): Node[]

Returns the descendants of this node.

A descendant is node that has this node as an ancestor. Consider for example the following tree of nodes:

NodeA
- NodeB
  - NodeD
  - NodeE
- NodeC

If we ask for the descendants of NodeA we'll get back: [NodeB, NodeD, NodeE, NodeC]

If reversed is set to true then this method will return the reversed descendants. For the example above, that would be: [NodeC, NodeE, NodeD, NodeB, NodeA]. Note that the first item of the reversed descendants has the highest z-index.

Parameters

Name	Type	Default value
`reversed`	`boolean`	`false`

Returns

Node[]

A list of this node's descendants

getDescendantsMap

▸ getDescendantsMap(): Map<string, Node>

Returns a map of all descendants keyed by their IDs.

This provides efficient lookup of any descendant node by its ID without having to traverse the tree multiple times.

Returns

Map<string, Node>

A Map where keys are node IDs and values are the corresponding Node objects

getExtras

▸ getExtras(): any

Returns any extra data that this object needs to save during serialization.

In some cases an object might need to save some extra data without necessarily this extra data being part of its state (e.g. the AssetsLibrary of a Scene). In these cases subclasses can re-implement this method and return the data required.

The default implementation returns undefined meaning that no extra data needs to be saved during serialization.

Returns

any

Inherited from

CoreObject.getExtras

getFilteredDescendants

▸ getFilteredDescendants<T>(cls): T[]

Returns the descendants of this node that are instances of the class cls

Type parameters

Name	Type
`T`	extends `Node`

Parameters

Name	Type
`cls`	`Constructor`<`T`>

Returns

T[]

getFilteredDescendantsByClassName

▸ getFilteredDescendantsByClassName(className): Node[]

Returns the descendants of this node that are instances of the class className

Parameters

Name	Type
`className`	`string`

Returns

Node[]

getLocalTransform

▸ getLocalTransform(): Matrix

Returns a copy of this node's (local) transformation matrix.

Returns

Matrix

getNodeScript

▸ getNodeScript(id): undefined | NodeScript

Returns the NodeScript that corresponds to the given id.

Parameters

Name	Type
`id`	`string`

Returns

undefined | NodeScript

getNodeScriptByClassName

▸ getNodeScriptByClassName(className): undefined | NodeScript

Parameters

Name	Type
`className`	`string`

Returns

undefined | NodeScript

Deprecated

Use getNodeScriptsByClassName instead. Kept for backward compatibility with old scenes.

getNodeScripts

▸ getNodeScripts(): NodeScript[]

Returns all NodeScripts of this Node, in the order of the script entries they belong to.

An entry that has no NodeScript is left out, so the result can be shorter than scripts.

Returns

NodeScript[]

getNodeScriptsByClassName

▸ getNodeScriptsByClassName(className): NodeScript[]

Returns all NodeScripts whose class name matches the given className.

Parameters

Name	Type
`className`	`string`

Returns

NodeScript[]

getPosition

▸ getPosition(): IPoint

Convenience method which returns the node's position as a x,y object

Returns

IPoint

getSceneAngle

▸ getSceneAngle(): number

Returns the Node's angle in Scene coordinates.

Returns

number

getSceneBoundingRect

▸ getSceneBoundingRect(): Rectangle

Returns the bounding rect of this node in scene coordinates.

Returns

Rectangle

getScenePosition

▸ getScenePosition(): IPoint

Returns the Node's position in Scene coordinates.

Returns

IPoint

getScenePositionAndAngle

▸ getScenePositionAndAngle(): Object

Returns the Node's position and angle in Scene coordinates (optimized).

Returns

Object

Name	Type
`angle`	`number`
`position`	`IPoint`

getSceneTransform

▸ getSceneTransform(): Matrix

Returns a copy of this node's scene transformation matrix. Use this matrix to map coordinates from this node's local coordinate system to the scene's coordinate system. To map coordinates from the scene, you must first invert the returned matrix.

Unlike getLocalTransform(), which returns only the local transformation, this function includes the node's (and any parents') position, and all the transfomation properties.

Returns

Matrix

getShape

▸ getShape(): Polygon

Returns the shape of this Node in local coordinates.

Note that the returned shape might be empty.

The shape of a Node is used for many things, including boolean operations and selection.

The default implementation calls getBoundingRect() to return a simple rectangular shape, but subclasses can reimplement this function to return a more accurate shape for non-rectangular items.

Returns

Polygon

getSnapPoints

▸ getSnapPoints(snapMode): ISnapPoint[]

Snap Points

Parameters

Name	Type
`snapMode`	`number`

Returns

ISnapPoint[]

getState

▸ getState(minified?): any

Returns this object's state

The object's state is an object containing key/value pairs corresponding to this object's properties. For example:

{
	id: "Ssba4ch5ruok",
	name: "Circle",
	radius: 2,
   // ...
}

To avoid including properties that are currently in their default value you can set minified = true when calling getState.

Note that read-only properties are not part of the object's state (with the exception of the id)

Parameters

Name	Type	Default value	Description
`minified`	`boolean`	`false`	Whether to return a minified state or not

Returns

any

Inherited from

CoreObject.getState

getTransformedShape

▸ getTransformedShape(): Polygon

Returns the shape of this Node in scene coordinates.

Note that the returned shape might be empty.

Returns

Polygon

hasDependencies

▸ hasDependencies(): boolean

Returns true if this node has dependencies, otherwise returns false.

Returns

boolean

index

▸ index(): number

Returns the index of this Node relatively to its parent. If this Node has no parent then -1 is returned.

Returns

number

initNode

▸ initNode(x?, y?, angle?): void

Convenience method for setting node's Node.x, Node.y and Node.angle

Parameters

Name	Type	Default value
`x`	`number`	`0`
`y`	`number`	`0`
`angle`	`number`	`0`

Returns

void

insertChild

▸ insertChild(child, index): boolean

Parameters

Name	Type
`child`	`Node`
`index`	`number`

Returns

boolean

insertChildren

▸ insertChildren(children, index): void

Convenience method for inserting multiple children into this node at the specified index.

Parameters

Name	Type
`children`	`Node`[]
`index`	`number`

Returns

void

isDestroyed

▸ isDestroyed(): boolean

Returns true if this node has been destroyed via destroy(). A destroyed Node should not be used.

Returns

boolean

isSelected

▸ isSelected(): boolean

Returns true if this node is currently selected.

Returns

boolean

move

▸ move(d): void

Moves this node by the given d.x, d.y

Parameters

Name	Type
`d`	`IPoint`

Returns

void

removeAllChildren

▸ removeAllChildren(): void

Convenience method which removes all children of this node

Returns

void

removeChild

▸ removeChild(child): boolean

Parameters

Name	Type
`child`	`Node`

Returns

boolean

removeChildren

▸ removeChildren(children): void

Convenience method for removing multiple children from this node.

Parameters

Name	Type
`children`	`Node`[]

Returns

void

removeScript

▸ removeScript(id): boolean

Removes a script from this node.

Convenience wrapper around the scripts property: it drops the matching entry and reassigns the array.

Parameters

Name	Type	Description
`id`	`string`	The `id` of the script entry to remove.

Returns

boolean

true if a script was removed, false if this node has no such script.

reorderChild

▸ reorderChild(child, newIndex): boolean

Moves a child node to a different position (order) among the other children If the operation is successul then the EVT_CHILD_REORDERED signal will be emitted

Parameters

Name	Type	Description
`child`	`Node`	The child node to be moved
`newIndex`	`number`	The new index where the child node will be moved

Returns

boolean

true on success otherwise false

setExtras

▸ setExtras(_x): boolean

Sets any extra data that this object needs during de-serialization.

Returns true on success, otherwise returns false.

The default implementation does nothing and returns true.

Parameters

Name	Type
`_x`	`any`

Returns

boolean

Inherited from

CoreObject.setExtras

setFlag

▸ setFlag(flag, on?): void

Parameters

Name	Type	Default value
`flag`	`CoreObjectFlags`	`undefined`
`on`	`boolean`	`true`

Returns

void

Inherited from

CoreObject.setFlag

setPosition

▸ setPosition(v): void

Convenience method for setting the node's position to the given x,y

Parameters

Name	Type
`v`	`IPoint`

Returns

void

setScenePosition

▸ setScenePosition(v): void

Sets the Node's scene position.

Parameters

Name	Type
`v`	`IPoint`

Returns

void

setState

▸ setState(state, updateId?): boolean

Sets the object's state

Parameters

Name	Type	Default value	Description
`state`	`any`	`undefined`	The state to be set
`updateId`	`boolean`	`true`	Whether to also update the id property

Returns

boolean

True on success otherwise false

Inherited from

CoreObject.setState

testFlag

▸ testFlag(flag): boolean

Parameters

Name	Type
`flag`	`CoreObjectFlags`

Returns

boolean

Inherited from

CoreObject.testFlag

toGlobal

▸ toGlobal(position): Point

Parameters

Name	Type
`position`	`IPoint`

Returns

Point

toLocal

▸ toLocal(position): Point

Parameters

Name	Type
`position`	`IPoint`

Returns

Point

toScreen

▸ toScreen(position, skipUpdate?): IPointData

Parameters

Name	Type
`position`	`IPoint`
`skipUpdate?`	`boolean`

Returns

IPointData

update

▸ update(delta): void

Updates this node.

The default update will do the following:

It will call the update method for all NodeScripts attached to this node
Advance the visual filters that animate, see VisualFiltersMixin.update
Call update for each child of this node.

Children are iterated over a shallow copy of _children, not the live array, since a NodeScript's update() may insert/remove siblings on this node (e.g. Breakable spawning fragments); iterating the live array would skip or double-visit siblings shifted by those mutations.

Parameters

Name	Type	Description
`delta`	`number`	The fixed simulation step, in milliseconds

Returns

void

Hierarchy​

Constructors​

constructor​

Returns​

Overrides​

Properties​

userData​

EVT_CHILD_ADDED​

EVT_CHILD_REMOVED​

EVT_CHILD_REORDERED​

EVT_NAME_CHANGED​

Inherited from​

EVT_PROPERTY_CHANGED​

Inherited from​

EVT_TRANSFORM_CHANGED​

ID_LENGTH​

Inherited from​

MAX_NAME_LENGTH​

Inherited from​

Accessors​

alpha​

Returns​

Parameters​

Returns​

angle​

Returns​

Parameters​

Returns​

childCount​

Returns​

children​

Returns​

flags​

Returns​

Inherited from​

id​

Returns​

Inherited from​

metaObject​

Returns​

Overrides​

name​

Returns​

Inherited from​

Parameters​

Returns​

Inherited from​

parent​

Returns​

scripts​

Returns​

Parameters​

Returns​

ttl​

Returns​

Parameters​

Returns​

visualFilters​

Returns​

Parameters​

Returns​

x​

Returns​

Parameters​

Returns​

y​

Returns​

Parameters​

Returns​

Methods​

addChild​

Parameters​

Returns​

addChildren​

Parameters​

Returns​

addScript​

Parameters​

Returns​

callMethodForAllNodeScripts​

Hierarchy

Constructors

constructor

Returns

Overrides

Properties

userData

EVT_CHILD_ADDED

EVT_CHILD_REMOVED

EVT_CHILD_REORDERED

EVT_NAME_CHANGED

Inherited from

EVT_PROPERTY_CHANGED

Inherited from

EVT_TRANSFORM_CHANGED

ID_LENGTH

Inherited from

MAX_NAME_LENGTH

Inherited from

Accessors

alpha

Returns

Parameters

Returns

angle

Returns

Parameters

Returns

childCount

Returns

children

Returns

flags

Returns

Inherited from

id

Returns

Inherited from

metaObject

Returns

Overrides

name

Returns

Inherited from

Parameters

Returns

Inherited from

parent

Returns

scripts

Returns

Parameters

Returns

ttl

Returns

Parameters

Returns

visualFilters

Returns

Parameters

Returns

x

Returns

Parameters

Returns

y

Returns

Parameters

Returns

Methods

addChild

Parameters

Returns

addChildren

Parameters

Returns

addScript

Parameters

Returns

callMethodForAllNodeScripts