MeshMaterial | References | ArcGIS Maps SDK for JavaScript

import MeshMaterial from "@arcgis/core/geometry/support/MeshMaterial.js";

Inheritance:: MeshMaterial→Accessor

Subclasses:: MeshMaterialMetallicRoughness

Since: ArcGIS Maps SDK for JavaScript 4.11

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`MeshMaterialProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`alphaCutoff`	`number`
`alphaMode`	`MeshMaterialAlphaMode`
`color`	`Color \| null \| undefined`
`colorTexture`	`MeshTexture \| null \| undefined`
`colorTextureTransform`	`MeshTextureTransform \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`doubleSided`	`boolean`
`normalTexture`	`MeshTexture \| null \| undefined`
`normalTextureTransform`	`MeshTextureTransform \| null \| undefined`

alphaCutoff

Property

Type: number

Specifies how transparency on the object is handled. If alphaMode is set to either mask or auto this property specifies the cutoff value below which masking happens (that is, the corresponding part of the Mesh is rendered fully transparent).

Default value: 0.5

alphaMode

Property

Type: MeshMaterialAlphaMode

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` and `blend` settings, masking below `alphaCutoff` and blending above it.

Default value: "auto"

color

autocast Property

Type: Color | null | undefined

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, and a properties, or a Color object.

colorTexture

autocast Property

Type: MeshTexture | null | undefined

Specifies a texture from which to get color information. The texture is accessed using the UV coordinates specified for each vertex in the Mesh.vertexAttributes.

colorTextureTransform

autocast Property

Type: MeshTextureTransform | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.27

A transformation of UV mesh coordinates used to sample the color texture. Texture transformations can be used to optimize re-use of textures, for example by packing many images into a single texture "atlas" and using the texture transform offset and scale to sample a specific region within this larger texture.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

doubleSided

Property

Type: boolean

Specifies whether both sides of each triangle are displayed, or only the front sides.

Default value: true

normalTexture

autocast Property

Type: MeshTexture | null | undefined

Specifies a texture from which to get normal information. The texture is accessed using the UV coordinates specified for each vertex in the Mesh.vertexAttributes.

normalTextureTransform

autocast Property

Type: MeshTextureTransform | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.27

A transformation of UV mesh coordinates used to sample the normal texture. Texture transformations can be used to optimize re-use of textures, for example by packing many images into a single texture "atlas" and using the texture transform offset and scale to sample a specific region within this larger texture.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.

Type definitions

MeshMaterialAlphaMode

Type definition

Type: "opaque" | "blend" | "mask" | "auto"