MeshTextureTransform | API Reference | ArcGIS Maps SDK for JavaScript 4.31

MeshTextureTransform represents a transformation of UV mesh coordinates used to sample a MeshTexture. The transformation includes an offset, rotation and scale. 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.

See also

Constructors

MeshTextureTransform Constructor new MeshTextureTransform(properties)

Parameter

properties Object

optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
Number []	The offset of the UV coordinate origin as a factor of the texture dimensions.	MeshTextureTransform
Number	The rotation of the UV coordinates in degrees, counter-clockwise around the origin.	MeshTextureTransform
Number []	The scale factor applied to the components of the UV coordinates.	MeshTextureTransform

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

offset Property offset Number[]

The offset of the UV coordinate origin as a factor of the texture dimensions.

Default Value:[0, 0]

rotation Property rotation Number

The rotation of the UV coordinates in degrees, counter-clockwise around the origin.

Default Value:0

scale Property scale Number[]

The scale factor applied to the components of the UV coordinates.

Default Value:[1, 1]

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
this	Creates a deep clone of this object.	MeshTextureTransform
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

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();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key 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.

clone Method clone(){this}

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

Type	Description
this	A deep clone of the class instance that invoked this method.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	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 Inherited Method removeHandles(groupKey) Inherited from Accessor

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");