Skip to main content

Node

@physion/app / Exports / Node

Class: Node

Base class for all nodes in Physion.

Hierarchy

Constructors

constructor

new Node(): Node

Constructs a new instance

A newly constructed node:

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().

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

NameType
vnumber

Returns

void


angle

get angle(): number

Node's angle (in degrees)

Returns

number

set angle(v): void

Parameters

NameType
vnumber

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

NameType
vstring

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(): string[]

Returns

string[]

set scripts(v): void

Parameters

NameType
vstring[]

Returns

void


x

get x(): number

Node's x position (in meters)

Returns

number

set x(v): void

Parameters

NameType
vnumber

Returns

void


y

get y(): number

Node's y position (in meters)

Returns

number

set y(v): void

Parameters

NameType
vnumber

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

NameTypeDescription
childNodeThe 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

NameType
childrenNode[]

Returns

void


canAddChild

canAddChild(child): boolean

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

Parameters

NameType
childNode

Returns

boolean


canRemoveChild

canRemoveChild(child): boolean

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

Parameters

NameType
childNode

Returns

boolean


childIndex

childIndex(child): number

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

Parameters

NameType
childNode

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

NameType
childNode

Returns

boolean


destroy

destroy(): void

Returns

void


findAncestorByClassName

findAncestorByClassName(className): undefined | Node

Parameters

NameType
classNamestring

Returns

undefined | Node


findChildById

findChildById(id): undefined | Node

Finds and returns the child with the given id.

Parameters

NameTypeDescription
idstringThe 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

NameTypeDescription
namestringThe 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

NameTypeDescription
idstringThe 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

NameTypeDescription
idstringThe id of the asset to search for.

Returns

undefined | Asset

The matched Asset of 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

NameType
positionIPoint
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


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

NameTypeDefault value
reversedbooleanfalse

Returns

Node[]

A list of this node's descendants


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

NameType
Textends Node

Parameters

NameType
clsConstructor\<T>

Returns

T[]


getFilteredDescendantsByClassName

getFilteredDescendantsByClassName(className): Node[]

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

Parameters

NameType
classNamestring

Returns

Node[]


getLocalTransform

getLocalTransform(): Matrix

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

Returns

Matrix


getNodeScript

getNodeScript(assetId): undefined | NodeScript

Returns the NodeScript that corresponds to the given asset id.

Parameters

NameType
assetIdstring

Returns

undefined | NodeScript


getNodeScriptByClassName

getNodeScriptByClassName(className): undefined | NodeScript

Returns the NodeScript that corresponds to the given class name.

Parameters

NameType
classNamestring

Returns

undefined | NodeScript


getNodeScripts

getNodeScripts(): NodeScript[]

Returns all NodeScripts of this Node.

Returns

NodeScript[]


getPosition

getPosition(): IPoint

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

Returns

IPoint


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


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

NameType
snapModenumber

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

NameTypeDefault valueDescription
minifiedbooleanfalseWhether 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


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

NameTypeDefault value
xnumber0
ynumber0
anglenumber0

Returns

void


insertChild

insertChild(child, index): boolean

Parameters

NameType
childNode
indexnumber

Returns

boolean


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

NameType
dIPoint

Returns

void


removeAllChildren

removeAllChildren(): void

Convenience method which removes all children of this node

Returns

void


removeChild

removeChild(child): boolean

Parameters

NameType
childNode

Returns

boolean


removeChildren

removeChildren(children): void

Convenience method for removing multiple children from this node.

Parameters

NameType
childrenNode[]

Returns

void


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

NameTypeDescription
childNodeThe child node to be moved
newIndexnumberThe 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

NameType
_xany

Returns

boolean

Inherited from

CoreObject.setExtras


setFlag

setFlag(flag, on?): void

Parameters

NameTypeDefault value
flagCoreObjectFlagsundefined
onbooleantrue

Returns

void

Inherited from

CoreObject.setFlag


setPosition

setPosition(v): void

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

Parameters

NameType
vIPoint

Returns

void


setScenePosition

setScenePosition(v): void

Sets the Node's scene position.

Parameters

NameType
vIPoint

Returns

void


setState

setState(state, updateId?): boolean

Sets the object's state

Parameters

NameTypeDefault valueDescription
stateanyundefinedThe state to be set
updateIdbooleantrueWhether to also update the id property

Returns

boolean

True on success otherwise false

Inherited from

CoreObject.setState


testFlag

testFlag(flag): boolean

Parameters

NameType
flagCoreObjectFlags

Returns

boolean

Inherited from

CoreObject.testFlag


toGlobal

toGlobal(position): Point

Parameters

NameType
positionIPoint

Returns

Point


toLocal

toLocal(position): Point

Parameters

NameType
positionIPoint

Returns

Point


toScreen

toScreen(position, skipUpdate?): IPointData

Parameters

NameType
positionIPoint
skipUpdate?boolean

Returns

IPointData


update

update(delta): void

Updates this node.

The default update will do the following:

  • If this node has a script attached to it then it will call the script's update method
  • Call update for each child of this node.

Parameters

NameTypeDescription
deltanumberNot currently used

Returns

void