Class GraphNode

The GraphNode class represents a node within a hierarchical scene graph. Each GraphNode can reference an array of children. This creates a tree-like structure that is fundamental for organizing and managing the spatial relationships between objects in a 3D scene. This class provides a comprehensive API for manipulating the position, rotation, and scale of nodes both locally (relative to the parent) and in world space (relative to the Scene origin).

During the application's (see AppBase) main update loop, the engine automatically synchronizes the entire GraphNode hierarchy each frame. This process ensures that the world transformation matrices for all nodes are up-to-date. A node's world transformation matrix is calculated by combining its local transformation matrix (derived from its local position, rotation, and scale) with the world transformation matrix of its parent node. For the scene graph's root node (which has no parent), its world matrix is simply its local matrix. This hierarchical update mechanism ensures that changes made to a parent node's transform correctly propagate down to all its children and descendants, accurately reflecting their final position, orientation, and scale in the world. This synchronized world transform is essential for systems like rendering and physics.

GraphNode is the superclass of Entity, which is the primary class for creating objects in a PlayCanvas application. For this reason, developers typically interact with the scene hierarchy and transformations through the Entity interface rather than using GraphNode directly. However, GraphNode provides the underlying powerful set of features for hierarchical transformations that Entity leverages.

Hierarchy (View Summary)

EventHandler
- GraphNode
  - Entity

Constructors

constructor

new GraphNode(name?: string): GraphNode
Create a new GraphNode instance.
Parameters
- Optionalname: string = 'Untitled'
  The non-unique name of a graph node. Defaults to 'Untitled'.
Returns GraphNode
Overrides EventHandler.constructor
- Defined in scene/graph-node.js:308

Properties

`Protected`_children

_children: GraphNode[] = []

name

name: string

The non-unique name of a graph node. Defaults to 'Untitled'.

Accessors

children

get children(): GraphNode[]
Gets the children of this graph node.

Returns GraphNode[]
- Defined in scene/graph-node.js:444

enabled

get enabled(): boolean
Gets the enabled state of the GraphNode.

Returns boolean
- Defined in scene/graph-node.js:391
set enabled(enabled: boolean): void
Sets the enabled state of the GraphNode. If one of the GraphNode's parents is disabled there will be no other side effects. If all the parents are enabled then the new value will activate or deactivate all the enabled children of the GraphNode.
Parameters
- enabled: boolean
Returns void
- Defined in scene/graph-node.js:374

forward

get forward(): Vec3
Gets the normalized local space negative Z-axis vector of the graph node in world space.

Returns Vec3
- Defined in scene/graph-node.js:343

graphDepth

get graphDepth(): number
Gets the depth of this child within the graph. Note that for performance reasons this is only recalculated when a node is added to a new parent. In other words, it is not recalculated when a node is simply removed from the graph.

Returns number
- Defined in scene/graph-node.js:455

parent

get parent(): null | GraphNode
Gets the parent of this graph node.

Returns null | GraphNode
- Defined in scene/graph-node.js:403

path

get path(): string
Gets the path of this graph node relative to the root of the hierarchy.

Returns string
- Defined in scene/graph-node.js:412

right

get right(): Vec3
Gets the normalized local space X-axis vector of the graph node in world space.

Returns Vec3
- Defined in scene/graph-node.js:319

root

get root(): GraphNode
Gets the oldest ancestor graph node from this graph node.

Returns GraphNode
- Defined in scene/graph-node.js:431

up

get up(): Vec3
Gets the normalized local space Y-axis vector of the graph node in world space.

Returns Vec3
- Defined in scene/graph-node.js:331

Methods

`Protected`_notifyHierarchyStateChanged

_notifyHierarchyStateChanged(node: GraphNode, enabled: boolean): void
Protected
Parameters
- node: GraphNode
  Graph node to update.
- enabled: boolean
  True if enabled in the hierarchy, false if disabled.
Returns void
- Defined in scene/graph-node.js:464

`Protected`_onHierarchyStateChanged

_onHierarchyStateChanged(enabled: boolean): void
Protected
Called when the enabled flag of the entity or one of its parents changes.
Parameters
- enabled: boolean
  True if enabled in the hierarchy, false if disabled.
Returns void
- Defined in scene/graph-node.js:481

addChild

addChild(node: GraphNode): void
Add a new child to the child list and update the parent value of the child node. If the node already had a parent, it is removed from its child list.
Parameters
- node: GraphNode
  The new child to add.
Returns void
Example
```
const e = new pc.Entity(app);
this.entity.addChild(e);
```
- Defined in scene/graph-node.js:1360

clone

clone(): GraphNode
Clone a graph node.

Returns GraphNode
A clone of the specified graph node.
- Defined in scene/graph-node.js:532

destroy

destroy(): void
Destroy the graph node and all of its descendants. First, the graph node is removed from the hierarchy. This is then repeated recursively for all descendants of the graph node.

The last thing the graph node does is fire the destroy event.

Returns void
Example
```
const firstChild = graphNode.children[0];
firstChild.destroy(); // destroy child and all of its descendants
```
- Defined in scene/graph-node.js:561

find

find(attr: string | FindNodeCallback, value?: any): GraphNode[]
Search the graph node and all of its descendants for the nodes that satisfy some search criteria.
Parameters
- attr: string | FindNodeCallback
  This can either be a function or a string. If it's a function, it is executed for each descendant node to test if node satisfies the search logic. Returning true from the function will include the node into the results. If it's a string then it represents the name of a field or a method of the node. If this is the name of a field then the value passed as the second argument will be checked for equality. If this is the name of a function then the return value of the function will be checked for equality against the valued passed as the second argument to this function.
- Optionalvalue: any
  If the first argument (attr) is a property name then this value will be checked against the value of the property.
Returns GraphNode[]
The array of graph nodes that match the search criteria.
Example
```
// Finds all nodes that have a model component and have 'door' in their lower-cased name
const doors = house.find(function (node) {
    return node.model && node.name.toLowerCase().indexOf('door') !== -1;
});
```
Example
```
// Finds all nodes that have the name property set to 'Test'
const entities = parent.find('name', 'Test');
```
- Defined in scene/graph-node.js:607

findByName

findByName(name: string): null | GraphNode
Get the first node found in the graph with the name. The search is depth first.
Parameters
- name: string
  The name of the graph.
Returns null | GraphNode
The first node to be found matching the supplied name. Returns null if no node is found.
- Defined in scene/graph-node.js:695

findByPath

findByPath(path: string | string[]): null | GraphNode
Get the first node found in the graph by its full path in the graph. The full path has this form 'parent/child/sub-child'. The search is depth first.
Parameters
- path: string | string[]
  The full path of the GraphNode as either a string or array of GraphNode names.
Returns null | GraphNode
The first node to be found matching the supplied path. Returns null if no node is found.
Example
```
// String form
const grandchild = this.entity.findByPath('child/grandchild');
```
Example
```
// Array form
const grandchild = this.entity.findByPath(['child', 'grandchild']);
```
- Defined in scene/graph-node.js:714

findByTag

findByTag(...query: any[]): GraphNode[]

Return all graph nodes that satisfy the search query. Query can be simply a string, or comma separated strings, to have inclusive results of assets that match at least one query. A query that consists of an array of tags can be used to match graph nodes that have each tag of array.

Parameters

...query: any[]
Name of a tag or array of tags.

Returns GraphNode[]

A list of all graph nodes that match the query.

Example

// Return all graph nodes that tagged by `animal`
const animals = node.findByTag("animal");

Example

// Return all graph nodes that tagged by `bird` OR `mammal`
const birdsAndMammals = node.findByTag("bird", "mammal");

Example

// Return all assets that tagged by `carnivore` AND `mammal`
const meatEatingMammals = node.findByTag(["carnivore", "mammal"]);

Example

// Return all assets that tagged by (`carnivore` AND `mammal`) OR (`carnivore` AND `reptile`)
const meatEatingMammalsAndReptiles = node.findByTag(["carnivore", "mammal"], ["carnivore", "reptile"]);

findOne

findOne(attr: string | FindNodeCallback, value?: any): null | GraphNode
Search the graph node and all of its descendants for the first node that satisfies some search criteria.
Parameters
- attr: string | FindNodeCallback
  This can either be a function or a string. If it's a function, it is executed for each descendant node to test if node satisfies the search logic. Returning true from the function will result in that node being returned from findOne. If it's a string then it represents the name of a field or a method of the node. If this is the name of a field then the value passed as the second argument will be checked for equality. If this is the name of a function then the return value of the function will be checked for equality against the valued passed as the second argument to this function.
- Optionalvalue: any
  If the first argument (attr) is a property name then this value will be checked against the value of the property.
Returns null | GraphNode
A graph node that match the search criteria. Returns null if no node is found.
Example
```
// Find the first node that is called 'head' and has a model component
const head = player.findOne(function (node) {
    return node.model && node.name === 'head';
});
```
Example
```
// Finds the first node that has the name property set to 'Test'
const node = parent.findOne('name', 'Test');
```
- Defined in scene/graph-node.js:644

fire

fire(
    name: string,
    arg1?: any,
    arg2?: any,
    arg3?: any,
    arg4?: any,
    arg5?: any,
    arg6?: any,
    arg7?: any,
    arg8?: any,
): EventHandler
Fire an event, all additional arguments are passed on to the event listener.
Parameters
- name: string
  Name of event to fire.
- Optionalarg1: any
  First argument that is passed to the event handler.
- Optionalarg2: any
  Second argument that is passed to the event handler.
- Optionalarg3: any
  Third argument that is passed to the event handler.
- Optionalarg4: any
  Fourth argument that is passed to the event handler.
- Optionalarg5: any
  Fifth argument that is passed to the event handler.
- Optionalarg6: any
  Sixth argument that is passed to the event handler.
- Optionalarg7: any
  Seventh argument that is passed to the event handler.
- Optionalarg8: any
  Eighth argument that is passed to the event handler.
Returns EventHandler
Self for chaining.
Example
```
obj.fire('test', 'This is the message');
```
Inherited from EventHandler.fire
- Defined in core/event-handler.js:274

forEach

forEach(callback: ForEachNodeCallback, thisArg?: any): void
Executes a provided function once on this graph node and all of its descendants.
Parameters
- callback: ForEachNodeCallback
  The function to execute on the graph node and each descendant.
- OptionalthisArg: any
  Optional value to use as this when executing callback function.
Returns void
Example
```
// Log the path and name of each node in descendant tree starting with "parent"
parent.forEach(function (node) {
    console.log(node.path + "/" + node.name);
});
```
- Defined in scene/graph-node.js:741

getEulerAngles

getEulerAngles(): Vec3
Get the world space rotation for the specified GraphNode in Euler angles. The angles are in degrees and in XYZ order.

Important: The value returned by this function should be considered read-only. In order to set the world space rotation of the graph node, use setEulerAngles.

Returns Vec3
The world space rotation of the graph node in Euler angle form.
Example
```
const angles = this.entity.getEulerAngles();
angles.y = 180; // rotate the entity around Y by 180 degrees
this.entity.setEulerAngles(angles);
```
- Defined in scene/graph-node.js:800

getLocalEulerAngles

getLocalEulerAngles(): Vec3
Get the local space rotation for the specified GraphNode in Euler angles. The angles are in degrees and in XYZ order.

Important: The value returned by this function should be considered read-only. In order to set the local space rotation of the graph node, use setLocalEulerAngles.

Returns Vec3
The local space rotation of the graph node as Euler angles in XYZ order.
Example
```
const angles = this.entity.getLocalEulerAngles();
angles.y = 180;
this.entity.setLocalEulerAngles(angles);
```
- Defined in scene/graph-node.js:818

getLocalPosition

getLocalPosition(): Vec3
Get the position in local space for the specified GraphNode. The position is returned as a Vec3. The returned vector should be considered read-only. To update the local position, use setLocalPosition.

Returns Vec3
The local space position of the graph node.
Example
```
const position = this.entity.getLocalPosition();
position.x += 1; // move the entity 1 unit along x.
this.entity.setLocalPosition(position);
```
- Defined in scene/graph-node.js:834

getLocalRotation

getLocalRotation(): Quat
Get the rotation in local space for the specified GraphNode. The rotation is returned as a Quat. The returned quaternion should be considered read-only. To update the local rotation, use setLocalRotation.

Returns Quat
The local space rotation of the graph node as a quaternion.
Example
```
const rotation = this.entity.getLocalRotation();
```
- Defined in scene/graph-node.js:847

getLocalScale

getLocalScale(): Vec3
Get the scale in local space for the specified GraphNode. The scale is returned as a Vec3. The returned vector should be considered read-only. To update the local scale, use setLocalScale.

Returns Vec3
The local space scale of the graph node.
Example
```
const scale = this.entity.getLocalScale();
scale.x = 100;
this.entity.setLocalScale(scale);
```
- Defined in scene/graph-node.js:862

getLocalTransform

getLocalTransform(): Mat4
Get the local transform matrix for this graph node. This matrix is the transform relative to the node's parent's world transformation matrix.

Returns Mat4
The node's local transformation matrix.
Example
```
const transform = this.entity.getLocalTransform();
```
- Defined in scene/graph-node.js:874

getPosition

getPosition(): Vec3
Get the world space position for the specified GraphNode. The position is returned as a Vec3. The value returned by this function should be considered read-only. In order to set the world space position of the graph node, use setPosition.

Returns Vec3
The world space position of the graph node.
Example
```
const position = this.entity.getPosition();
position.x = 10;
this.entity.setPosition(position);
```
- Defined in scene/graph-node.js:893

getRotation

getRotation(): Quat
Get the world space rotation for the specified GraphNode. The rotation is returned as a Quat. The value returned by this function should be considered read-only. In order to set the world space rotation of the graph node, use setRotation.

Returns Quat
The world space rotation of the graph node as a quaternion.
Example
```
const rotation = this.entity.getRotation();
```
- Defined in scene/graph-node.js:907

getWorldTransform

getWorldTransform(): Mat4
Get the world transformation matrix for this graph node.

Returns Mat4
The node's world transformation matrix.
Example
```
const transform = this.entity.getWorldTransform();
```
- Defined in scene/graph-node.js:939

hasEvent

hasEvent(name: string): boolean
Test if there are any handlers bound to an event name.
Parameters
- name: string
  The name of the event to test.
Returns boolean
True if the object has handlers bound to the specified event name.
Example
```
obj.on('test', () => {}); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false
```
Inherited from EventHandler.hasEvent
- Defined in core/event-handler.js:342

insertChild

insertChild(node: GraphNode, index: number): void
Insert a new child to the child list at the specified index and update the parent value of the child node. If the node already had a parent, it is removed from its child list.
Parameters
- node: GraphNode
  The new child to insert.
- index: number
  The index in the child list of the parent where the new node will be inserted.
Returns void
Example
```
const e = new pc.Entity(app);
this.entity.insertChild(e, 1);
```
- Defined in scene/graph-node.js:1400

isAncestorOf

isAncestorOf(node: GraphNode): boolean
Check if node is ancestor for another node.
Parameters
- node: GraphNode
  Potential descendant of node.
Returns boolean
If node is ancestor for another node.
Example
```
if (body.isAncestorOf(foot)) {
    // foot is within body's hierarchy
}
```
- Defined in scene/graph-node.js:783

isDescendantOf

isDescendantOf(node: GraphNode): boolean
Check if node is descendant of another node.
Parameters
- node: GraphNode
  Potential ancestor of node.
Returns boolean
If node is descendant of another node.
Example
```
if (roof.isDescendantOf(house)) {
    // roof is descendant of house entity
}
```
- Defined in scene/graph-node.js:761

lookAt

lookAt(
    x: number,
    y: number,
    z: number,
    ux?: number,
    uy?: number,
    uz?: number,
): void
Reorients the graph node so that the negative z-axis points towards the target.
Parameters
- x: number
  X-component of the world space coordinate to look at.
- y: number
  Y-component of the world space coordinate to look at.
- z: number
  Z-component of the world space coordinate to look at.
- Optionalux: number
  X-component of the up vector for the look at transform. Defaults to 0.
- Optionaluy: number
  Y-component of the up vector for the look at transform. Defaults to 1.
- Optionaluz: number
  Z-component of the up vector for the look at transform. Defaults to 0.
Returns void
Example
```
// Look at the world space origin, using the (default) positive y-axis for up
this.entity.lookAt(0, 0, 0);
```
Example
```
// Look at world space coordinate [10, 10, 10], using the negative world y-axis for up
this.entity.lookAt(10, 10, 10, 0, -1, 0);
```
- Defined in scene/graph-node.js:1609
lookAt(target: Vec3, up?: Vec3): void
Reorients the graph node so that the negative z-axis points towards the target.
Parameters
- target: Vec3
  The world space coordinate to look at.
- Optionalup: Vec3
  The world space up vector for look at transform. Defaults to Vec3.UP.
Returns void
Example
```
// Look at another entity, using the (default) positive y-axis for up
const target = otherEntity.getPosition();
this.entity.lookAt(target);
```
Example
```
// Look at another entity, using the negative world y-axis for up
const target = otherEntity.getPosition();
this.entity.lookAt(target, pc.Vec3.DOWN);
```
- Defined in scene/graph-node.js:1627

off

off(name?: string, callback?: HandleEventCallback, scope?: any): EventHandler
Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.
Parameters
- Optionalname: string
  Name of the event to unbind.
- Optionalcallback: HandleEventCallback
  Function to be unbound.
- Optionalscope: any
  Scope that was used as the this when the event is fired.
Returns EventHandler
Self for chaining.
Example
```
const handler = () => {};
obj.on('test', handler);

obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this
```
Inherited from EventHandler.off
- Defined in core/event-handler.js:154

on

on(name: string, callback: HandleEventCallback, scope?: any): EventHandle
Attach an event handler to an event.
Parameters
- name: string
  Name of the event to bind the callback to.
- callback: HandleEventCallback
  Function that is called when event is fired. Note the callback is limited to 8 arguments.
- Optionalscope: any = ...
  Object to use as 'this' when the event is fired, defaults to current this.
Returns EventHandle
Can be used for removing event in the future.
Example
```
obj.on('test', (a, b) => {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
```
Example
```
const evt = obj.on('test', (a, b) => {
    console.log(a + b);
});
// some time later
evt.off();
```
Inherited from EventHandler.on
- Defined in core/event-handler.js:112

once

once(name: string, callback: HandleEventCallback, scope?: any): EventHandle
Attach an event handler to an event. This handler will be removed after being fired once.
Parameters
- name: string
  Name of the event to bind the callback to.
- callback: HandleEventCallback
  Function that is called when event is fired. Note the callback is limited to 8 arguments.
- Optionalscope: any = ...
  Object to use as 'this' when the event is fired, defaults to current this.
Returns EventHandle
- can be used for removing event in the future.
Example
```
obj.once('test', (a, b) => {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled
```
Inherited from EventHandler.once
- Defined in core/event-handler.js:132

remove

remove(): void
Remove graph node from current parent.

Returns void
- Defined in scene/graph-node.js:971

removeChild

removeChild(child: GraphNode): void
Remove the node from the child list and update the parent value of the child.
Parameters
- child: GraphNode
  The node to remove.
Returns void
Example
```
const child = this.entity.children[0];
this.entity.removeChild(child);
```
- Defined in scene/graph-node.js:1496

reparent

reparent(parent: GraphNode, index?: number): void
Remove graph node from current parent and add as child to new parent.
Parameters
- parent: GraphNode
  New parent to attach graph node to.
- Optionalindex: number
  The child index where the child node should be placed.
Returns void
- Defined in scene/graph-node.js:981

rotate

rotate(x: number, y: number, z: number): void
Rotates the graph node in world space by the specified Euler angles. Eulers are specified in degrees in XYZ order.
Parameters
- x: number
  Rotation around world space x-axis in degrees.
- y: number
  Rotation around world space y-axis in degrees.
- z: number
  Rotation around world space z-axis in degrees.
Returns void
Example
```
this.entity.rotate(0, 90, 0);
```
- Defined in scene/graph-node.js:1753
rotate(rotation: Vec3): void
Rotates the graph node in world space by the specified Euler angles. Eulers are specified in degrees in XYZ order.
Parameters
- rotation: Vec3
  Vector holding world space rotation.
Returns void
Example
```
const rotation = new pc.Vec3(0, 90, 0);
this.entity.rotate(rotation);
```
- Defined in scene/graph-node.js:1765

rotateLocal

rotateLocal(x: number, y: number, z: number): void
Rotates the graph node in local space by the specified Euler angles. Eulers are specified in degrees in XYZ order.
Parameters
- x: number
  Rotation around local space x-axis in degrees.
- y: number
  Rotation around local space y-axis in degrees.
- z: number
  Rotation around local space z-axis in degrees.
Returns void
Example
```
this.entity.rotateLocal(0, 90, 0);
```
- Defined in scene/graph-node.js:1800
rotateLocal(rotation: Vec3): void
Rotates the graph node in local space by the specified Euler angles. Eulers are specified in degrees in XYZ order.
Parameters
- rotation: Vec3
  Vector holding local space rotation.
Returns void
Example
```
const rotation = new pc.Vec3(0, 90, 0);
this.entity.rotateLocal(rotation);
```
- Defined in scene/graph-node.js:1812

setEulerAngles

setEulerAngles(x: number, y: number, z: number): void
Sets the world space rotation of the specified graph node using Euler angles. Eulers are interpreted in XYZ order.
Parameters
- x: number
  Rotation around world space x-axis in degrees.
- y: number
  Rotation around world space y-axis in degrees.
- z: number
  Rotation around world space z-axis in degrees.
Returns void
Example
```
this.entity.setEulerAngles(0, 90, 0);
```
- Defined in scene/graph-node.js:1313
setEulerAngles(angles: Vec3): void
Sets the world space rotation of the specified graph node using Euler angles. Eulers are interpreted in XYZ order.
Parameters
- angles: Vec3
  Vector holding rotations around world space axes in degrees.
Returns void
Example
```
const angles = new pc.Vec3(0, 90, 0);
this.entity.setEulerAngles(angles);
```
- Defined in scene/graph-node.js:1325

setLocalEulerAngles

setLocalEulerAngles(x: number, y: number, z: number): void
Sets the local space rotation of the specified graph node using Euler angles. Eulers are interpreted in XYZ order.
Parameters
- x: number
  Rotation around local space x-axis in degrees.
- y: number
  Rotation around local space y-axis in degrees.
- z: number
  Rotation around local space z-axis in degrees.
Returns void
Example
```
// Set rotation of 90 degrees around y-axis via 3 numbers
this.entity.setLocalEulerAngles(0, 90, 0);
```
- Defined in scene/graph-node.js:996
setLocalEulerAngles(angles: Vec3): void
Sets the local space rotation of the specified graph node using Euler angles. Eulers are interpreted in XYZ order.
Parameters
- angles: Vec3
  Vector holding rotations around local space axes in degrees.
Returns void
Example
```
// Set rotation of 90 degrees around y-axis via a vector
const angles = new pc.Vec3(0, 90, 0);
this.entity.setLocalEulerAngles(angles);
```
- Defined in scene/graph-node.js:1009

setLocalPosition

setLocalPosition(x: number, y: number, z: number): void
Sets the local space position of the specified graph node.
Parameters
- x: number
  X-coordinate of local space position.
- y: number
  Y-coordinate of local space position.
- z: number
  Z-coordinate of local space position.
Returns void
Example
```
this.entity.setLocalPosition(0, 10, 0);
```
- Defined in scene/graph-node.js:1033
setLocalPosition(position: Vec3): void
Sets the local space position of the specified graph node.
Parameters
- position: Vec3
  Vector holding local space position.
Returns void
Example
```
const pos = new pc.Vec3(0, 10, 0);
this.entity.setLocalPosition(pos);
```
- Defined in scene/graph-node.js:1044

setLocalRotation

setLocalRotation(x: number, y: number, z: number, w: number): void
Sets the local space rotation of the specified graph node.
Parameters
- x: number
  X-component of local space quaternion rotation.
- y: number
  Y-component of local space quaternion rotation.
- z: number
  Z-component of local space quaternion rotation.
- w: number
  W-component of local space quaternion rotation.
Returns void
Example
```
this.entity.setLocalRotation(0, 0, 0, 1);
```
- Defined in scene/graph-node.js:1071
setLocalRotation(rotation: Quat): void
Sets the local space rotation of the specified graph node.
Parameters
- rotation: Quat
  Quaternion holding local space rotation.
Returns void
Example
```
const q = new pc.Quat();
this.entity.setLocalRotation(q);
```
- Defined in scene/graph-node.js:1083

setLocalScale

setLocalScale(x: number, y: number, z: number): void
Sets the local space scale factor of the specified graph node.
Parameters
- x: number
  X-coordinate of local space scale.
- y: number
  Y-coordinate of local space scale.
- z: number
  Z-coordinate of local space scale.
Returns void
Example
```
this.entity.setLocalScale(10, 10, 10);
```
- Defined in scene/graph-node.js:1111
setLocalScale(scale: Vec3): void
Sets the local space scale factor of the specified graph node.
Parameters
- scale: Vec3
  Vector holding local space scale.
Returns void
Example
```
const scale = new pc.Vec3(10, 10, 10);
this.entity.setLocalScale(scale);
```
- Defined in scene/graph-node.js:1122

setPosition

setPosition(x: number, y: number, z: number): void
Sets the world space position of the specified graph node.
Parameters
- x: number
  X-coordinate of world space position.
- y: number
  Y-coordinate of world space position.
- z: number
  Z-coordinate of world space position.
Returns void
Example
```
this.entity.setPosition(0, 10, 0);
```
- Defined in scene/graph-node.js:1192
setPosition(position: Vec3): void
Sets the world space position of the specified graph node.
Parameters
- position: Vec3
  Vector holding world space position.
Returns void
Example
```
const position = new pc.Vec3(0, 10, 0);
this.entity.setPosition(position);
```
- Defined in scene/graph-node.js:1203

setPositionAndRotation

setPositionAndRotation(position: Vec3, rotation: Quat): void
Sets the world space position and rotation of the specified graph node. This is faster than setting the position and rotation independently.
Parameters
- position: Vec3
  The world space position to set.
- rotation: Quat
  The world space rotation to set.
Returns void
Example
```
const position = new pc.Vec3(0, 10, 0);
const rotation = new pc.Quat().setFromEulerAngles(0, 90, 0);
this.entity.setPositionAndRotation(position, rotation);
```
- Defined in scene/graph-node.js:1293

setRotation

setRotation(x: number, y: number, z: number, w: number): void
Sets the world space rotation of the specified graph node.
Parameters
- x: number
  X-component of world space quaternion rotation.
- y: number
  Y-component of world space quaternion rotation.
- z: number
  Z-component of world space quaternion rotation.
- w: number
  W-component of world space quaternion rotation.
Returns void
Example
```
this.entity.setRotation(0, 0, 0, 1);
```
- Defined in scene/graph-node.js:1237
setRotation(rotation: Quat): void
Sets the world space rotation of the specified graph node.
Parameters
- rotation: Quat
  Quaternion holding world space rotation.
Returns void
Example
```
const rotation = new pc.Quat();
this.entity.setRotation(rotation);
```
- Defined in scene/graph-node.js:1249

translate

translate(x: number, y: number, z: number): void
Translates the graph node in world space by the specified translation vector.
Parameters
- x: number
  X-coordinate of world space translation.
- y: number
  Y-coordinate of world space translation.
- z: number
  Z-coordinate of world space translation.
Returns void
Example
```
this.entity.translate(10, 0, 0);
```
- Defined in scene/graph-node.js:1674
translate(translation: Vec3): void
Translates the graph node in world space by the specified translation vector.
Parameters
- translation: Vec3
  Vector holding world space translation.
Returns void
Example
```
const translation = new pc.Vec3(10, 0, 0);
this.entity.translate(translation);
```
- Defined in scene/graph-node.js:1685

translateLocal

translateLocal(x: number, y: number, z: number): void
Translates the graph node in local space by the specified translation vector.
Parameters
- x: number
  X-coordinate of local space translation.
- y: number
  Y-coordinate of local space translation.
- z: number
  Z-coordinate of local space translation.
Returns void
Example
```
this.entity.translateLocal(10, 0, 0);
```
- Defined in scene/graph-node.js:1711
translateLocal(translation: Vec3): void
Translates the graph node in local space by the specified translation vector.
Parameters
- translation: Vec3
  Vector holding local space translation.
Returns void
Example
```
const t = new pc.Vec3(10, 0, 0);
this.entity.translateLocal(t);
```
- Defined in scene/graph-node.js:1722

Class GraphNode

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GraphNode

Properties

Protected_children

name

tags

Accessors

children

Returns GraphNode[]

enabled

Returns boolean

Parameters

Returns void

forward

Returns Vec3

graphDepth

Returns number

parent

Returns null | GraphNode

path

Returns string

right

Returns Vec3

root

Returns GraphNode

up

Returns Vec3

Methods

Protected_notifyHierarchyStateChanged

Parameters

Returns void

Protected_onHierarchyStateChanged

Parameters

Returns void

addChild

Parameters

Returns void

Example

clone

Returns GraphNode

destroy

Returns void

Example

find

Parameters

Returns GraphNode[]

Example

Example

findByName

Parameters

Returns null | GraphNode

findByPath

Parameters

Returns null | GraphNode

Example

Example

findByTag

Parameters

Returns GraphNode[]

Example

Example

Example

Example

findOne

Parameters

Returns null | GraphNode

Example

Example

fire

Parameters

Returns EventHandler

`Protected`_children

`Protected`_notifyHierarchyStateChanged

`Protected`_onHierarchyStateChanged