Class Entity

name

tags

children

• get children(): GraphNode[]

• Gets the children of this graph node.

  Returns GraphNode[]

enabled

• get enabled(): boolean

• Gets the enabled state of the GraphNode.

  Returns boolean
• set enabled(enabled): 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

forward

• get forward(): Vec3

• Gets the normalized local space negative Z-axis vector of the graph node in world space.

  Returns Vec3

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

parent

• get parent(): GraphNode

• Gets the parent of this graph node.

  Returns GraphNode

path

• get path(): string

• Gets the path of this graph node relative to the root of the hierarchy.

  Returns string

right

• get right(): Vec3

• Gets the normalized local space X-axis vector of the graph node in world space.

  Returns Vec3

root

• get root(): GraphNode

• Gets the oldest ancestor graph node from this graph node.

  Returns GraphNode

up

• get up(): Vec3

• Gets the normalized local space Y-axis vector of the graph node in world space.

  Returns Vec3

addChild

• addChild(node): 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);
  Copy

find

• find(attr, value?): 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;
  });
  Copy

  Example

  // Finds all nodes that have the name property set to 'Test'
  const entities = parent.find('name', 'Test');
  Copy

findByName

• findByName(name): 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 GraphNode

  The first node to be found matching the supplied name. Returns null if no node is found.

findByPath

• findByPath(path): 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 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');
  Copy

  Example

  // Array form
  const grandchild = this.entity.findByPath(['child', 'grandchild']);
  Copy

findByTag

• findByTag(...args): 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

  • Rest...args: any

  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");
  Copy

  Example

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

  Example

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

  Example

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

findOne

• findOne(attr, value?): 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 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';
  });
  Copy

  Example

  // Finds the first node that has the name property set to 'Test'
  const node = parent.findOne('name', 'Test');
  Copy

fire

• fire(name, arg1?, arg2?, arg3?, arg4?, arg5?, arg6?, arg7?, arg8?): 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');
  Copy

forEach

• forEach(callback, thisArg?): 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: object

    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);
  });
  Copy

getEulerAngles

• getEulerAngles(): Vec3

• Get the world space rotation for the specified GraphNode in Euler angle form. The rotation is returned as euler angles in a Vec3. The value returned by this function should be considered read-only. In order to set the world space rotation of the graph node, use GraphNode#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);
  Copy

getLocalEulerAngles

• getLocalEulerAngles(): Vec3

• Get the rotation in local space for the specified GraphNode. The rotation is returned as euler angles in a Vec3. The returned vector should be considered read-only. To update the local rotation, use GraphNode#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);
  Copy

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 GraphNode#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);
  Copy

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 GraphNode#setLocalRotation.

  Returns Quat

  The local space rotation of the graph node as a quaternion.

  Example

  const rotation = this.entity.getLocalRotation();
  Copy

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 GraphNode#setLocalScale.

  Returns Vec3

  The local space scale of the graph node.

  Example

  const scale = this.entity.getLocalScale();
  scale.x = 100;
  this.entity.setLocalScale(scale);
  Copy

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();
  Copy

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 GraphNode#setPosition.

  Returns Vec3

  The world space position of the graph node.

  Example

  const position = this.entity.getPosition();
  position.x = 10;
  this.entity.setPosition(position);
  Copy

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 GraphNode#setRotation.

  Returns Quat

  The world space rotation of the graph node as a quaternion.

  Example

  const rotation = this.entity.getRotation();
  Copy

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();
  Copy

hasEvent

• hasEvent(name): 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', function () { }); // bind an event to 'test'
  obj.hasEvent('test'); // returns true
  obj.hasEvent('hello'); // returns false
  Copy

insertChild

• insertChild(node, index): 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);
  Copy

isAncestorOf

• isAncestorOf(node): 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
  }
  Copy

isDescendantOf

• isDescendantOf(node): 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
  }
  Copy

lookAt

• lookAt(x, y?, z?, ux?, uy?, uz?): void

• Reorients the graph node so that the negative z-axis points towards the target. This function has two valid signatures. Either pass 3D vectors for the look at coordinate and up vector, or pass numbers to represent the vectors.

  Parameters

  • x: number | Vec3

    If passing a 3D vector, this is the world space coordinate to look at. Otherwise, it is the x-component of the world space coordinate to look at.
  • Optionaly: number | Vec3

    If passing a 3D vector, this is the world space up vector for look at transform. Otherwise, it is the y-component of the world space coordinate to look at.
  • Optionalz: number

    Z-component of the world space coordinate to look at.
  • Optionalux: number = 0

    X-component of the up vector for the look at transform. Defaults to 0.
  • Optionaluy: number = 1

    Y-component of the up vector for the look at transform. Defaults to 1.
  • Optionaluz: number = 0

    Z-component of the up vector for the look at transform. Defaults to 0.

  Returns void

  Example

  // Look at another entity, using the (default) positive y-axis for up
  const position = otherEntity.getPosition();
  this.entity.lookAt(position);
  Copy

  Example

  // Look at another entity, using the negative world y-axis for up
  const position = otherEntity.getPosition();
  this.entity.lookAt(position, pc.Vec3.DOWN);
  Copy

  Example

  // Look at the world space origin, using the (default) positive y-axis for up
  this.entity.lookAt(0, 0, 0);
  Copy

  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);
  Copy

off

• off(name?, callback?, scope?): 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: object

    Scope that was used as the this when the event is fired.

  Returns EventHandler

  Self for chaining.

  Example

  const handler = function () {
  };
  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
  Copy

on

• on(name, callback, scope?): 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: object = ...

    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', function (a, b) {
      console.log(a + b);
  });
  obj.fire('test', 1, 2); // prints 3 to the console
  Copy

  Example

  const evt = obj.on('test', function (a, b) {
      console.log(a + b);
  });
  // some time later
  evt.off();
  Copy

once

• once(name, callback, scope?): 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: object = ...

    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', function (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
  Copy

remove

• remove(): void

• Remove graph node from current parent.

  Returns void

removeChild

• removeChild(child): 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);
  Copy

reparent

• reparent(parent, index?): 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

rotate

• rotate(x, y?, z?): void

• Rotates the graph node in world space by the specified Euler angles. Eulers are specified in degrees in XYZ order. This function has two valid signatures: you can either pass a 3D vector or 3 numbers to specify the world space rotation.

  Parameters

  • x: number | Vec3

    3-dimensional vector holding world space rotation or rotation around world space x-axis in degrees.
  • Optionaly: number

    Rotation around world space y-axis in degrees.
  • Optionalz: number

    Rotation around world space z-axis in degrees.

  Returns void

  Example

  // Rotate via 3 numbers
  this.entity.rotate(0, 90, 0);
  Copy

  Example

  // Rotate via vector
  const r = new pc.Vec3(0, 90, 0);
  this.entity.rotate(r);
  Copy

rotateLocal

• rotateLocal(x, y?, z?): void

• Rotates the graph node in local space by the specified Euler angles. Eulers are specified in degrees in XYZ order. This function has two valid signatures: you can either pass a 3D vector or 3 numbers to specify the local space rotation.

  Parameters

  • x: number | Vec3

    3-dimensional vector holding local space rotation or rotation around local space x-axis in degrees.
  • Optionaly: number

    Rotation around local space y-axis in degrees.
  • Optionalz: number

    Rotation around local space z-axis in degrees.

  Returns void

  Example

  // Rotate via 3 numbers
  this.entity.rotateLocal(0, 90, 0);
  Copy

  Example

  // Rotate via vector
  const r = new pc.Vec3(0, 90, 0);
  this.entity.rotateLocal(r);
  Copy

setEulerAngles

• setEulerAngles(x, y?, z?): void

• Sets the world space rotation of the specified graph node using euler angles. Eulers are interpreted in XYZ order. Eulers must be specified in degrees. This function has two valid signatures: you can either pass a 3D vector or 3 numbers to specify the world space euler rotation.

  Parameters

  • x: number | Vec3

    3-dimensional vector holding eulers or rotation around world space x-axis in degrees.
  • Optionaly: number

    Rotation around world space y-axis in degrees.
  • Optionalz: number

    Rotation around world space z-axis in degrees.

  Returns void

  Example

  // Set rotation of 90 degrees around world space y-axis via 3 numbers
  this.entity.setEulerAngles(0, 90, 0);
  Copy

  Example

  // Set rotation of 90 degrees around world space y-axis via a vector
  const angles = new pc.Vec3(0, 90, 0);
  this.entity.setEulerAngles(angles);
  Copy

setLocalEulerAngles

• setLocalEulerAngles(x, y?, z?): void

• Sets the local space rotation of the specified graph node using euler angles. Eulers are interpreted in XYZ order. Eulers must be specified in degrees. This function has two valid signatures: you can either pass a 3D vector or 3 numbers to specify the local space euler rotation.

  Parameters

  • x: number | Vec3

    3-dimensional vector holding eulers or rotation around local space x-axis in degrees.
  • Optionaly: number

    Rotation around local space y-axis in degrees.
  • Optionalz: 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);
  Copy

  Example

  // Set rotation of 90 degrees around y-axis via a vector
  const angles = new pc.Vec3(0, 90, 0);
  this.entity.setLocalEulerAngles(angles);
  Copy

setLocalPosition

• setLocalPosition(x, y?, z?): void

• Sets the local space position of the specified graph node. This function has two valid signatures: you can either pass a 3D vector or 3 numbers to specify the local space position.

  Parameters

  • x: number | Vec3

    3-dimensional vector holding local space position or x-coordinate of local space position.
  • Optionaly: number

    Y-coordinate of local space position.
  • Optionalz: number

    Z-coordinate of local space position.

  Returns void

  Example

  // Set via 3 numbers
  this.entity.setLocalPosition(0, 10, 0);
  Copy

  Example

  // Set via vector
  const pos = new pc.Vec3(0, 10, 0);
  this.entity.setLocalPosition(pos);
  Copy

setLocalRotation

• setLocalRotation(x, y?, z?, w?): void

• Sets the local space rotation of the specified graph node. This function has two valid signatures: you can either pass a quaternion or 3 numbers to specify the local space rotation.

  Parameters

  • x: number | Quat

    Quaternion holding local space rotation or x-component of local space quaternion rotation.
  • Optionaly: number

    Y-component of local space quaternion rotation.
  • Optionalz: number

    Z-component of local space quaternion rotation.
  • Optionalw: number

    W-component of local space quaternion rotation.

  Returns void

  Example

  // Set via 4 numbers
  this.entity.setLocalRotation(0, 0, 0, 1);
  Copy

  Example

  // Set via quaternion
  const q = pc.Quat();
  this.entity.setLocalRotation(q);
  Copy

setLocalScale

• setLocalScale(x, y?, z?): void

• Sets the local space scale factor of the specified graph node. This function has two valid signatures: you can either pass a 3D vector or 3 numbers to specify the local space scale.

  Parameters

  • x: number | Vec3

    3-dimensional vector holding local space scale or x-coordinate of local space scale.
  • Optionaly: number

    Y-coordinate of local space scale.
  • Optionalz: number

    Z-coordinate of local space scale.

  Returns void

  Example

  // Set via 3 numbers
  this.entity.setLocalScale(10, 10, 10);
  Copy

  Example

  // Set via vector
  const scale = new pc.Vec3(10, 10, 10);
  this.entity.setLocalScale(scale);
  Copy

setPosition

• setPosition(x, y?, z?): void

• Sets the world space position of the specified graph node. This function has two valid signatures: you can either pass a 3D vector or 3 numbers to specify the world space position.

  Parameters

  • x: number | Vec3

    3-dimensional vector holding world space position or x-coordinate of world space position.
  • Optionaly: number

    Y-coordinate of world space position.
  • Optionalz: number

    Z-coordinate of world space position.

  Returns void

  Example

  // Set via 3 numbers
  this.entity.setPosition(0, 10, 0);
  Copy

  Example

  // Set via vector
  const position = new pc.Vec3(0, 10, 0);
  this.entity.setPosition(position);
  Copy

setRotation

• setRotation(x, y?, z?, w?): void

• Sets the world space rotation of the specified graph node. This function has two valid signatures: you can either pass a quaternion or 3 numbers to specify the world space rotation.

  Parameters

  • x: number | Quat

    Quaternion holding world space rotation or x-component of world space quaternion rotation.
  • Optionaly: number

    Y-component of world space quaternion rotation.
  • Optionalz: number

    Z-component of world space quaternion rotation.
  • Optionalw: number

    W-component of world space quaternion rotation.

  Returns void

  Example

  // Set via 4 numbers
  this.entity.setRotation(0, 0, 0, 1);
  Copy

  Example

  // Set via quaternion
  const q = pc.Quat();
  this.entity.setRotation(q);
  Copy

translate

• translate(x, y?, z?): void

• Translates the graph node in world space by the specified translation vector. This function has two valid signatures: you can either pass a 3D vector or 3 numbers to specify the world space translation.

  Parameters

  • x: number | Vec3

    3-dimensional vector holding world space translation or x-coordinate of world space translation.
  • Optionaly: number

    Y-coordinate of world space translation.
  • Optionalz: number

    Z-coordinate of world space translation.

  Returns void

  Example

  // Translate via 3 numbers
  this.entity.translate(10, 0, 0);
  Copy

  Example

  // Translate via vector
  const t = new pc.Vec3(10, 0, 0);
  this.entity.translate(t);
  Copy

translateLocal

• translateLocal(x, y?, z?): void

• Translates the graph node in local space by the specified translation vector. This function has two valid signatures: you can either pass a 3D vector or 3 numbers to specify the local space translation.

  Parameters

  • x: number | Vec3

    3-dimensional vector holding local space translation or x-coordinate of local space translation.
  • Optionaly: number

    Y-coordinate of local space translation.
  • Optionalz: number

    Z-coordinate of local space translation.

  Returns void

  Example

  // Translate via 3 numbers
  this.entity.translateLocal(10, 0, 0);
  Copy

  Example

  // Translate via vector
  const t = new pc.Vec3(10, 0, 0);
  this.entity.translateLocal(t);
  Copy