The material determines how a MeshComponent is visualized. One of the major characteristics of a material is its color. The color property can be used to set a uniform color for the whole MeshComponent. Use the colorTexture property to map an image onto the mesh component, using the uv coordinate specified for each vertex in the Mesh.vertexAttributes.
The material properties support a number of convenience autocast types, including hex color strings and well known color strings (autocasts to Color), or strings representing urls to images, HTMLImageElements, HTMLCanvasElements, HTMLVideoElement, or ImageData (autocasts to MeshTexture).
// create a material that uses a color
const meshWithColor = new MeshComponent({
// autocasts to MeshMaterial
material: {
color: "#ff00ff"
}
});
// create a material that uses a texture by linking to
// an image url
const meshTextureByUrl = new MeshTexture({
url: "./image.png"
});
const boxMesh = Mesh.createBox(location, {
material: {
colorTexture: meshTextureByUrl
}
});
// create a material that uses a texture from
// a canvas element
function createLinearGradient() {
const canvas = document.createElement("canvas");
canvas.width = 32;
canvas.height = 32;
const ctx = canvas.getContext("2d");
// Create the linear gradient with which to fill the canvas
const gradient = ctx.createLinearGradient(0, 0, 0, 32);
gradient.addColorStop(0, "#00ff00");
gradient.addColorStop(1, "#009900");
// Fill the canvas with the gradient pattern
ctx.fillStyle = gradient;
ctx.fillRect(0, 0, 32, 32);
return canvas;
}
const component = new MeshComponent({
material: {
// Autocast canvas element to MeshTexture instance
colorTexture: createLinearGradient()
}
});
- See also
Constructors
-
new MeshMaterial(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Number | Specifies how transparency on the object is handled. more details | MeshMaterial | |
String | Specifies how transparency on the object is handled. more details | MeshMaterial | |
Color | Specifies a single, uniform color for the mesh component. more details | MeshMaterial | |
MeshTexture | Specifies a texture from which to get color information. more details | MeshMaterial | |
String | The name of the class. more details | Accessor | |
Boolean | Specifies whether both sides of each triangle are displayed, or only the front sides. more details | MeshMaterial | |
MeshTexture | Specifies a texture from which to get normal information. more details | MeshMaterial |
Property Details
-
alphaCutoff Number
-
Specifies how transparency on the object is handled. If alphaMode is set to either
mask
orauto
this property specifies the cutoff value below which masking happens (that is, the coresponding part of the Mesh is rendered fully transparent).- Default Value:0.5
-
alphaMode String
-
Specifies how transparency on the object is handled. See also alphaCutoff.
Type Description opaque Alpha is ignored, and the object is rendered fully opaque. blend Alpha values are used for gradual transparency, blending between the object and its background. mask Alpha values are used for binary transparency, either displaying the object, or its background. See also alphaCutoff. auto The implementation mixes the mask
andblend
settings, masking belowalphaCutoff
and blending above it.Possible Values:"auto"|"blend"|"opaque"|"mask"
- Default Value:"auto"
-
Specifies a single, uniform color for the mesh component. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with
r
,g
,b
, anda
properties, or a Color object.
-
colorTexture MeshTextureautocastAutocasts from Object|HTMLImageElement|HTMLCanvasElement|HTMLVideoElement|ImageData|String
-
Specifies a texture from which to get color information. The texture is accessed using the uv coordinate specified for each vertex in the Mesh.vertexAttributes.
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
doubleSided Boolean
-
Specifies whether both sides of each triangle are displayed, or only the front sides.
- Default Value:true
-
normalTexture MeshTextureautocastAutocasts from Object|HTMLImageElement|HTMLVideoElement|HTMLCanvasElement|ImageData|String
-
Specifies a texture from which to get normal information. The texture is accessed using the uv coordinate specified for each vertex in the Mesh.vertexAttributes.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");