/*
 * Copyright (c) 2024-2024 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file Defines 3D basic types
 * @kit ArkGraphics3D
 */

/**
 * Defines Vec2.
 *
 * @typedef Vec2
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 12
 */
export interface Vec2 {
  /**
   * X component of the vec2.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  x: number;

  /**
   * Y component of the vec2.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  y: number;
}

/**
 * Defines Vec3.
 *
 * @typedef Vec3
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 12
 */
export interface Vec3 {
  /**
   * X component of the vec3.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  x: number;

  /**
   * Y component of the vec3.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  y: number;

  /**
   * Z component of the vec3.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  z: number;
}

/**
 * Defines Vec4.
 *
 * @typedef Vec4
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 12
 */
export interface Vec4 {
  /**
   * X component of the vec4.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  x: number;

  /**
   * Y component of the vec4.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  y: number;

  /**
   * Z component of the vec4.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  z: number;

  /**
   * W component of the vec4.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  w: number;
}

/**
 * Quaternion representing a rotation.
 *
 * @typedef Quaternion
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 12
 */
export interface Quaternion {
  /**
   * X component of the quaternion.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  x: number;

  /**
   * Y component of the quaternion.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  y: number;

  /**
   * Z component of the quaternion.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  z: number;

  /**
   * W component of the quaternion.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  w: number;
}

/**
 * Axis aligned bounding box.
 *
 * @typedef Aabb 
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 12
 */
export interface Aabb {
  /**
   * Coordinates of the AABB minimum corner.
   *
   * @type { Vec3 }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  aabbMin: Vec3;

  /**
   * Coordinates of the AABB maximum corner.
   *
   * @type { Vec3 }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  aabbMax: Vec3;
}

/**
 * Defines Color.
 *
 * @typedef Color 
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 12
 */
export interface Color {
  /**
   * R component of the color.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  r: number;

  /**
   * G component of the color.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  g: number;

  /**
   * B component of the color.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  b: number;

  /**
   * A component of the color.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  a: number;
}

/**
 * Defines rectangle.
 *
 * @typedef Rect
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 12
 */
export interface Rect {
  /**
   * Left up x coordinate.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  x: number;

  /**
   * Left up y coordinate.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  y: number;

  /**
   * The width of the rectangle.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  width: number;

  /**
   * The height of the rectangle.
   *
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 12
   */
  height: number;
}

/**
 * Types of geometric shapes.
 * 
 * @enum { number }
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 18
 */
export enum GeometryType {
  /**
   * A custom geometric shape.
   * 
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  CUSTOM = 0,

  /**
   * A cube.
   * 
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  CUBE = 1,

  /**
   * A plane.
   * 
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  PLANE = 2,

  /**
   * A sphere.
   *
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  SPHERE = 3
}

/**
 * Define a geometric shape for mesh creation.
 * 
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 18
 */
export declare abstract class GeometryDefinition {
  /**
   * Which geometry shape to interpret from this definition.
   * 
   * @type { GeometryType }
   * @readonly
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  readonly geometryType: GeometryType;
}

/**
 * How vertices in a sequence form triangles.
 * 
 * @enum { number }
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 18 
 */
export enum PrimitiveTopology {
  /**
   * The vertices form a set of independent triangle. Vertices (0, 1, 2), (3, 4, 5), ... define separate triangles.
   * 
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  TRIANGLE_LIST = 0,

  /**
   * The vertices form a triangle strip. Starting from the 3rd, each vertex defines a triangle with the previous two.
   * 
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  TRIANGLE_STRIP = 1
}

/**
 * An array of vertices and their data defining a custom geometric shape.
 * 
 * @extends GeometryDefinition
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 18
 */
export declare class CustomGeometry extends GeometryDefinition {
  /**
   * How to form mesh triangles from the indexed vertices.
   * 
   * @type { ?PrimitiveTopology }
   * @default PrimitiveTopology.TRIANGLE_LIST
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  topology?: PrimitiveTopology;

  /**
   * An array of vertices.
   * 
   * @type { Vec3[] }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  vertices: Vec3[];

  /**
   * Indices of those vertices that form triangles. PrimitiveTopology is applied to the sequence defined by indices.
   * 
   * An example of creating an identical pair of triangles, given vertices = [a, b, c, d]:
   *     topology = PrimitiveTopology.TRIANGLE_LIST
   *     indices = [0, 1, 2, 2, 1, 3]    
   *     resulting triangles: abc, cbd
   * 
   *     topology = PrimitiveTopology.TRIANGLE_STRIP
   *     indices = [0, 1, 2, 3]
   *     resulting triangles: abc, cbd (b and c are reversed in cbd, to match the face direction of the first triangle)
   * 
   * @type { ?number[] }
   * @default indices: [0, 1 ,2,..., vertices.size() - 1]
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  indices?: number[];

  /**
   * Vertex normal. If normals is not null. normals[N] is for vertices[N] and generateNormals is ignored.
   * 
   * @type { ?Vec3[] }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  normals?: Vec3[];

  /**
   * Vertex texture mapping UV coordinate. If uvs is not null, uvs[N] is for vertices[N]
   * 
   * @type { ?Vec2[] }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  uvs?: Vec2[];

  /**
   * Vertex color. If colors is not null, colors[N] is for vertices[N].
   * 
   * @type { ?Color[] }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  colors?: Color[];
}

/**
 * Define a rectangular cuboid.
 * 
 * @extends GeometryDefinition
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 18
 */
export declare class CubeGeometry extends GeometryDefinition {
  /**
   * The width, height and depth of the cube.
   * 
   * @type { Vec3 }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  size: Vec3;
}

/**
 * Define a plane.
 * 
 * @extends GeometryDefinition
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 18
 */
export declare class PlaneGeometry extends GeometryDefinition {
  /**
   * The width and length of the plane.
   * 
   * @type { Vec2 }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  size: Vec2;
}

/**
 * Define a sphere.
 * 
 * @extends GeometryDefinition
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 18
 */
export declare class SphereGeometry extends GeometryDefinition {
  /**
   * The radius of the sphere.
   * 
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  radius: number;

  /**
   * Divide the sphere latitudinally into this many circles and each circle longitudinally into this many segments.
   * 
   * @type { number }
   * @syscap SystemCapability.ArkUi.Graphics3D
   * @since 18
   */
  segmentCount: number;
}
/**
 * 3D position information.
 *
 * @typedef { Vec3 } 
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 12
 */
export type Position3 = Vec3;

/**
 * 3D rotation info as euler angles.
 *
 * @typedef { Vec3 } 
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 12
 */
export type Rotation3 = Vec3;

/**
 * 3D scale information.
 *
 * @typedef { Vec3 } 
 * @syscap SystemCapability.ArkUi.Graphics3D
 * @since 12
 */
export type Scale3 = Vec3;