findAll - Documentation

findAll

Find all nodes with the given validator. By default, the first argument accepts a string that is used to find the first node with the matching name value. For more advanced queries, you can provide a function to validate any property to find the desired node.

Source:

nodeComponents/findAll/findAll.js, line 5

Example

// returns an array of child nodes under `Cube_1` with the `name` being `Cube_1`
$$$
.find('Cube_1')
.findAll('Cube_1');

// returns an array of child nodes under `Cube_1` with the `name` containing the word `Cube`
$$$
.find('Cube_1')
.findAll(node => ~node.name.indexOf('Cube'));

Parameters:

Name	Type	Description
`name`	string \| function	Either a `string` or `function` that is used to find the matching node.

Returns:

An array of matching nodes.

Type: Array.<node>

Source:

rootComponents/findAll/findAll.js, line 9

Example

// returns an array of nodes with the `name` being `Cube_1`
$$$.findAll('Cube_1');

// returns an array of nodes with the `name` containing the word `Cube`
$$$.findAll(node => ~node.name.indexOf('Cube'));

// returns an array of nodes with geometry type being 'PlaneBufferGeometry'
$$$.findAll(node => node.geometry.type === 'PlaneBufferGeometry');

Parameters:

Name	Type	Attributes	Default	Description
`name`	string \| function			Either a `string` or `function` that is used to find the matching node.
`root`	object	<optional>	`scene`	The parent node to traverse the scene. By `default,` it's the `scene`.

Returns:

An array of matching nodes.

Type: Array.<node>

The second argument is an optional argument where you can specify the parent node to search for children nodes. By default, it will search from the top of the THREE.js scene.

Source:

nodeComponents/findAll/findAll.js, line 5

Example

// returns an array of child nodes under `Cube_1` with the `name` being `Cube_1`
$$$
.find('Cube_1')
.findAll('Cube_1');

// returns an array of child nodes under `Cube_1` with the `name` containing the word `Cube`
$$$
.find('Cube_1')
.findAll(node => ~node.name.indexOf('Cube'));

Parameters:

Name	Type	Description
`name`	string \| function	Either a `string` or `function` that is used to find the matching node.

Returns:

An array of matching nodes.

Type: Array.<node>

Source:

rootComponents/findAll/findAll.js, line 9

Example

// returns an array of nodes with the `name` being `Cube_1`
$$$.findAll('Cube_1');

// returns an array of nodes with the `name` containing the word `Cube`
$$$.findAll(node => ~node.name.indexOf('Cube'));

// returns an array of nodes with geometry type being 'PlaneBufferGeometry'
$$$.findAll(node => node.geometry.type === 'PlaneBufferGeometry');

Parameters:

Name	Type	Attributes	Default	Description
`name`	string \| function			Either a `string` or `function` that is used to find the matching node.
`root`	object	<optional>	`scene`	The parent node to traverse the scene. By `default,` it's the `scene`.

Returns:

An array of matching nodes.

Type: Array.<node>