JSDoc: Drawable

computeTransformationMatrix(parentMatrix, forceUpdate) → {boolean}

Update matrix

Parameters:

Name	Type	Description
`parentMatrix`	?Array.<number> \| mat4	Parent transformable's matrix
`forceUpdate`	boolean	True to force an update

Inherited From:

Transformable#computeTransformationMatrix

View Source Transformable.js, line 267

Returns:

True if the matrix have been updated, otherwise false

Type: boolean

draw(renderTarget)

Draw the element

Parameters:

Name	Type	Description
`renderTarget`	RenderTarget	Renderer who called this method

View Source Objects/Drawable.js, line 15

enable(value) → {Node}

Set node's state

Parameters:

Name	Type	Description
`value`	boolean	True to enable, false to disable

Inherited From:

Node#enable

View Source Scene/Node.js, line 115

Returns:

A reference to the instance

Type: Node

findChild(name) → (nullable) {Node}

Find the child with the given name

Parameters:

Name	Type	Description
`name`	string	A string

Inherited From:

Node#findChild

View Source Scene/Node.js, line 127

Returns:

A Node instance of null

Type: Node

getBoundingBox() → {Box}

Return Node's bounding Box

Inherited From:

Node#getBoundingBox

View Source Scene/Node.js, line 202

Returns:

A Box instance

Type: Box

getChildren() → {Array.<Node>}

Return Node's children

Inherited From:

Node#getChildren

View Source Scene/Node.js, line 211

Returns:

An array of Node

Type: Array.<Node>

getNormalMatrix() → {Array.<number>|mat4}

Return computed normal matrix

Inherited From:

Transformable#getNormalMatrix

View Source Transformable.js, line 307

Returns:

A matrix

Type: Array.<number> | mat4

getOrigin() → {Array.<number>|vec3}

Return the origin

Inherited From:

Transformable#getOrigin

View Source Transformable.js, line 316

Returns:

A vector with the value for each axis

Type: Array.<number> | vec3

getPosition() → {Array.<number>|vec3}

Return relative position

Inherited From:

Transformable#getPosition

View Source Transformable.js, line 325

Returns:

A vector with the value for each axis

Type: Array.<number> | vec3

getRotation() → {Array.<number>}

Return the rotation in degrees

Inherited From:

Transformable#getRotation

To Do:

Implement this function

View Source Transformable.js, line 335

Returns:

A vector with the value for each axis in degrees

Type: Array.<number>

getScale() → {Array.<number>|vec3}

Return the scale

Inherited From:

Transformable#getScale

View Source Transformable.js, line 344

Returns:

A vector with the value for each axis

Type: Array.<number> | vec3

getTransformationMatrix() → {Array.<number>|mat4}

Return computed matrix

Inherited From:

Transformable#getTransformationMatrix

View Source Transformable.js, line 298

Returns:

A reference to the object's matrix

Type: Array.<number> | mat4

isEnabled() → {boolean}

Get state

Inherited From:

Node#isEnabled

View Source Scene/Node.js, line 220

Returns:

True if the node is enabled, otherwise false

Type: boolean

isRoot() → {boolean}

Indicates if the current node is the scene's root

Inherited From:

Node#isRoot

View Source Scene/Node.js, line 229

Returns:

True if it's the root node, otherwise false

Type: boolean

lookAt(position, up) → {Transformable}

Look at the given position

Parameters:

Name	Type	Description
`position`	Array.<number> \| Float32Array \| Float64Array	An array with value for each axis
`up`	Array.<number> \| Float32Array \| Float64Array	An array with value for each axis

Inherited From:

Transformable#lookAt

View Source Transformable.js, line 89

Returns:

A reference to the instance

Type: Transformable

removeChild(node) → {boolean}

Remove a child from the node

Parameters:

Name	Type	Description
`node`	Node	A Node instance

Inherited From:

Node#removeChild

View Source Scene/Node.js, line 147

Returns:

True if the operation is a success

Type: boolean

setChildren(nodes)

Force add children without setting parent node, carefully use this one.

Parameters:

Name	Type	Description
`nodes`	Array.<Node>	An array of nodes

Inherited From:

Node#setChildren

View Source Scene/Node.js, line 105

setName(name) → {Node}

Set the name to easily retrieve it later

Parameters:

Name	Type	Description
`name`	string	A string

Inherited From:

Node#setName

View Source Scene/Node.js, line 165

Returns:

A reference to the instance

Type: Node

setOrigin(x, ynullable, znullable) → {Transformable}

Set origin

Parameters:

Name	Type	Attributes	Description
`x`	number \| Array.<number>		Origin on X or an array with origin on each axis
`y`	number	<nullable>	Origin on Y
`z`	number	<nullable>	Origin on Z

Inherited From:

Transformable#setOrigin

View Source Transformable.js, line 146

Returns:

A reference to the instance

Type: Transformable

setPosition(x, ynullable, znullable) → {Transformable}

Set position

Parameters:

Name	Type	Attributes	Description
`x`	number \| Array.<number>		Position on X or an array with position on each axis
`y`	number	<nullable>	Position on Y
`z`	number	<nullable>	Position on Z

Inherited From:

Transformable#setPosition

View Source Transformable.js, line 166

Returns:

A reference to the instance

Type: Transformable

setRotation(x, ynullable, znullable) → {Transformable}

Set rotation using values in degrees

Parameters:

Name	Type	Attributes	Default	Description
`x`	number \| Array.<number>			Rotation on X in degrees or an array with rotation on each axis
`y`	number	<nullable>	0	Rotation on Y in degrees
`z`	number	<nullable>	0	Rotation on Z in degrees

Inherited From:

Transformable#setRotation

View Source Transformable.js, line 186

Returns:

A reference to the instance

Type: Transformable

setRotationFromMatrix(matrix) → {Transformable}

Set rotation from a rotation matrix

Parameters:

Name	Type	Description
`matrix`	mat4	A Matrix

Inherited From:

Transformable#setRotationFromMatrix

View Source Transformable.js, line 231

Returns:

A reference to the instance

Type: Transformable

setRotationFromQuaternion(quaternion) → {Transformable}

Set rotation from a quaternion

Parameters:

Name	Type	Description
`quaternion`	quat	A quaternion

Inherited From:

Transformable#setRotationFromQuaternion

View Source Transformable.js, line 216

Returns:

A reference to the instance

Type: Transformable

setScale(x, ynullable, znullable) → {Transformable}

Set scale

Parameters:

Name	Type	Attributes	Description
`x`	number \| Array.<number>		Scale on X or an array with scale on each axis
`y`	number	<nullable>	Scale on Y
`z`	number	<nullable>	Scale on Z

Inherited From:

Transformable#setScale

View Source Transformable.js, line 248

Returns:

A reference to the instance

Type: Transformable

update(deltaTime, forceUpdatenullable) → {boolean}

Update the node and his children

Parameters:

Name	Type	Attributes	Default	Description
`deltaTime`	number			A floating value representing time elapsed between two frames
`forceUpdate`	boolean	<nullable>	false	Set to true to force an update

Inherited From:

Node#update

View Source Scene/Node.js, line 178

Returns:

True if the node has been updated

Type: boolean

visit(renderTarget) → {boolean}

Visit the node and his children

Parameters:

Name	Type	Description
`renderTarget`	RenderTarget	Renderer who called this method

Overrides:

Node#visit

View Source Objects/Drawable.js, line 23

Returns:

True if visit was successful, otherwise false

Type: boolean

Constructor

new Drawable()

Extends

Methods

computeTransformationMatrix(parentMatrix, forceUpdate) → {boolean}

Parameters:

draw(renderTarget)

Parameters:

enable(value) → {Node}

Parameters:

findChild(name) → (nullable) {Node}

Parameters:

getBoundingBox() → {Box}

getChildren() → {Array.<Node>}

getNormalMatrix() → {Array.<number>|mat4}

getOrigin() → {Array.<number>|vec3}

getPosition() → {Array.<number>|vec3}

getRotation() → {Array.<number>}

getScale() → {Array.<number>|vec3}

getTransformationMatrix() → {Array.<number>|mat4}

isEnabled() → {boolean}

isRoot() → {boolean}

lookAt(position, up) → {Transformable}

Parameters:

removeChild(node) → {boolean}

Parameters:

setChildren(nodes)

Parameters:

setName(name) → {Node}

Parameters:

setOrigin(x, ynullable, znullable) → {Transformable}

Parameters:

setPosition(x, ynullable, znullable) → {Transformable}

Parameters:

setRotation(x, ynullable, znullable) → {Transformable}

Parameters:

setRotationFromMatrix(matrix) → {Transformable}

Parameters:

setRotationFromQuaternion(quaternion) → {Transformable}

Parameters:

setScale(x, ynullable, znullable) → {Transformable}

Parameters:

update(deltaTime, forceUpdatenullable) → {boolean}

Parameters:

visit(renderTarget) → {boolean}

Parameters: