import type { VertexSpaceParameters, GeographicParameters, MaterialParameters, CreateParameters, CreateBoxParameters } from "@arcgis/core/geometry/support/meshUtils/types.js";Type definitions
VertexSpaceParameters
- Since
- ArcGIS Maps SDK for JavaScript 5.0
vertexSpace
- Type
- "local" | "georeferenced" | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Specifies the vertex space of the created mesh. If not specified, a vertex space is chosen according to the spatial reference where a MeshLocalVertexSpace is used for geographic or WebMercator spatial references and MeshGeoreferencedVertexSpace is used otherwise. If vertexSpace is "georeferenced", then the vertex space will also be MeshGeoreferencedVertexSpace where mesh vertices are georeferenced offsets to the location provided with the create function. If the vertexSpace is "georeferenced" and the spatial reference is geographic, then vertex data will be first created in a "local" vertex space and then converted to the "georeferenced" vertex space. In case of vertex space being "local", mesh vertices will be defined in a local Cartesian coordinate frame placed at the location provided with the create function. This will be represented by MeshLocalVertexSpace
unit
- Type
- LengthUnit | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The unit of the size (defaults to the unit of the location's spatial reference).
GeographicParameters
- Since
- ArcGIS Maps SDK for JavaScript 5.0
unit
- Type
- LengthUnit | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Indicates the unit of the source data. A linear scale will be applied to the position attributes to convert the source data to the unit of the spatial reference at which the mesh is being georeferenced. By default the unit of the source data is assumed to be the same as the target spatial reference.
MaterialParameters
- Since
- ArcGIS Maps SDK for JavaScript 5.0
material
- Type
- MeshMaterialProperties | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The material to be used for the mesh.
CreateParameters
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Supertypes
- VertexSpaceParameters ‚ MaterialParameters
size
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A uniform size value or an object containing individual values width, height and depth. The unit of the size values is derived from the spatial reference of the provided location, unless a specific unit is specified. The default unit for a GCS is always meters.
CreateBoxParameters
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Parameters used to configure box mesh creation.
- Supertypes
- CreateParameters
imageFace
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The face for generating image UV coordinates. By default, a single set of unwrapped UV coordinates are generated
for all the faces. By setting the imageFace parameter to one of east, west, north, south, up or down,
the specified face will have full-sized UV coordinates while the other faces will retain their regular unwrapped UV
coordinates. This is useful for applying an image only to a single face of the box. The provided material
parameter will be applied to the specified imageFace. The resulting mesh will have two components, the first
contains the selected image face and the second contains the other faces of the box.
CreateSphereParameters
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Parameters used to configure sphere mesh creation.
- Supertypes
- CreateParameters
densificationFactor
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The additional number of subdivisions for generating the mesh representing a sphere. A densificationFactor parameter of 0 will generate a default of 16-by-16 vertices to approximate the sphere. A densificationFactor of 1 will generate 32-by-32 vertices, etc. The larger the densificationFactor, the better the mesh will approximate a perfect sphere (at the cost of processing and rendering performance).
CreateCylinderParameters
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Parameters used to configure cylinder mesh creation.
- Supertypes
- CreateParameters
densificationFactor
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The additional number of subdivisions for generating the mesh representing a cylinder. A densificationFactor parameter of 0 will generate a default of 16-by-16 vertices to approximate the cylinder. A densificationFactor of 1 will generate 32-by-32 vertices, etc. The larger the densificationFactor, the better the mesh will approximate a cylinder (at the cost of processing and rendering performance).
CreatePlaneParameters
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Parameters used to configure plane mesh creation.
- Supertypes
- VertexSpaceParameters ‚ MaterialParameters
size
- Since
- ArcGIS Maps SDK for JavaScript 5.0
A uniform size value or an object containing individual values width and height. The unit of the size values is derived from the spatial reference of the provided location, unless a specific unit is specified. The default unit for a GCS is always meters.
CreateFromGLTFParameters
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Parameters used to configure glTF mesh creation.
- Supertypes
- VertexSpaceParameters ‚ AbortOptions
RotateParameters
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Supertypes
- GeographicParameters
origin
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The origin around which to rotate. If not specified, the mesh will be rotated around the Mesh.origin.
ScaleParameters
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Supertypes
- GeographicParameters
origin
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The origin point for scaling. If not specified, the mesh will be scaled around the Mesh.origin.
CenterAtParameters
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Supertypes
- GeographicParameters
CreateFromElevationParameters
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Supertypes
- AbortOptions
material
- Type
- MeshMaterial | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The material to be used for the mesh.
demResolution
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to auto).
See ElevationLayer.queryElevation() for more details on the different settings.
- Default value
- "auto"
Facing
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Type
- "east" | "west" | "north" | "south" | "up" | "down"
ExportGLTFOptions
- Since
- ArcGIS Maps SDK for JavaScript 5.0
- Supertypes
- AbortOptions
origin
- Type
- Point
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The origin of the exported model, defaults to Mesh.origin. This location will correspond to the (0, 0, 0) coordinate in the binary glTF model.
VertexAttributes
- Since
- ArcGIS Maps SDK for JavaScript 5.0
Represents the position and normal vertex attribute buffers of a mesh.
position
- Type
- Float64Array<ArrayBuffer>
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The position buffer.
normal
- Type
- Float32Array<ArrayBuffer> | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The normal buffer.
tangent
- Type
- Float32Array<ArrayBuffer> | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 5.0
The tangent buffer.