@aidinabedi/playcanvas
Version:
PlayCanvas WebGL game engine
824 lines (765 loc) • 96.3 kB
HTML
<!doctype html>
<html lang="en">
<head>
<title>pc.Entity | PlayCanvas API Reference</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="icon" type="image/png" href="images/playcanvas-favicon.png">
<link href="styles/styles.css" rel="stylesheet">
<link href="styles/playcanvas-theme.css" rel="stylesheet">
<script src="scripts/interface.js"></script>
<script src="scripts/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body>
<header>
<nav class="header-width">
<a href="/" class="header-title"><img src="images/playcanvas-manual.png"></a>
<ul class="header-menu">
<li class="user-manual"><a href="https://developer.playcanvas.com/en/user-manual/">User Manual</a></li>
<li class="tutorials"><a href="https://developer.playcanvas.com/en/tutorials">Tutorials</a></li>
<li class="forum"><a href="https://forum.playcanvas.com/" target="_blank">Forum</a></li>
<li class="api active"><a href="/api/">API Reference</a></li>
</ul>
</nav>
<div class="header-content header-page header-width">
<h1><span class="font-icon"></span>API Reference</h1>
<input id="search" class="search" type="text" placeholder="Search"></input>
</div>
</header>
<div class="container content-width">
<nav class="sidebar">
<div class="sidebarFilter">
<input id="filter-input" type="text" placeholder="Filter">
</div>
<ul>
<li id="nav-pc"><a href="pc.html">pc</a></li>
<li id="nav-pc.callbacks"><a href="pc.callbacks.html">pc.callbacks</a></li>
<li id="nav-pc.guid"><a href="pc.guid.html">pc.guid</a></li>
<li id="nav-pc.math"><a href="pc.math.html">pc.math</a></li>
<li id="nav-pc.path"><a href="pc.path.html">pc.path</a></li>
<li id="nav-pc.platform"><a href="pc.platform.html">pc.platform</a></li>
<li id="nav-pc.script"><a href="pc.script.html">pc.script</a></li>
<li id="nav-pc.string"><a href="pc.string.html">pc.string</a></li>
<li id="nav-pc.Animation"><a href="pc.Animation.html">Animation</a></li>
<li id="nav-pc.AnimationComponent"><a href="pc.AnimationComponent.html">AnimationComponent</a></li>
<li id="nav-pc.AnimationComponentSystem"><a href="pc.AnimationComponentSystem.html">AnimationComponentSystem</a></li>
<li id="nav-pc.AnimationHandler"><a href="pc.AnimationHandler.html">AnimationHandler</a></li>
<li id="nav-pc.AnimCache"><a href="pc.AnimCache.html">AnimCache</a></li>
<li id="nav-pc.AnimClip"><a href="pc.AnimClip.html">AnimClip</a></li>
<li id="nav-pc.AnimController"><a href="pc.AnimController.html">AnimController</a></li>
<li id="nav-pc.AnimCurve"><a href="pc.AnimCurve.html">AnimCurve</a></li>
<li id="nav-pc.AnimData"><a href="pc.AnimData.html">AnimData</a></li>
<li id="nav-pc.AnimSnapshot"><a href="pc.AnimSnapshot.html">AnimSnapshot</a></li>
<li id="nav-pc.AnimTarget"><a href="pc.AnimTarget.html">AnimTarget</a></li>
<li id="nav-pc.AnimTrack"><a href="pc.AnimTrack.html">AnimTrack</a></li>
<li id="nav-pc.Application"><a href="pc.Application.html">Application</a></li>
<li id="nav-pc.Asset"><a href="pc.Asset.html">Asset</a></li>
<li id="nav-pc.AssetReference"><a href="pc.AssetReference.html">AssetReference</a></li>
<li id="nav-pc.AssetRegistry"><a href="pc.AssetRegistry.html">AssetRegistry</a></li>
<li id="nav-pc.AudioHandler"><a href="pc.AudioHandler.html">AudioHandler</a></li>
<li id="nav-pc.AudioListenerComponent"><a href="pc.AudioListenerComponent.html">AudioListenerComponent</a></li>
<li id="nav-pc.AudioListenerComponentSystem"><a href="pc.AudioListenerComponentSystem.html">AudioListenerComponentSystem</a></li>
<li id="nav-pc.BasicMaterial"><a href="pc.BasicMaterial.html">BasicMaterial</a></li>
<li id="nav-pc.Batch"><a href="pc.Batch.html">Batch</a></li>
<li id="nav-pc.BatchGroup"><a href="pc.BatchGroup.html">BatchGroup</a></li>
<li id="nav-pc.BatchManager"><a href="pc.BatchManager.html">BatchManager</a></li>
<li id="nav-pc.BoundingBox"><a href="pc.BoundingBox.html">BoundingBox</a></li>
<li id="nav-pc.BoundingSphere"><a href="pc.BoundingSphere.html">BoundingSphere</a></li>
<li id="nav-pc.ButtonComponent"><a href="pc.ButtonComponent.html">ButtonComponent</a></li>
<li id="nav-pc.ButtonComponentSystem"><a href="pc.ButtonComponentSystem.html">ButtonComponentSystem</a></li>
<li id="nav-pc.CameraComponent"><a href="pc.CameraComponent.html">CameraComponent</a></li>
<li id="nav-pc.CameraComponentSystem"><a href="pc.CameraComponentSystem.html">CameraComponentSystem</a></li>
<li id="nav-pc.CollisionComponent"><a href="pc.CollisionComponent.html">CollisionComponent</a></li>
<li id="nav-pc.CollisionComponentSystem"><a href="pc.CollisionComponentSystem.html">CollisionComponentSystem</a></li>
<li id="nav-pc.Color"><a href="pc.Color.html">Color</a></li>
<li id="nav-pc.Component"><a href="pc.Component.html">Component</a></li>
<li id="nav-pc.ComponentSystem"><a href="pc.ComponentSystem.html">ComponentSystem</a></li>
<li id="nav-pc.ComponentSystemRegistry"><a href="pc.ComponentSystemRegistry.html">ComponentSystemRegistry</a></li>
<li id="nav-pc.ContactPoint"><a href="pc.ContactPoint.html">ContactPoint</a></li>
<li id="nav-pc.ContactResult"><a href="pc.ContactResult.html">ContactResult</a></li>
<li id="nav-pc.ContainerHandler"><a href="pc.ContainerHandler.html">ContainerHandler</a></li>
<li id="nav-pc.ContainerResource"><a href="pc.ContainerResource.html">ContainerResource</a></li>
<li id="nav-pc.Controller"><a href="pc.Controller.html">Controller</a></li>
<li id="nav-pc.CubemapHandler"><a href="pc.CubemapHandler.html">CubemapHandler</a></li>
<li id="nav-pc.Curve"><a href="pc.Curve.html">Curve</a></li>
<li id="nav-pc.CurveSet"><a href="pc.CurveSet.html">CurveSet</a></li>
<li id="nav-pc.ElementComponent"><a href="pc.ElementComponent.html">ElementComponent</a></li>
<li id="nav-pc.ElementComponentSystem"><a href="pc.ElementComponentSystem.html">ElementComponentSystem</a></li>
<li id="nav-pc.ElementDragHelper"><a href="pc.ElementDragHelper.html">ElementDragHelper</a></li>
<li id="nav-pc.ElementInput"><a href="pc.ElementInput.html">ElementInput</a></li>
<li id="nav-pc.ElementInputEvent"><a href="pc.ElementInputEvent.html">ElementInputEvent</a></li>
<li id="nav-pc.ElementMouseEvent"><a href="pc.ElementMouseEvent.html">ElementMouseEvent</a></li>
<li id="nav-pc.ElementTouchEvent"><a href="pc.ElementTouchEvent.html">ElementTouchEvent</a></li>
<li id="nav-pc.Entity"><a href="pc.Entity.html">Entity</a></li>
<li id="nav-pc.EventHandler"><a href="pc.EventHandler.html">EventHandler</a></li>
<li id="nav-pc.Font"><a href="pc.Font.html">Font</a></li>
<li id="nav-pc.FontHandler"><a href="pc.FontHandler.html">FontHandler</a></li>
<li id="nav-pc.ForwardRenderer"><a href="pc.ForwardRenderer.html">ForwardRenderer</a></li>
<li id="nav-pc.Frustum"><a href="pc.Frustum.html">Frustum</a></li>
<li id="nav-pc.GamePads"><a href="pc.GamePads.html">GamePads</a></li>
<li id="nav-pc.GraphicsDevice"><a href="pc.GraphicsDevice.html">GraphicsDevice</a></li>
<li id="nav-pc.GraphNode"><a href="pc.GraphNode.html">GraphNode</a></li>
<li id="nav-pc.Http"><a href="pc.Http.html">Http</a></li>
<li id="nav-pc.I18n"><a href="pc.I18n.html">I18n</a></li>
<li id="nav-pc.IndexBuffer"><a href="pc.IndexBuffer.html">IndexBuffer</a></li>
<li id="nav-pc.Keyboard"><a href="pc.Keyboard.html">Keyboard</a></li>
<li id="nav-pc.KeyboardEvent"><a href="pc.KeyboardEvent.html">KeyboardEvent</a></li>
<li id="nav-pc.Layer"><a href="pc.Layer.html">Layer</a></li>
<li id="nav-pc.LayerComposition"><a href="pc.LayerComposition.html">LayerComposition</a></li>
<li id="nav-pc.LayoutChildComponent"><a href="pc.LayoutChildComponent.html">LayoutChildComponent</a></li>
<li id="nav-pc.LayoutChildComponentSystem"><a href="pc.LayoutChildComponentSystem.html">LayoutChildComponentSystem</a></li>
<li id="nav-pc.LayoutGroupComponent"><a href="pc.LayoutGroupComponent.html">LayoutGroupComponent</a></li>
<li id="nav-pc.LayoutGroupComponentSystem"><a href="pc.LayoutGroupComponentSystem.html">LayoutGroupComponentSystem</a></li>
<li id="nav-pc.LightComponent"><a href="pc.LightComponent.html">LightComponent</a></li>
<li id="nav-pc.LightComponentSystem"><a href="pc.LightComponentSystem.html">LightComponentSystem</a></li>
<li id="nav-pc.Lightmapper"><a href="pc.Lightmapper.html">Lightmapper</a></li>
<li id="nav-pc.Mat3"><a href="pc.Mat3.html">Mat3</a></li>
<li id="nav-pc.Mat4"><a href="pc.Mat4.html">Mat4</a></li>
<li id="nav-pc.Material"><a href="pc.Material.html">Material</a></li>
<li id="nav-pc.MaterialHandler"><a href="pc.MaterialHandler.html">MaterialHandler</a></li>
<li id="nav-pc.Mesh"><a href="pc.Mesh.html">Mesh</a></li>
<li id="nav-pc.MeshInstance"><a href="pc.MeshInstance.html">MeshInstance</a></li>
<li id="nav-pc.Model"><a href="pc.Model.html">Model</a></li>
<li id="nav-pc.ModelComponent"><a href="pc.ModelComponent.html">ModelComponent</a></li>
<li id="nav-pc.ModelComponentSystem"><a href="pc.ModelComponentSystem.html">ModelComponentSystem</a></li>
<li id="nav-pc.ModelHandler"><a href="pc.ModelHandler.html">ModelHandler</a></li>
<li id="nav-pc.Morph"><a href="pc.Morph.html">Morph</a></li>
<li id="nav-pc.MorphInstance"><a href="pc.MorphInstance.html">MorphInstance</a></li>
<li id="nav-pc.MorphTarget"><a href="pc.MorphTarget.html">MorphTarget</a></li>
<li id="nav-pc.Mouse"><a href="pc.Mouse.html">Mouse</a></li>
<li id="nav-pc.MouseEvent"><a href="pc.MouseEvent.html">MouseEvent</a></li>
<li id="nav-pc.Node"><a href="pc.Node.html">Node</a></li>
<li id="nav-pc.OrientedBox"><a href="pc.OrientedBox.html">OrientedBox</a></li>
<li id="nav-pc.ParticleSystemComponent"><a href="pc.ParticleSystemComponent.html">ParticleSystemComponent</a></li>
<li id="nav-pc.ParticleSystemComponentSystem"><a href="pc.ParticleSystemComponentSystem.html">ParticleSystemComponentSystem</a></li>
<li id="nav-pc.Picker"><a href="pc.Picker.html">Picker</a></li>
<li id="nav-pc.PostEffect"><a href="pc.PostEffect.html">PostEffect</a></li>
<li id="nav-pc.PostEffectQueue"><a href="pc.PostEffectQueue.html">PostEffectQueue</a></li>
<li id="nav-pc.Quat"><a href="pc.Quat.html">Quat</a></li>
<li id="nav-pc.Ray"><a href="pc.Ray.html">Ray</a></li>
<li id="nav-pc.RaycastResult"><a href="pc.RaycastResult.html">RaycastResult</a></li>
<li id="nav-pc.RenderTarget"><a href="pc.RenderTarget.html">RenderTarget</a></li>
<li id="nav-pc.ResourceHandler"><a href="pc.ResourceHandler.html">ResourceHandler</a></li>
<li id="nav-pc.ResourceLoader"><a href="pc.ResourceLoader.html">ResourceLoader</a></li>
<li id="nav-pc.RigidBodyComponent"><a href="pc.RigidBodyComponent.html">RigidBodyComponent</a></li>
<li id="nav-pc.RigidBodyComponentSystem"><a href="pc.RigidBodyComponentSystem.html">RigidBodyComponentSystem</a></li>
<li id="nav-pc.Scene"><a href="pc.Scene.html">Scene</a></li>
<li id="nav-pc.SceneHandler"><a href="pc.SceneHandler.html">SceneHandler</a></li>
<li id="nav-pc.ScopeId"><a href="pc.ScopeId.html">ScopeId</a></li>
<li id="nav-pc.ScopeSpace"><a href="pc.ScopeSpace.html">ScopeSpace</a></li>
<li id="nav-pc.ScreenComponent"><a href="pc.ScreenComponent.html">ScreenComponent</a></li>
<li id="nav-pc.ScreenComponentSystem"><a href="pc.ScreenComponentSystem.html">ScreenComponentSystem</a></li>
<li id="nav-pc.ScriptAttributes"><a href="pc.ScriptAttributes.html">ScriptAttributes</a></li>
<li id="nav-pc.ScriptComponent"><a href="pc.ScriptComponent.html">ScriptComponent</a></li>
<li id="nav-pc.ScriptComponentSystem"><a href="pc.ScriptComponentSystem.html">ScriptComponentSystem</a></li>
<li id="nav-pc.ScriptHandler"><a href="pc.ScriptHandler.html">ScriptHandler</a></li>
<li id="nav-pc.ScriptRegistry"><a href="pc.ScriptRegistry.html">ScriptRegistry</a></li>
<li id="nav-pc.ScriptType"><a href="pc.ScriptType.html">ScriptType</a></li>
<li id="nav-pc.ScrollbarComponent"><a href="pc.ScrollbarComponent.html">ScrollbarComponent</a></li>
<li id="nav-pc.ScrollbarComponentSystem"><a href="pc.ScrollbarComponentSystem.html">ScrollbarComponentSystem</a></li>
<li id="nav-pc.ScrollViewComponent"><a href="pc.ScrollViewComponent.html">ScrollViewComponent</a></li>
<li id="nav-pc.ScrollViewComponentSystem"><a href="pc.ScrollViewComponentSystem.html">ScrollViewComponentSystem</a></li>
<li id="nav-pc.Shader"><a href="pc.Shader.html">Shader</a></li>
<li id="nav-pc.SingleContactResult"><a href="pc.SingleContactResult.html">SingleContactResult</a></li>
<li id="nav-pc.Skeleton"><a href="pc.Skeleton.html">Skeleton</a></li>
<li id="nav-pc.Skin"><a href="pc.Skin.html">Skin</a></li>
<li id="nav-pc.SkinInstance"><a href="pc.SkinInstance.html">SkinInstance</a></li>
<li id="nav-pc.Sound"><a href="pc.Sound.html">Sound</a></li>
<li id="nav-pc.SoundComponent"><a href="pc.SoundComponent.html">SoundComponent</a></li>
<li id="nav-pc.SoundComponentSystem"><a href="pc.SoundComponentSystem.html">SoundComponentSystem</a></li>
<li id="nav-pc.SoundInstance"><a href="pc.SoundInstance.html">SoundInstance</a></li>
<li id="nav-pc.SoundInstance3d"><a href="pc.SoundInstance3d.html">SoundInstance3d</a></li>
<li id="nav-pc.SoundManager"><a href="pc.SoundManager.html">SoundManager</a></li>
<li id="nav-pc.SoundSlot"><a href="pc.SoundSlot.html">SoundSlot</a></li>
<li id="nav-pc.Sprite"><a href="pc.Sprite.html">Sprite</a></li>
<li id="nav-pc.SpriteAnimationClip"><a href="pc.SpriteAnimationClip.html">SpriteAnimationClip</a></li>
<li id="nav-pc.SpriteComponent"><a href="pc.SpriteComponent.html">SpriteComponent</a></li>
<li id="nav-pc.SpriteComponentSystem"><a href="pc.SpriteComponentSystem.html">SpriteComponentSystem</a></li>
<li id="nav-pc.SpriteHandler"><a href="pc.SpriteHandler.html">SpriteHandler</a></li>
<li id="nav-pc.StandardMaterial"><a href="pc.StandardMaterial.html">StandardMaterial</a></li>
<li id="nav-pc.StencilParameters"><a href="pc.StencilParameters.html">StencilParameters</a></li>
<li id="nav-pc.Tags"><a href="pc.Tags.html">Tags</a></li>
<li id="nav-pc.Texture"><a href="pc.Texture.html">Texture</a></li>
<li id="nav-pc.TextureAtlas"><a href="pc.TextureAtlas.html">TextureAtlas</a></li>
<li id="nav-pc.TextureAtlasHandler"><a href="pc.TextureAtlasHandler.html">TextureAtlasHandler</a></li>
<li id="nav-pc.TextureHandler"><a href="pc.TextureHandler.html">TextureHandler</a></li>
<li id="nav-pc.Touch"><a href="pc.Touch.html">Touch</a></li>
<li id="nav-pc.TouchDevice"><a href="pc.TouchDevice.html">TouchDevice</a></li>
<li id="nav-pc.TouchEvent"><a href="pc.TouchEvent.html">TouchEvent</a></li>
<li id="nav-pc.TransformFeedback"><a href="pc.TransformFeedback.html">TransformFeedback</a></li>
<li id="nav-pc.Vec2"><a href="pc.Vec2.html">Vec2</a></li>
<li id="nav-pc.Vec3"><a href="pc.Vec3.html">Vec3</a></li>
<li id="nav-pc.Vec4"><a href="pc.Vec4.html">Vec4</a></li>
<li id="nav-pc.VertexAttributeDescription"><a href="pc.VertexAttributeDescription.html">VertexAttributeDescription</a></li>
<li id="nav-pc.VertexAttributeElement"><a href="pc.VertexAttributeElement.html">VertexAttributeElement</a></li>
<li id="nav-pc.VertexBuffer"><a href="pc.VertexBuffer.html">VertexBuffer</a></li>
<li id="nav-pc.VertexFormat"><a href="pc.VertexFormat.html">VertexFormat</a></li>
<li id="nav-pc.VertexIterator"><a href="pc.VertexIterator.html">VertexIterator</a></li>
<li id="nav-pc.VertexIteratorAccessor"><a href="pc.VertexIteratorAccessor.html">VertexIteratorAccessor</a></li>
<li id="nav-pc.XrInput"><a href="pc.XrInput.html">XrInput</a></li>
<li id="nav-pc.XrInputSource"><a href="pc.XrInputSource.html">XrInputSource</a></li>
<li id="nav-pc.XrManager"><a href="pc.XrManager.html">XrManager</a></li>
</ul>
</nav>
<div class='sidebarToggle'><span></span>Class List</div>
<main class="cls">
<h1>pc.Entity</h1>
<p class="extends">Extends: <a href="pc.GraphNode.html">pc.GraphNode</a></p>
<p><p>The Entity is the core primitive of a PlayCanvas game. Generally speaking an object in your game will consist of an <a href="pc.Entity.html">pc.Entity</a>,
and a set of <a href="pc.Component.html">pc.Component</a>s which are managed by their respective <a href="pc.ComponentSystem.html">pc.ComponentSystem</a>s. One of those components maybe a
<a href="pc.ScriptComponent.html">pc.ScriptComponent</a> which allows you to write custom code to attach to your Entity.</p>
<p>
The Entity uniquely identifies the object and also provides a transform for position and orientation
which it inherits from <a href="pc.GraphNode.html">pc.GraphNode</a> so can be added into the scene graph.
The Component and ComponentSystem provide the logic to give an Entity a specific type of behavior. e.g. the ability to
render a model or play a sound. Components are specific to an instance of an Entity and are attached (e.g. `this.entity.model`)
ComponentSystems allow access to all Entities and Components and are attached to the <a href="pc.Application.html">pc.Application</a>.</p>
<pre><code class="javascript">var entity = new pc.Entity();
// Add a Component to the Entity
entity.addComponent("camera", {
fov: 45,
nearClip: 1,
farClip: 10000
});
// Add the Entity into the scene graph
app.root.addChild(entity);
// Move the entity
entity.translate(10, 0, 0);
// Or translate it by setting it's position directly
var p = entity.getPosition();
entity.setPosition(p.x + 10, p.y, p.z);
// Change the entity's rotation in local space
var e = entity.getLocalEulerAngles();
entity.setLocalEulerAngles(e.x, e.y + 90, e.z);
// Or use rotateLocal
entity.rotateLocal(0, 90, 0);</code></pre>
<!-- summary -->
<h1>Summary</h1>
<!--type definitions-->
<!--static properties-->
<!--static methods-->
<!--properties-->
<h3>Properties</h3>
<table class="properties">
<tr>
<td><a href="#animation">animation</a></td><td><p>Gets the <a href="pc.AnimationComponent.html">pc.AnimationComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#audiolistener">audiolistener</a></td><td><p>Gets the <a href="pc.AudioSourceComponent.html">pc.AudioSourceComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#button">button</a></td><td><p>Gets the <a href="pc.ButtonComponent.html">pc.ButtonComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#camera">camera</a></td><td><p>Gets the <a href="pc.CameraComponent.html">pc.CameraComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#collision">collision</a></td><td><p>Gets the <a href="pc.CollisionComponent.html">pc.CollisionComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#element">element</a></td><td><p>Gets the <a href="pc.ElementComponent.html">pc.ElementComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#layoutchild">layoutchild</a></td><td><p>Gets the <a href="pc.LayoutChildComponent.html">pc.LayoutChildComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#layoutgroup">layoutgroup</a></td><td><p>Gets the <a href="pc.LayoutGroupComponent.html">pc.LayoutGroupComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#light">light</a></td><td><p>Gets the <a href="pc.LightComponent.html">pc.LightComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#model">model</a></td><td><p>Gets the <a href="pc.ModelComponent.html">pc.ModelComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#particlesystem">particlesystem</a></td><td><p>Gets the <a href="pc.ParticleSystemComponent.html">pc.ParticleSystemComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#rigidbody">rigidbody</a></td><td><p>Gets the <a href="pc.RigidBodyComponent.html">pc.RigidBodyComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#screen">screen</a></td><td><p>Gets the <a href="pc.ScreenComponent.html">pc.ScreenComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#script">script</a></td><td><p>Gets the <a href="pc.ScriptComponent.html">pc.ScriptComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#scrollview">scrollview</a></td><td><p>Gets the <a href="pc.ScrollViewComponent.html">pc.ScrollViewComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#sound">sound</a></td><td><p>Gets the <a href="pc.SoundComponent.html">pc.SoundComponent</a> attached to this entity.</td>
</tr>
<tr>
<td><a href="#sprite">sprite</a></td><td><p>Gets the <a href="pc.SpriteComponent.html">pc.SpriteComponent</a> attached to this entity.</td>
</tr>
</table>
<!--methods-->
<h3>Methods</h3>
<table class="properties">
<tr>
<td><a href="#addComponent">addComponent</a></td><td><p>Create a new component and add it to the entity.</td>
</tr>
<tr>
<td><a href="#clone">clone</a></td><td><p>Create a deep copy of the Entity.</td>
</tr>
<tr>
<td><a href="#destroy">destroy</a></td><td><p>Remove all components from the Entity and detach it from the Entity hierarchy.</td>
</tr>
<tr>
<td><a href="#findByGuid">findByGuid</a></td><td><p>Find a descendant of this Entity with the GUID.</td>
</tr>
<tr>
<td><a href="#findComponent">findComponent</a></td><td><p>Search the entity and all of its descendants for the first component of specified type.</td>
</tr>
<tr>
<td><a href="#findComponents">findComponents</a></td><td><p>Search the entity and all of its descendants for all components of specified type.</td>
</tr>
<tr>
<td><a href="#removeComponent">removeComponent</a></td><td><p>Remove a component from the Entity.</td>
</tr>
</table>
<!--events-->
<h3>Events</h3>
<table class="properties">
<tr>
<td><a href="#event:destroy">destroy</a></td><td><p>Fired after the entity is destroyed.</td>
</tr>
</table>
<h2>Inherited</h2>
<!--inherited methods-->
<!--inherited properties-->
<h3>Properties</h3>
<table class="properties">
<tr>
<td><a href="#name">name</a></td><td><p>The non-unique name of a graph node.</td>
</tr>
<tr>
<td><a href="#tags">tags</a></td><td><p>Interface for tagging graph nodes.</td>
</tr>
<tr>
<td><a href="#right">right</a></td><td><p>The normalized local space X-axis vector of the graph node in world space.<span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td><a href="#up">up</a></td><td><p>The normalized local space Y-axis vector of the graph node in world space.<span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td><a href="#forward">forward</a></td><td><p>The normalized local space negative Z-axis vector of the graph node in world space.<span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td><a href="#enabled">enabled</a></td><td><p>Enable or disable a GraphNode.</td>
</tr>
<tr>
<td><a href="#parent">parent</a></td><td><p>A read-only property to get a parent graph node.<span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td><a href="#path">path</a></td><td><p>A read-only property to get the path of the graph node relative to
the root of the hierarchy.<span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td><a href="#root">root</a></td><td><p>A read-only property to get highest graph node from current node.<span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td><a href="#children">children</a></td><td><p>A read-only property to get the children of this graph node.<span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td><a href="#graphDepth">graphDepth</a></td><td><p>A read-only property to get the depth of this child within the graph.<span class='readonly'>[read only]</span></td>
</tr>
</table>
<!--inherited static methods-->
<h3>Methods</h3>
<table class="properties">
<tr>
<td><a href="#addChild">addChild</a></td><td><p>Add a new child to the child list and update the parent value of the child node.</td>
</tr>
<tr>
<td><a href="#find">find</a></td><td><p>Search the graph node and all of its descendants for the nodes that satisfy some search criteria.</td>
</tr>
<tr>
<td><a href="#findByName">findByName</a></td><td><p>Get the first node found in the graph with the name.</td>
</tr>
<tr>
<td><a href="#findByPath">findByPath</a></td><td><p>Get the first node found in the graph by its full path in the graph.</td>
</tr>
<tr>
<td><a href="#findByTag">findByTag</a></td><td><p>Return all graph nodes that satisfy the search query.</td>
</tr>
<tr>
<td><a href="#findOne">findOne</a></td><td><p>Search the graph node and all of its descendants for the first node that satisfies some search criteria.</td>
</tr>
<tr>
<td><a href="#fire">fire</a></td><td><p>Fire an event, all additional arguments are passed on to the event listener.</td>
</tr>
<tr>
<td><a href="#forEach">forEach</a></td><td><p>Executes a provided function once on this graph node and all of its descendants.</td>
</tr>
<tr>
<td><a href="#getEulerAngles">getEulerAngles</a></td><td><p>Get the world space rotation for the specified GraphNode in Euler angle
form.</td>
</tr>
<tr>
<td><a href="#getLocalEulerAngles">getLocalEulerAngles</a></td><td><p>Get the rotation in local space for the specified GraphNode.</td>
</tr>
<tr>
<td><a href="#getLocalPosition">getLocalPosition</a></td><td><p>Get the position in local space for the specified GraphNode.</td>
</tr>
<tr>
<td><a href="#getLocalRotation">getLocalRotation</a></td><td><p>Get the rotation in local space for the specified GraphNode.</td>
</tr>
<tr>
<td><a href="#getLocalScale">getLocalScale</a></td><td><p>Get the scale in local space for the specified GraphNode.</td>
</tr>
<tr>
<td><a href="#getLocalTransform">getLocalTransform</a></td><td><p>Get the local transform matrix for this graph node.</td>
</tr>
<tr>
<td><a href="#getPosition">getPosition</a></td><td><p>Get the world space position for the specified GraphNode.</td>
</tr>
<tr>
<td><a href="#getRotation">getRotation</a></td><td><p>Get the world space rotation for the specified GraphNode in quaternion
form.</td>
</tr>
<tr>
<td><a href="#getWorldTransform">getWorldTransform</a></td><td><p>Get the world transformation matrix for this graph node.</td>
</tr>
<tr>
<td><a href="#hasEvent">hasEvent</a></td><td><p>Test if there are any handlers bound to an event name.</td>
</tr>
<tr>
<td><a href="#insertChild">insertChild</a></td><td><p>Insert a new child to the child list at the specified index and update the parent value of the child node.</td>
</tr>
<tr>
<td><a href="#isAncestorOf">isAncestorOf</a></td><td><p>Check if node is ancestor for another node.</td>
</tr>
<tr>
<td><a href="#isDescendantOf">isDescendantOf</a></td><td><p>Check if node is descendant of another node.</td>
</tr>
<tr>
<td><a href="#lookAt">lookAt</a></td><td><p>Reorients the graph node so that the negative z-axis points towards the target.</td>
</tr>
<tr>
<td><a href="#off">off</a></td><td><p>Detach an event handler from an event.</td>
</tr>
<tr>
<td><a href="#on">on</a></td><td><p>Attach an event handler to an event.</td>
</tr>
<tr>
<td><a href="#once">once</a></td><td><p>Attach an event handler to an event.</td>
</tr>
<tr>
<td><a href="#removeChild">removeChild</a></td><td><p>Remove the node from the child list and update the parent value of the child.</td>
</tr>
<tr>
<td><a href="#reparent">reparent</a></td><td><p>Remove graph node from current parent and add as child to new parent.</td>
</tr>
<tr>
<td><a href="#rotate">rotate</a></td><td><p>Rotates the graph node in world-space by the specified Euler angles.</td>
</tr>
<tr>
<td><a href="#rotateLocal">rotateLocal</a></td><td><p>Rotates the graph node in local-space by the specified Euler angles.</td>
</tr>
<tr>
<td><a href="#setEulerAngles">setEulerAngles</a></td><td><p>Sets the world-space rotation of the specified graph node using euler angles.</td>
</tr>
<tr>
<td><a href="#setLocalEulerAngles">setLocalEulerAngles</a></td><td><p>Sets the local-space rotation of the specified graph node using euler angles.</td>
</tr>
<tr>
<td><a href="#setLocalPosition">setLocalPosition</a></td><td><p>Sets the local-space position of the specified graph node.</td>
</tr>
<tr>
<td><a href="#setLocalRotation">setLocalRotation</a></td><td><p>Sets the local-space rotation of the specified graph node.</td>
</tr>
<tr>
<td><a href="#setLocalScale">setLocalScale</a></td><td><p>Sets the local-space scale factor of the specified graph node.</td>
</tr>
<tr>
<td><a href="#setPosition">setPosition</a></td><td><p>Sets the world-space position of the specified graph node.</td>
</tr>
<tr>
<td><a href="#setRotation">setRotation</a></td><td><p>Sets the world-space rotation of the specified graph node.</td>
</tr>
<tr>
<td><a href="#translate">translate</a></td><td><p>Translates the graph node in world-space by the specified translation vector.</td>
</tr>
<tr>
<td><a href="#translateLocal">translateLocal</a></td><td><p>Translates the graph node in local-space by the specified translation vector.</td>
</tr>
</table>
<!--inherited events-->
<h1>Details</h1>
<!--type definitions-->
<!--static members-->
<!--static methods-->
<h2>Constructor</h2>
<!-- Constructor -->
<div id="Entity">
<h3 class="methodname">Entity([name], [app]) <a class="font-icon" href="#Entity"></a></h3>
<p></p>
<pre><code class="javascript">var entity = new pc.Entity();
// Add a Component to the Entity
entity.addComponent("camera", {
fov: 45,
nearClip: 1,
farClip: 10000
});
// Add the Entity into the scene graph
app.root.addChild(entity);
// Move the entity
entity.translate(10, 0, 0);
// Or translate it by setting it's position directly
var p = entity.getPosition();
entity.setPosition(p.x + 10, p.y, p.z);
// Change the entity's rotation in local space
var e = entity.getLocalEulerAngles();
entity.setLocalEulerAngles(e.x, e.y + 90, e.z);
// Or use rotateLocal
entity.rotateLocal(0, 90, 0);</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>name</td><td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></td><td><p>The non-unique name of the entity, default is "Untitled".</p></td>
</tr>
<tr>
<td>app</td><td><a href="pc.Application.html">pc.Application</a></td><td><p>The application the entity belongs to, default is the current application.</p></td>
</tr>
</table>
</div>
<!--properties-->
<h2>Properties</h2>
<div id="animation">
<span class="property"><a href="pc.AnimationComponent.html">pc.AnimationComponent</a></span><span class="property">animation <a class="font-icon" href="#animation"></a></span>
<p><p>Gets the <a href="pc.AnimationComponent.html">pc.AnimationComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="audiolistener">
<span class="property"><a href="pc.AudioListenerComponent.html">pc.AudioListenerComponent</a></span><span class="property">audiolistener <a class="font-icon" href="#audiolistener"></a></span>
<p><p>Gets the <a href="pc.AudioSourceComponent.html">pc.AudioSourceComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="button">
<span class="property"><a href="pc.ButtonComponent.html">pc.ButtonComponent</a></span><span class="property">button <a class="font-icon" href="#button"></a></span>
<p><p>Gets the <a href="pc.ButtonComponent.html">pc.ButtonComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="camera">
<span class="property"><a href="pc.CameraComponent.html">pc.CameraComponent</a></span><span class="property">camera <a class="font-icon" href="#camera"></a></span>
<p><p>Gets the <a href="pc.CameraComponent.html">pc.CameraComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="collision">
<span class="property"><a href="pc.CollisionComponent.html">pc.CollisionComponent</a></span><span class="property">collision <a class="font-icon" href="#collision"></a></span>
<p><p>Gets the <a href="pc.CollisionComponent.html">pc.CollisionComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="element">
<span class="property"><a href="pc.ElementComponent.html">pc.ElementComponent</a></span><span class="property">element <a class="font-icon" href="#element"></a></span>
<p><p>Gets the <a href="pc.ElementComponent.html">pc.ElementComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="layoutchild">
<span class="property"><a href="pc.LayoutChildComponent.html">pc.LayoutChildComponent</a></span><span class="property">layoutchild <a class="font-icon" href="#layoutchild"></a></span>
<p><p>Gets the <a href="pc.LayoutChildComponent.html">pc.LayoutChildComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="layoutgroup">
<span class="property"><a href="pc.LayoutGroupComponent.html">pc.LayoutGroupComponent</a></span><span class="property">layoutgroup <a class="font-icon" href="#layoutgroup"></a></span>
<p><p>Gets the <a href="pc.LayoutGroupComponent.html">pc.LayoutGroupComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="light">
<span class="property"><a href="pc.LightComponent.html">pc.LightComponent</a></span><span class="property">light <a class="font-icon" href="#light"></a></span>
<p><p>Gets the <a href="pc.LightComponent.html">pc.LightComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="model">
<span class="property"><a href="pc.ModelComponent.html">pc.ModelComponent</a></span><span class="property">model <a class="font-icon" href="#model"></a></span>
<p><p>Gets the <a href="pc.ModelComponent.html">pc.ModelComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="particlesystem">
<span class="property"><a href="pc.ParticleSystemComponent.html">pc.ParticleSystemComponent</a></span><span class="property">particlesystem <a class="font-icon" href="#particlesystem"></a></span>
<p><p>Gets the <a href="pc.ParticleSystemComponent.html">pc.ParticleSystemComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="rigidbody">
<span class="property"><a href="pc.RigidBodyComponent.html">pc.RigidBodyComponent</a></span><span class="property">rigidbody <a class="font-icon" href="#rigidbody"></a></span>
<p><p>Gets the <a href="pc.RigidBodyComponent.html">pc.RigidBodyComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="screen">
<span class="property"><a href="pc.ScreenComponent.html">pc.ScreenComponent</a></span><span class="property">screen <a class="font-icon" href="#screen"></a></span>
<p><p>Gets the <a href="pc.ScreenComponent.html">pc.ScreenComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="script">
<span class="property"><a href="pc.ScriptComponent.html">pc.ScriptComponent</a></span><span class="property">script <a class="font-icon" href="#script"></a></span>
<p><p>Gets the <a href="pc.ScriptComponent.html">pc.ScriptComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="scrollview">
<span class="property"><a href="pc.ScrollViewComponent.html">pc.ScrollViewComponent</a></span><span class="property">scrollview <a class="font-icon" href="#scrollview"></a></span>
<p><p>Gets the <a href="pc.ScrollViewComponent.html">pc.ScrollViewComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="sound">
<span class="property"><a href="pc.SoundComponent.html">pc.SoundComponent</a></span><span class="property">sound <a class="font-icon" href="#sound"></a></span>
<p><p>Gets the <a href="pc.SoundComponent.html">pc.SoundComponent</a> attached to this entity. [read only]</p></p>
</div>
<div id="sprite">
<span class="property"><a href="pc.SpriteComponent.html">pc.SpriteComponent</a></span><span class="property">sprite <a class="font-icon" href="#sprite"></a></span>
<p><p>Gets the <a href="pc.SpriteComponent.html">pc.SpriteComponent</a> attached to this entity. [read only]</p></p>
</div>
<!--methods-->
<h2>Methods</h2>
<div id="addComponent">
<h3 class="methodname">addComponent(type, [data]) <a class="font-icon" href="#addComponent"></a></h3>
<p><p>Create a new component and add it to the entity.
Use this to add functionality to the entity like rendering a model, playing sounds and so on.</p></p>
<pre><code class="javascript">var entity = new pc.Entity();
// Add a light component with default properties
entity.addComponent("light");
// Add a camera component with some specified properties
entity.addComponent("camera", {
fov: 45,
clearColor: new pc.Color(1, 0, 0)
});</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>type</td><td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></td><td><p>The name of the component to add. Valid strings are:</p>
<ul>
<li>"animation" - see <a href="pc.AnimationComponent.html">pc.AnimationComponent</a></li>
<li>"audiolistener" - see <a href="pc.AudioListenerComponent.html">pc.AudioListenerComponent</a></li>
<li>"button" - see <a href="pc.ButtonComponent.html">pc.ButtonComponent</a></li>
<li>"camera" - see <a href="pc.CameraComponent.html">pc.CameraComponent</a></li>
<li>"collision" - see <a href="pc.CollisionComponent.html">pc.CollisionComponent</a></li>
<li>"element" - see <a href="pc.ElementComponent.html">pc.ElementComponent</a></li>
<li>"layoutchild" - see <a href="pc.LayoutChildComponent.html">pc.LayoutChildComponent</a></li>
<li>"layoutgroup" - see <a href="pc.LayoutGroupComponent.html">pc.LayoutGroupComponent</a></li>
<li>"light" - see <a href="pc.LightComponent.html">pc.LightComponent</a></li>
<li>"model" - see <a href="pc.ModelComponent.html">pc.ModelComponent</a></li>
<li>"particlesystem" - see <a href="pc.ParticleSystemComponent.html">pc.ParticleSystemComponent</a></li>
<li>"rigidbody" - see <a href="pc.RigidBodyComponent.html">pc.RigidBodyComponent</a></li>
<li>"screen" - see <a href="pc.ScreenComponent.html">pc.ScreenComponent</a></li>
<li>"script" - see <a href="pc.ScriptComponent.html">pc.ScriptComponent</a></li>
<li>"scrollbar" - see <a href="pc.ScrollbarComponent.html">pc.ScrollbarComponent</a></li>
<li>"scrollview" - see <a href="pc.ScrollViewComponent.html">pc.ScrollViewComponent</a></li>
<li>"sound" - see <a href="pc.SoundComponent.html">pc.SoundComponent</a></li>
<li>"sprite" - see <a href="pc.SpriteComponent.html">pc.SpriteComponent</a></li>
</ul></td>
</tr>
<tr>
<td>data</td><td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></td><td><p>The initialization data for the specific component type. Refer to each
specific component's API reference page for details on valid values for this parameter.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="pc.Component.html">pc.Component</a> <p>The new Component that was attached to the entity or null if there
was an error.</p>
</div>
<div id="clone">
<h3 class="methodname">clone() <a class="font-icon" href="#clone"></a></h3>
<p><p>Create a deep copy of the Entity. Duplicate the full Entity hierarchy, with all Components and all descendants.
Note, this Entity is not in the hierarchy and must be added manually.</p></p>
<pre><code class="javascript">var e = this.entity.clone();
// Add clone as a sibling to the original
this.entity.parent.addChild(e);</code></pre>
<h4>Returns</h4>
<a href="pc.Entity.html">pc.Entity</a> <p>A new Entity which is a deep copy of the original.</p>
</div>
<div id="destroy">
<h3 class="methodname">destroy() <a class="font-icon" href="#destroy"></a></h3>
<p><p>Remove all components from the Entity and detach it from the Entity hierarchy. Then recursively destroy all ancestor Entities.</p></p>
<pre><code class="javascript">var firstChild = this.entity.children[0];
firstChild.destroy(); // delete child, all components and remove from hierarchy</code></pre>
</div>
<div id="findByGuid">
<h3 class="methodname">findByGuid(guid) <a class="font-icon" href="#findByGuid"></a></h3>
<p><p>Find a descendant of this Entity with the GUID.</p></p>
<h4>Parameters</h4>
<table>
<tr>
<td>guid</td><td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></td><td><p>The GUID to search for.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="pc.Entity.html">pc.Entity</a> <p>The Entity with the GUID or null.</p>
</div>
<div id="findComponent">
<h3 class="methodname">findComponent(type) <a class="font-icon" href="#findComponent"></a></h3>
<p><p>Search the entity and all of its descendants for the first component of specified type.</p></p>
<pre><code class="javascript">// Get the first found light component in the hierarchy tree that starts with this entity
var light = entity.findComponent("light");</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>type</td><td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></td><td><p>The name of the component type to retrieve.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="pc.Component.html">pc.Component</a> <p>A component of specified type, if the entity or any of its descendants has
one. Returns undefined otherwise.</p>
</div>
<div id="findComponents">
<h3 class="methodname">findComponents(type) <a class="font-icon" href="#findComponents"></a></h3>
<p><p>Search the entity and all of its descendants for all components of specified type.</p></p>
<pre><code class="javascript">// Get all light components in the hierarchy tree that starts with this entity
var lights = entity.findComponents("light");</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>type</td><td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></td><td><p>The name of the component type to retrieve.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="pc.Component.html">pc.Component</a> <p>All components of specified type in the entity or any of its descendants.
Returns empty array if none found.</p>
</div>
<div id="removeComponent">
<h3 class="methodname">removeComponent(type) <a class="font-icon" href="#removeComponent"></a></h3>
<p><p>Remove a component from the Entity.</p></p>
<pre><code class="javascript">var entity = new pc.Entity();
entity.addComponent("light"); // add new light component
entity.removeComponent("light"); // remove light component</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>type</td><td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></td><td><p>The name of the Component type.</p></td>
</tr>
</table>
</div>
<!--events-->
<h2>Events</h2>
<div id="event:destroy">
<h3 class="methodname">destroy <a class="font-icon" href="#event:destroy"></a></h3>
<p><p>Fired after the entity is destroyed.</p></p>
<pre><code class="javascript">entity.on("destroy", function (e) {
console.log('entity ' + e.name + ' has been destroyed');
});</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>entity</td><td><a href="pc.Entity.html">pc.Entity</a></td><td><p>The entity that was destroyed.</p></td>
</tr>
</table>
</div>
<h2>Inherited</h2>
<!--inherited properties-->
<h2>Properties</h2>
<div id="name">
<span class="property"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span><span class="property">name <a class="font-icon" href="#name"></a></span>
<p><p>The non-unique name of a graph node.</p></p>
</div>
<div id="tags">
<span class="property"><a href="pc.Tags.html">pc.Tags</a></span><span class="property">tags <a class="font-icon" href="#tags"></a></span>
<p><p>Interface for tagging graph nodes. Tag based searches can be performed using the <a href="pc.GraphNode.html#findByTag">pc.GraphNode#findByTag</a> function.</p></p>
</div>
<div id="right">
<span class="property"><a href="pc.Vec3.html">pc.Vec3</a></span><span class="property">right <a class="font-icon" href="#right"></a></span>
<p><p>The normalized local space X-axis vector of the graph node in world space.</p><span class='readonly'>[read only]</span></p>
</div>
<div id="up">
<span class="property"><a href="pc.Vec3.html">pc.Vec3</a></span><span class="property">up <a class="font-icon" href="#up"></a></span>
<p><p>The normalized local space Y-axis vector of the graph node in world space.</p><span class='readonly'>[read only]</span></p>
</div>
<div id="forward">
<span class="property"><a href="pc.Vec3.html">pc.Vec3</a></span><span class="property">forward <a class="font-icon" href="#forward"></a></span>
<p><p>The normalized local space negative Z-axis vector of the graph node in world space.</p><span class='readonly'>[read only]</span></p>
</div>
<div id="enabled">
<span class="property"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></span><span class="property">enabled <a class="font-icon" href="#enabled"></a></span>
<p><p>Enable or disable a 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 / deactivate all the enabled children of the GraphNode.</p></p>
</div>
<div id="parent">
<span class="property"><a href="pc.GraphNode.html">pc.GraphNode</a></span><span class="property">parent <a class="font-icon" href="#parent"></a></span>
<p><p>A read-only property to get a parent graph node.</p><span class='readonly'>[read only]</span></p>
</div>
<div id="path">
<span class="property"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Globa