SceneModification

AMD: require(["esri/layers/support/SceneModification"], (SceneModification) => { /* code goes here */ });
ESM: import SceneModification from "@arcgis/core/layers/support/SceneModification";
Class: esri/layers/support/SceneModification
Inheritance: SceneModification Accessor
Since: ArcGIS API for JavaScript 4.16

The SceneModification is used to perform a client-side geometric modifications. Clip, mask and replace are supported modification types. A collection of scene modifications could be applied with SceneModifications to the modifications for IntegratedMeshLayer property.

The modifications for IntegratedMeshLayer need to be in the same spatial reference as the IntegratedMeshLayer. Reprojection between WGS84 and WebMercator will be done automatically. Reprojection of the geometry to other spatial references can be done with the client-side projection engine.

See also:

Constructors

new SceneModification(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
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Polygonmore details

The geometry representing the location of the modification.

more detailsSceneModification
Stringmore details

The type of modification to perform.

more detailsSceneModification

Property Details

declaredClass Stringreadonly inherited

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

geometry Polygon

The geometry representing the location of the modification. Only polygon geometries are currently supported.

type String

The type of modification to perform.

Illustration Modification Description
modification-type-clip clip - removes selected area Clip-out portions of the integrated mesh to see features below. For example, utility work on gas or water lines in an area. Planners can create a scene in which the integrated mesh is clipped out at a site to expose the water or gas lines below it.
modification-type-mask mask - displays only selected area Define an area of interest. Use a polygon and draw only parts of the integrated mesh inside that polygon. For example, if you want to show only a portion of an integrated mesh within the boundaries of a city.
modification-type-replace replace - flattens selected area Replace an area of an integrated mesh based on a 3D polygon. For example, to add constructed buildings, flatten the integrated mesh at the footprint of a building so the new building can be visualized. Create different scenarios of the new construction area and share the scenarios as a web scene to discuss with stakeholders. The integrated mesh flattens to the minimum z-vertex of the modification polygon.

Possible Values:"clip"|"mask"|"replace"

Default Value:clip
See also:

Method Overview

Name Return Type Summary Class
SceneModificationmore details

Creates a clone of this object.

more detailsSceneModification
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsSceneModification
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsSceneModification

Method Details

Creates a clone of this object.

Returns:
Type Description
SceneModification A clone of the SceneModification instance that invoked this method.
fromJSON(json){*}static

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.

Parameter:
json Object

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:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

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

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.