Directional

Directional

clay .light. Directional

# new Directional()

Source:

light/Directional.js, line 4

Example

var light = new clay.light.Directional({
        intensity: 0.5,
        color: [1.0, 0.0, 0.0]
    });
    light.position.set(10, 10, 10);
    light.lookAt(clay.Vector3.ZERO);
    scene.add(light);

Extends

clay.Light

Members

# uid :number

Source:

core/Base.js, line 15

Inherited From:

clay.core.Base#__uid__

Type:

number

# autoUpdateLocalTransform :boolean

Source:

Node.js, line 56

Inherited From:

clay.Node#autoUpdateLocalTransform

If the local transform is update from SRT(scale, rotation, translation, which is position here) each frame

Type:

boolean

# cascadeSplitLogFactor :number

Source:

light/Directional.js, line 37

Available when shadowCascade is larger than 1 and have a unique directional light in scene.

Type:

number

# castShadow :boolean

Source:

Light.js, line 30

Inherited From:

clay.Light#castShadow

If light cast shadow

Type:

boolean

# color :Array.<number>

Source:

Light.js, line 17

Inherited From:

clay.Light#color

Light RGB color

Type:

Array.<number>

# getBoundingBox

Source:

Node.js, line 542

Inherited From:

clay.Node#getBoundingBox

Get bounding box of node

# group :number

Source:

Light.js, line 44

Inherited From:

clay.Light#group

Light group, shader with same lightGroup will be affected

Only useful in forward rendering

Type:

number

# intensity :number

Source:

Light.js, line 23

Inherited From:

clay.Light#intensity

Light intensity

Type:

number

# invisible :boolean

Source:

Node.js, line 119

Inherited From:

clay.Node#invisible

If node and its chilren invisible

Type:

boolean

# localTransform :clay.Matrix4

Source:

Node.js, line 50

Inherited From:

clay.Node#localTransform

Affine transform matrix relative to its parent node. Composited with position, rotation and scale.

Type:

clay.Matrix4

# name :string

Source:

Node.js, line 19

Inherited From:

clay.Node#name

Scene node name

Type:

string

# position :clay.Vector3

Source:

Node.js, line 25

Inherited From:

clay.Node#position

Position relative to its parent node. aka translation.

Type:

clay.Vector3

# rotation :clay.Quaternion

Source:

Node.js, line 31

Inherited From:

clay.Node#rotation

Rotation relative to its parent node. Represented by a quaternion

Type:

clay.Quaternion

# scale :clay.Vector3

Source:

Node.js, line 37

Inherited From:

clay.Node#scale

Scale relative to its parent node

Type:

clay.Vector3

# shadowBias :number

Source:

light/Directional.js, line 21

Type:

number

# shadowCascade :number

Source:

light/Directional.js, line 31

Shadow cascade. Use PSSM technique when it is larger than 1 and have a unique directional light in scene.

Type:

number

# shadowResolution :number

Source:

Light.js, line 36

Inherited From:

clay.Light#shadowResolution

Shadow map size

Type:

number

# shadowSlopeScale :number

Source:

light/Directional.js, line 25

Type:

number

# (nullable) target :clay.Vector3

Source:

Node.js, line 113

Inherited From:

clay.Node#target

Type:

clay.Vector3

# type :string

Source:

Light.js, line 54

Inherited From:

clay.Light#type

Light type

Type:

string

# 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() → {clay.light.Directional}

Source:

light/Directional.js, line 64

Overrides:

clay.Light#clone

Returns:

Type: clay.light.Directional

# 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

# 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

# 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

# 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

# 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

# updateWorldTransform()

Source:

Node.js, line 499

Inherited From:

clay.Node#updateWorldTransform

Update world transform before whole scene is updated.

# new Directional()

Example

Extends

Members

# __uid__ :number

Type:

# autoUpdateLocalTransform :boolean

Type:

# cascadeSplitLogFactor :number

Type:

# castShadow :boolean

Type:

# color :Array.<number>

Type:

# getBoundingBox

# group :number

Type:

# intensity :number

Type:

# invisible :boolean

Type:

# localTransform :clay.Matrix4

Type:

# name :string

Type:

# position :clay.Vector3

Type:

# rotation :clay.Quaternion

Type:

# scale :clay.Vector3

Type:

# shadowBias :number

Type:

# shadowCascade :number

Type:

# shadowResolution :number

Type:

# shadowSlopeScale :number

Type:

# (nullable) target :clay.Vector3

Type:

# type :string

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() → {clay.light.Directional}

Returns:

# decomposeLocalTransform()

# decomposeWorldTransform()

# eachChild(callback, contextopt)

Parameters:

# error(action, contextopt)

Parameters:

# getChildByName(name) → {clay.Node}

Parameters:

Returns:

# getDescendantByName(name) → {clay.Node}

Parameters:

Returns:

# getParent() → {clay.Scene}

Returns:

# getPath(rootNodeopt) → {string}

Parameters:

Returns:

# getScene() → {clay.Scene}

Returns:

# getWorldPosition(outopt) → {clay.Vector3}

# uid :number