Scene

Scene bounding box in view space. Used when camera needs to adujst the near and far plane automatically so that the view frustum contains the visible objects as tightly as possible. Notice: It is updated after rendering (in the step of frustum culling passingly). So may be not so accurate, but saves a lot of calculation

Type:

clay.BoundingBox

# worldTransform :clay.Matrix4

Source:

Node.js, line 43

Inherited From:

clay.Node#worldTransform

Affine transform matrix relative to its root scene.

Type:

clay.Matrix4

Methods

# add(node)

Source:

Node.js, line 154

Inherited From:

clay.Node#add

Add a child node

Parameters:

Name	Type	Description
`node`	clay.Node

# after(name, action, contextopt)

Source:

core/mixin/notifier.js, line 125

Inherited From:

clay.core.Base#after

Mixes In:

clay.core.mixin.notifier.after

Alias of once('after' + name)

Parameters:

Name	Type	Attributes
`name`	string
`action`	function
`context`	Object	<optional>

# before(name, action, contextopt)

Source:

core/mixin/notifier.js, line 110

Inherited From:

clay.core.Base#before

Mixes In:

clay.core.mixin.notifier.before

Alias of once('before' + name)

Parameters:

Name	Type	Attributes
`name`	string
`action`	function
`context`	Object	<optional>

# childAt(idx) → {clay.Node}

Source:

Node.js, line 264

Inherited From:

clay.Node#childAt

Get child scene node at given index.

Parameters:

Name	Type	Description
`idx`	number

Returns:

Type: clay.Node

# children() → {Array.<clay.Node>}

Source:

Node.js, line 255

Inherited From:

clay.Node#children

Get a new created array of all children nodes

Returns:

Type: Array.<clay.Node>

# clone() → {Node}

Source:

Node.js, line 600

Inherited From:

clay.Node#clone

Clone a new node

Returns:

Type: Node

# cloneNode(node) → {clay.Node}

Source:

Scene.js, line 229

Clone a node and it's children, including mesh, camera, light, etc. Unlike using Node#clone. It will clone skeleton and remap the joints. Material will also be cloned.

Parameters:

Name	Type	Description
`node`	clay.Node

Returns:

Type: clay.Node

# decomposeLocalTransform()

Source:

Node.js, line 409

Inherited From:

clay.Node#decomposeLocalTransform

Decompose the local transform to SRT

# decomposeWorldTransform()

Source:

Node.js, line 427

Inherited From:

clay.Node#decomposeWorldTransform

Decompose the world transform to SRT

# dispose()

Source:

Scene.js, line 537

Dispose self, clear all the scene objects But resources of gl like texuture, shader will not be disposed. Mostly you should use disposeScene method in Renderer to do dispose.

# eachChild(callback, contextopt)

Source:

Node.js, line 389

Inherited From:

clay.Node#eachChild

Traverse all children nodes.

WARN DON'T do add, remove operation in the callback during iteration.

Parameters:

Name	Type	Attributes	Description
`callback`	function
`context`	Node	<optional>

# error(action, contextopt)

Source:

core/mixin/notifier.js, line 149

Inherited From:

clay.core.Base#error

Mixes In:

clay.core.mixin.notifier.error

Alias of on('error')

Parameters:

Name	Type	Attributes	Description
`action`	function
`context`	Object	<optional>

# getChildByName(name) → {clay.Node}

Source:

Node.js, line 273

Inherited From:

clay.Node#getChildByName

Get first child with the given name

Parameters:

Name	Type	Description
`name`	string

Returns:

Type: clay.Node

# getDescendantByName(name) → {clay.Node}

Source:

Node.js, line 287

Inherited From:

clay.Node#getDescendantByName

Get first descendant have the given name

Parameters:

Name	Type	Description
`name`	string

Returns:

Type: clay.Node

# getMainCamera()

Source:

Scene.js, line 187

Get main camera of the scene.

# getNode(name) → {Node}

Source:

Scene.js, line 169

Deprecated:

Get node by name

Parameters:

Name	Type	Description
`name`	string

Returns:

Type: Node

# getParent() → {clay.Scene}

Source:

Node.js, line 222

Inherited From:

clay.Node#getParent

Get parent node

Returns:

Type: clay.Scene

# getPath(rootNodeopt) → {string}

Source:

Node.js, line 346

Inherited From:

clay.Node#getPath

Get query path, relative to rootNode(default is scene)

Parameters:

Name	Type	Attributes	Description
`rootNode`	clay.Node	<optional>

Returns:

Type: string

# getRenderList(camera) → {clay.Scene.RenderList}

Source:

Scene.js, line 290

Get render list. Used after clay.Scene#updateRenderList

Parameters:

Name	Type	Description
`camera`	clay.Camera

Returns:

Type: clay.Scene.RenderList

# getScene() → {clay.Scene}

Source:

Node.js, line 214

Inherited From:

clay.Node#getScene

Get the scene mounted

Returns:

Type: clay.Scene

# getWorldPosition(outopt) → {clay.Vector3}

Source:

Node.js, line 578

Inherited From:

clay.Node#getWorldPosition

Get world position, extracted from world transform

Parameters:

Name	Type	Attributes	Description
`out`	clay.Vector3	<optional>

Returns:

Type: clay.Vector3

# has(name, action) → {boolean}

Source:

core/mixin/notifier.js, line 187

Inherited From:

clay.core.Base#has

Mixes In:

clay.core.mixin.notifier.has

If registered the event handler

Parameters:

Name	Type	Description
`name`	string
`action`	function

Returns:

Type: boolean

# isAncestor(node)

Source:

Node.js, line 240

Inherited From:

clay.Node#isAncestor

Return true if it is ancestor of the given scene node

Parameters:

Name	Type	Description
`node`	clay.Node

# isRenderable() → {boolean}

Source:

Node.js, line 132

Inherited From:

clay.Node#isRenderable

Return true if it is a renderable scene node, like Mesh and ParticleSystem

Returns:

Type: boolean

# isSkinnedMesh() → {boolean}

Source:

Node.js, line 125

Inherited From:

clay.Node#isSkinnedMesh

If Node is a skinned mesh

Returns:

Type: boolean

# lookAt(target, upopt)

Source:

Node.js, line 655

Inherited From:

clay.Node#lookAt

See:

http://www.opengl.org/sdk/docs/man2/xhtml/gluLookAt.xml

Parameters:

Name	Type	Attributes	Description
`target`	clay.Vector3
`up`	clay.Vector3	<optional>

# off(action, contextopt)

Source:

core/mixin/notifier.js, line 159

Inherited From:

clay.core.Base#off

Mixes In:

clay.core.mixin.notifier.off

Remove event listener

Parameters:

Name	Type	Attributes	Description
`action`	function
`context`	Object	<optional>

# on(name, action, contextopt)

Source:

core/mixin/notifier.js, line 65

Inherited From:

clay.core.Base#on

Mixes In:

clay.core.mixin.notifier.on

Parameters:

Name	Type	Attributes
`name`	string
`action`	function
`context`	Object	<optional>

# once(name, action, contextopt)

Source:

core/mixin/notifier.js, line 91

Inherited From:

clay.core.Base#once

Mixes In:

clay.core.mixin.notifier.once

Parameters:

Name	Type	Attributes
`name`	string
`action`	function
`context`	Object	<optional>

# queryNode(path) → {clay.Node}

Source:

Node.js, line 309

Inherited From:

clay.Node#queryNode

Query descendant node by path

Example

node.queryNode('root/parent/child');

Parameters:

Name	Type	Description
`path`	string

Returns:

Type: clay.Node

# remove(node)

Source:

Node.js, line 178

Inherited From:

clay.Node#remove

Remove the given child scene node

Parameters:

Name	Type	Description
`node`	clay.Node

# removeAll()

Source:

Node.js, line 196

Inherited From:

clay.Node#removeAll

Remove all children

# rotateAround(point, axis, angle)

Source:

Node.js, line 625

Inherited From:

clay.Node#rotateAround

See:

http://docs.unity3d.com/Documentation/ScriptReference/Transform.RotateAround.html

Rotate the node around a axis by angle degrees, axis passes through point

Parameters:

Name	Type	Description
`point`	clay.Vector3	Center point
`axis`	clay.Vector3	Center axis
`angle`	number	Rotation angle

# setLocalTransform(matrix)

Source:

Node.js, line 401

Inherited From:

clay.Node#setLocalTransform

Set the local transform and decompose to SRT

Parameters:

Name	Type	Description
`matrix`	clay.Matrix4

# setMainCamera(camera)

Source:

Scene.js, line 177

Set main camera of the scene.

Parameters:

Name	Type	Description
`camera`	claygl.Camera

# setName(name)

Source:

Node.js, line 140

Inherited From:

clay.Node#setName

Set the name of the scene node

Parameters:

Name	Type	Description
`name`	string

# setWorldTransform(matrix)

Source:

Node.js, line 418

Inherited From:

clay.Node#setWorldTransform

Set the world transform and decompose to SRT

Parameters:

Name	Type	Description
`matrix`	clay.Matrix4

# success(action, contextopt)

Source:

core/mixin/notifier.js, line 139

Inherited From:

clay.core.Base#success

Mixes In:

clay.core.mixin.notifier.success

Alias of on('success')

Parameters:

Name	Type	Attributes	Description
`action`	function
`context`	Object	<optional>

# traverse(callback, contextopt)

Source:

Node.js, line 373

Inherited From:

clay.Node#traverse

Depth first traverse all its descendant scene nodes.

WARN Don't do add, remove operation in the callback during traverse.

Parameters:

Name	Type	Attributes	Description
`callback`	function
`context`	Node	<optional>

# trigger(name)

Source:

core/mixin/notifier.js, line 14

Inherited From:

clay.core.Base#trigger

Mixes In:

clay.core.mixin.notifier.trigger

Trigger event

Parameters:

Name	Type	Description
`name`	string

# update(forceUpdateWorld)

Source:

Node.js, line 514

Inherited From:

clay.Node#update

Update local transform and world transform recursively

Parameters:

Name	Type	Description
`forceUpdateWorld`	boolean

# updateLocalTransform()

Source:

Node.js, line 456

Inherited From:

clay.Node#updateLocalTransform

Update local transform from SRT Notice that local transform will not be updated if _dirty mark of position, rotation, scale is all false

# updateRenderList(camera, updateSceneBoundingBox) → {clay.Scene.RenderList}

Source:

Scene.js, line 263

Traverse the scene and add the renderable object to the render list. It needs camera for the frustum culling.

Parameters:

Name	Type	Description
`camera`	clay.Camera
`updateSceneBoundingBox`	boolean

Returns:

Type: clay.Scene.RenderList

# updateWorldTransform()

Source:

Node.js, line 499

Inherited From:

clay.Node#updateWorldTransform

Update world transform before whole scene is updated.

Type Definitions

# RenderList

Source:

Scene.js, line 62

Properties:

Name	Type	Description
`opaque`	Array.<clay.Renderable>
`transparent`	Array.<clay.Renderable>

Type:

Object

# new Scene()

Extends

Members

# __uid__ :number

Type:

# autoUpdateLocalTransform :boolean

Type:

# getBoundingBox

# invisible :boolean

Type:

# isFrustumCulled

# localTransform :clay.Matrix4

Type:

# material :clay.Material

Type:

# name :string

Type:

# position :clay.Vector3

Type:

# rotation :clay.Quaternion

Type:

# scale :clay.Vector3

Type:

# (nullable) target :clay.Vector3

Type:

# viewBoundingBoxLastFrame :clay.BoundingBox

Type:

# worldTransform :clay.Matrix4

Type:

Methods

# add(node)

Parameters:

# after(name, action, contextopt)

Parameters:

# before(name, action, contextopt)

Parameters:

# childAt(idx) → {clay.Node}

Parameters:

Returns:

# children() → {Array.<clay.Node>}

Returns:

# clone() → {Node}

Returns:

# cloneNode(node) → {clay.Node}

Parameters:

Returns:

# decomposeLocalTransform()

# decomposeWorldTransform()

# dispose()

# eachChild(callback, contextopt)

Parameters:

# error(action, contextopt)

Parameters:

# getChildByName(name) → {clay.Node}

Parameters:

Returns:

# getDescendantByName(name) → {clay.Node}

Parameters:

Returns:

# getMainCamera()

# getNode(name) → {Node}

Parameters:

Returns:

# getParent() → {clay.Scene}

Returns:

# getPath(rootNodeopt) → {string}

Parameters:

Returns:

# getRenderList(camera) → {clay.Scene.RenderList}

Parameters:

Returns:

# getScene() → {clay.Scene}

Returns:

# getWorldPosition(outopt) → {clay.Vector3}

Parameters:

Returns:

# has(name, action) → {boolean}

Parameters:

Returns:

# uid :number