@arcgis/core 5.0.0-next.70 → 5.0.0-next.71

package/geometry/support/meshUtils/types.d.ts

@@ -5,8 +5,13 @@ import type { LengthUnit } from "../../../core/units.js";
 import type { MeshMaterialProperties } from "../MeshMaterial.js";
 import type { ElevationQueryDemResolution } from "../../../layers/support/types.js";
 
+/** @since 5.0 */
 export interface VertexSpaceParameters {
-  /** The unit of the size (defaults to the unit of the location's spatial reference). */
+  /**
+   * The unit of the size (defaults to the unit of the location's spatial reference).
+   *
+   * @since 5.0
+   */
   unit?: LengthUnit;
   /**
    * Specifies the vertex space of the created mesh. If not specified, a vertex space is
@@ -18,34 +23,51 @@ export interface VertexSpaceParameters {
    * 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](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshLocalVertexSpace.html)
+   *
+   * @since 5.0
    */
   vertexSpace?: "local" | "georeferenced";
 }
 
+/** @since 5.0 */
 export interface GeographicParameters {
   /**
    * 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.
+   *
+   * @since 5.0
    */
   unit?: LengthUnit;
 }
 
+/** @since 5.0 */
 export interface MaterialParameters {
-  /** The material to be used for the mesh. */
+  /**
+   * The material to be used for the mesh.
+   *
+   * @since 5.0
+   */
   material?: MeshMaterialProperties;
 }
 
+/** @since 5.0 */
 export interface CreateParameters extends VertexSpaceParameters, MaterialParameters {
   /**
    * 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.
+   *
+   * @since 5.0
    */
   size?: number | Size;
 }
 
-/** Parameters used to configure box mesh creation. */
+/**
+ * Parameters used to configure box mesh creation.
+ *
+ * @since 5.0
+ */
 export interface CreateBoxParameters extends CreateParameters {
   /**
    * The face for generating image UV coordinates. By default, a single set of unwrapped UV coordinates are generated
@@ -54,111 +76,179 @@ export interface CreateBoxParameters extends CreateParameters {
    * 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.
+   *
+   * @since 5.0
    */
   imageFace?: Facing | "all";
 }
 
-/** Parameters used to configure sphere mesh creation. */
+/**
+ * Parameters used to configure sphere mesh creation.
+ *
+ * @since 5.0
+ */
 export interface CreateSphereParameters extends CreateParameters {
   /**
    * 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).
+   *
+   * @since 5.0
    */
   densificationFactor?: number;
 }
 
-/** Parameters used to configure cylinder mesh creation. */
+/**
+ * Parameters used to configure cylinder mesh creation.
+ *
+ * @since 5.0
+ */
 export interface CreateCylinderParameters extends CreateParameters {
   /**
    * 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).
+   *
+   * @since 5.0
    */
   densificationFactor?: number;
 }
 
-/** Parameters used to configure plane mesh creation. */
+/**
+ * Parameters used to configure plane mesh creation.
+ *
+ * @since 5.0
+ */
 export interface CreatePlaneParameters extends VertexSpaceParameters, MaterialParameters {
   /**
    * Direction the plane is facing.
    *
    * @default "up"
+   * @since 5.0
    */
   facing?: Facing;
   /**
    * 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.
+   *
+   * @since 5.0
    */
   size?: number | Size2D;
 }
 
-/** Parameters used to configure glTF mesh creation. */
+/**
+ * Parameters used to configure glTF mesh creation.
+ *
+ * @since 5.0
+ */
 export interface CreateFromGLTFParameters extends VertexSpaceParameters, AbortOptions {}
 
+/** @since 5.0 */
 export interface RotateParameters extends GeographicParameters {
   /**
    * The origin around which to rotate. If not specified, the mesh will be rotated around the
    * [Mesh.origin](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#origin).
+   *
+   * @since 5.0
    */
   origin?: Point;
 }
 
+/** @since 5.0 */
 export interface ScaleParameters extends GeographicParameters {
   /**
    * The origin point for scaling. If not specified, the mesh will
    *   be scaled around the [Mesh.origin](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html#origin).
+   *
+   * @since 5.0
    */
   origin?: Point;
 }
 
+/** @since 5.0 */
 export interface CenterAtParameters extends GeographicParameters {
-  /** The origin at which to center. If not specified, the mesh will be centered at the mesh extent center. */
+  /**
+   * The origin at which to center. If not specified, the mesh will be centered at the mesh extent center.
+   *
+   * @since 5.0
+   */
   origin?: Point;
 }
 
+/** @since 5.0 */
 export interface CreateFromElevationParameters extends AbortOptions {
   /**
    * Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to `auto`).
    * See [ElevationLayer#queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation) for more details on the different settings.
    *
    * @default "auto"
+   * @since 5.0
    */
   demResolution?: ElevationQueryDemResolution;
-  /** The material to be used for the mesh. */
+  /**
+   * The material to be used for the mesh.
+   *
+   * @since 5.0
+   */
   material?: MeshMaterial;
 }
 
+/** @since 5.0 */
 export interface CreateElevationSamplerParameters {
   /**
    * The value to use when there is no data available.
    *
    * @default 0
+   * @since 5.0
    */
   noDataValue?: number;
 }
 
+/** @since 5.0 */
 export interface Size {
-  /** The depth of the created mesh. */
+  /**
+   * The depth of the created mesh.
+   *
+   * @since 5.0
+   */
   depth?: number;
-  /** The height of the created mesh. */
+  /**
+   * The height of the created mesh.
+   *
+   * @since 5.0
+   */
   height?: number;
-  /** The width of the created mesh. */
+  /**
+   * The width of the created mesh.
+   *
+   * @since 5.0
+   */
   width?: number;
 }
 
+/** @since 5.0 */
 export interface Size2D {
-  /** The height of the created mesh. */
+  /**
+   * The height of the created mesh.
+   *
+   * @since 5.0
+   */
   height?: number;
-  /** The width of the created mesh. */
+  /**
+   * The width of the created mesh.
+   *
+   * @since 5.0
+   */
   width?: number;
 }
 
+/** @since 5.0 */
 export type Facing = "east" | "west" | "north" | "south" | "up" | "down";
 
+/** @since 5.0 */
 export interface ExportGLTFOptions extends AbortOptions {
   /**
    * <<<<<<< HEAD
@@ -170,16 +260,34 @@ export interface ExportGLTFOptions extends AbortOptions {
    * {@link geometry/support/meshUtils/exporters/gltf/interfaces#origin Mesh.origin}. This location will correspond to
    * the (0, 0, 0) coordinate in the binary glTF model.
    * >>>>>>> f0925661fe2 (docs(esri/geometry): small fixes for Mesh API documentation)
+   *
+   * @since 5.0
    */
   origin: Point;
 }
 
-/** Represents the position and normal vertex attribute buffers of a mesh. */
+/**
+ * Represents the position and normal vertex attribute buffers of a mesh.
+ *
+ * @since 5.0
+ */
 export interface VertexAttributes {
-  /** The normal buffer. */
+  /**
+   * The normal buffer.
+   *
+   * @since 5.0
+   */
   normal?: Float32Array<ArrayBuffer> | null;
-  /** The position buffer. */
+  /**
+   * The position buffer.
+   *
+   * @since 5.0
+   */
   position: Float64Array<ArrayBuffer>;
-  /** The tangent buffer. */
+  /**
+   * The tangent buffer.
+   *
+   * @since 5.0
+   */
   tangent?: Float32Array<ArrayBuffer> | null;
 }

package/geometry/types.d.ts

@@ -7,32 +7,63 @@ import type Polyline from "./Polyline.js";
 import type MeshGeoreferencedVertexSpace from "./support/MeshGeoreferencedVertexSpace.js";
 import type MeshLocalVertexSpace from "./support/MeshLocalVertexSpace.js";
 
+/** @since 5.0 */
 export type FeatureGeometryType = "point" | "multipoint" | "polyline" | "polygon";
 
+/** @since 5.0 */
 export type GeometryType = "point" | "multipoint" | "polyline" | "polygon" | "extent" | "mesh";
 
-/** Union of all geometries. */
+/**
+ * Union of all geometries.
+ *
+ * @since 5.0
+ */
 export type GeometryUnion = Extent | Multipoint | Point | Polygon | Polyline | Mesh;
 
-/** Union of all non-mesh geometries. */
+/**
+ * Union of all non-mesh geometries.
+ *
+ * @since 5.0
+ */
 export type GeometryWithoutMeshUnion = Extent | Multipoint | Point | Polygon | Polyline;
 
+/** @since 5.0 */
 export type CurveType = "circular-arc" | "elliptic-arc" | "cubic-bezier";
 
+/** @since 5.0 */
 export type GeodeticCurveType = "geodesic" | "loxodrome" | "great-elliptic" | "normal-section" | "shape-preserving";
 
+/** @since 5.0 */
 export type LatitudeLongitudeFormat = "dd" | "ddm" | "dms";
 
-/** The definition of compressed texture data. */
+/**
+ * The definition of compressed texture data.
+ *
+ * @since 5.0
+ */
 export interface CompressedTextureData {
-  /** The compressed texture data. */
+  /**
+   * The compressed texture data.
+   *
+   * @since 5.0
+   */
   data: Uint8Array<ArrayBuffer>;
-  /** The texture encoding. */
+  /**
+   * The texture encoding.
+   *
+   * @since 5.0
+   */
   encoding: "image/ktx2";
-  /** The type. */
+  /**
+   * The type.
+   *
+   * @since 5.0
+   */
   type: "encoded-mesh-texture";
 }
 
+/** @since 5.0 */
 export type MeshTextureData = HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | ImageData | CompressedTextureData;
 
+/** @since 5.0 */
 export type MeshVertexSpaceUnion = MeshGeoreferencedVertexSpace | MeshLocalVertexSpace;

package/ground/NavigationConstraint.d.ts

@@ -1,7 +1,9 @@
 import type { JSONSupport, JSONSupportMixinProperties } from "../core/JSONSupport.js";
 
+/** @since 5.0 */
 export interface NavigationConstraintProperties extends JSONSupportMixinProperties, Partial<Pick<NavigationConstraint, "type">> {}
 
+/** @since 5.0 */
 export default abstract class NavigationConstraint extends JSONSupport {
   /**
    * The type of the constraint. It can be one of the following:
@@ -14,6 +16,7 @@ export default abstract class NavigationConstraint extends JSONSupport {
    * Default value: stay-above
    *
    * @default "none"
+   * @since 5.0
    */
   accessor type: "none" | "stay-above";
 }