JSDoc: Class: Mesh3D

Source:

Mesh3D.js, line 7

Classes

Mesh3D

Members

getMaterial

Get this object material.

Source:

Mesh3D.js, line 394

setMaterial

Change the material of this object to a copy of the provided one.

Source:

Mesh3D.js, line 497

setOpacity

Set opacity for this object. Default is 1.

Source:

Mesh3D.js, line 468

subdivide

Subdivides the geometry of the Mesh3D object using Loop subdivision. 🧪 This is an experimental feature: ⚠️ use with caution.

Source:

Mesh3D.js, line 514

Methods

getColor() → {Number}

Get this object diffuse color.

Source:

Mesh3D.js, line 373

Returns:

current diffuse color

Type: Number

getMetalness() → {Number}

Get this object metalness.

Source:

Mesh3D.js, line 363

Returns:

current metalness

Type: Number

getOpacity() → {Number}

Get this object opacity.

Source:

Mesh3D.js, line 384

Returns:

current opacity

Type: Number

getPosition() → {Vector}

Get current position

Source:

Mesh3D.js, line 266

Returns:

position vector

Type: Vector

getPositionX() → {Number}

Get this object X position

Source:

Mesh3D.js, line 277

Returns:

position X coordinate

Type: Number

getPositionY() → {Number}

Get this object Y position

Source:

Mesh3D.js, line 288

Returns:

position Y coordinate

Type: Number

getPositionZ() → {Number}

Get this object Z position

Source:

Mesh3D.js, line 299

Returns:

position Z coordinate

Type: Number

getRotation() → {Vector}

Get current rotation

Source:

Mesh3D.js, line 235

Returns:

rotation vector

Type: Vector

getRoughness() → {Number}

Get this object roughness.

Source:

Mesh3D.js, line 353

Returns:

current roughness

Type: Number

getScale() → {Vector}

Get current scale

Source:

Mesh3D.js, line 310

Returns:

scale vector

Type: Vector

getScaleX() → {Number}

Get this object X scale

Source:

Mesh3D.js, line 321

Returns:

scale X coordinate

Type: Number

getScaleY() → {Number}

Get this object Y scale

Source:

Mesh3D.js, line 332

Returns:

scale Y coordinate

Type: Number

getScaleZ() → {Number}

Get this object Z scale

Source:

Mesh3D.js, line 343

Returns:

scale Z coordinate

Type: Number

setColor(color) → {Mesh3D}

Change object color. You can use string, another Color or r,g,b parameters.

mesh.setColor("red");
mesh.setColor("#ff0000");
mesh.setColor(255, 0, 1);

Parameters:

Name	Type	Description
`color`	Color	new color.

Source:

Mesh3D.js, line 446

Returns:

modified object

Type: Mesh3D

setMetalness(value) → {Mesh3D}

Set metalness for this object. Default is 0

Parameters:

Name	Type	Description
`value`	Number	new metalness

Source:

Mesh3D.js, line 422

Returns:

modified object

Type: Mesh3D

setPosition(x, y, z) → {Mesh3D}

Set position of a Mesh3D.

Parameters:

Name	Type	Description
`x`	Number \| Vector	X coordinate or a p5.Vector with x,y,z (in this case ony one parameter is needed)
`y`	Number	Y coordinate
`z`	Number	Z coordinate

Source:

Mesh3D.js, line 135

Returns:

modified object

Type: Mesh3D

setPositionX(X) → {Mesh3D}

Set X position

Parameters:

Name	Type	Description
`X`	Number	position

Source:

Mesh3D.js, line 94

Returns:

modified object

Type: Mesh3D

setPositionY(Y) → {Mesh3D}

Set Y position

Parameters:

Name	Type	Description
`Y`	Number	position

Source:

Mesh3D.js, line 107

Returns:

modified object

Type: Mesh3D

setPositionZ(Z) → {Mesh3D}

Set Z position

Parameters:

Name	Type	Description
`Z`	Number	position

Source:

Mesh3D.js, line 120

Returns:

modified object

Type: Mesh3D

setRotation(x, y, z) → {Mesh3D}

Set rotation of a Mesh3D.

Parameters:

Name	Type	Description
`x`	Number \| Vector	rotation along X in degrees or radians or a p5.Vector object (in this case ony one parameter is needed)
`y`	Number	rotation along Y in degrees or radians
`z`	Number	rotation along Z in degrees or radians

Source:

Mesh3D.js, line 63

Returns:

modified object

Type: Mesh3D

setRotationX(angle) → {Mesh3D}

Set the rotation along X axis

Parameters:

Name	Type	Description
`angle`	number	rotation along X in degrees or radians

Source:

Mesh3D.js, line 19

Returns:

modified object

Type: Mesh3D

setRotationY(angle) → {Mesh3D}

Set the rotation along Y axis

Parameters:

Name	Type	Description
`angle`	number	rotation along Y in degrees or radians

Source:

Mesh3D.js, line 32

Returns:

modified object

Type: Mesh3D

setRotationZ(angle) → {Mesh3D}

Set the rotation along Z axis

Parameters:

Name	Type	Description
`angle`	number	rotation along Z in degrees or radians

Source:

Mesh3D.js, line 45

Returns:

modified object

Type: Mesh3D

setRoughness(value) → {Mesh3D}

Set roughness for this object. Default is 1

Parameters:

Name	Type	Description
`value`	Number	new roughness

Source:

Mesh3D.js, line 405

Returns:

modified object

Type: Mesh3D

setScale(…values)

If 1 parameter is used it can be a Number (in this case x,y,z are equals) or a Vector. If 3 parameters are used they will be X,Y and Z scale.

Parameters:

Name	Type	Attributes	Description
`values`	any	<repeatable>	1 or 3 Numbers or 1 Vector to define new scale.

Source:

Mesh3D.js, line 195

Returns:

modified object

setScaleX(x) → {Mesh3D}

Set X scale.

Parameters:

Name	Type	Description
`x`	Number	X coordinate

Source:

Mesh3D.js, line 159

Returns:

modified object

Type: Mesh3D

setScaleY(y) → {Mesh3D}

Set Y scale.

Parameters:

Name	Type	Description
`y`	Number	Y coordinate

Source:

Mesh3D.js, line 171

Returns:

modified object

Type: Mesh3D

setScaleZ(z) → {Mesh3D}

Set Z scale.

Parameters:

Name	Type	Description
`z`	Number	Z coordinate

Source:

Mesh3D.js, line 183

Returns:

modified object

Type: Mesh3D