SceneType

The SceneType module provides common data types in 3D graphics.

NOTE

The initial APIs of this module are supported since API version 12. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import { Vec2, Vec3, Vec4, Quaternion, Aabb, Color, Rect, GeometryType, PrimitiveTopology, CustomGeometry, CubeGeometry, PlaneGeometry, SphereGeometry, Position3, Rotation3, Scale3 } from '@kit.ArkGraphics3D';

Vec2

A two-dimensional vector used to represent a point or a direction in 2D space. It consists of two components: x and y.

System capability: SystemCapability.ArkUi.Graphics3D

Name	Type	Read Only	Optional	Description
x	number	No	No	Component on the X axis. The value is a real number.
y	number	No	No	Component on the Y axis. The value is a real number.

Vec3

A three-dimensional vector used to represent a point, a direction, or a vector transformation in 3D space. It consists of three components: x, y, and z.

System capability: SystemCapability.ArkUi.Graphics3D

Name	Type	Read Only	Optional	Description
x	number	No	No	Component on the X axis. The value is a real number.
y	number	No	No	Component on the Y axis. The value is a real number.
z	number	No	No	Component on the Z axis. The value is a real number.

Vec4

A four-dimensional vector used to represent a point, a direction, or a vector transformation in 4D space. It consists of four components: x, y, z, and w. The fourth component (w) enhances normalization and convenience for various calculations and transformations.

System capability: SystemCapability.ArkUi.Graphics3D

Name	Type	Read Only	Optional	Description
x	number	No	No	Component on the X axis. The value is a real number.
y	number	No	No	Component on the Y axis. The value is a real number.
z	number	No	No	Component on the Z axis. The value is a real number.
w	number	No	No	Component on the W axis. The value is a real number.

Quaternion

A mathematical notation for representing spatial rotations of elements in 3D space. Compared with Euler angles, a quaternion has advantages in numerical stability and avoiding the gimbal lock problem.

System capability: SystemCapability.ArkUi.Graphics3D

Name	Type	Read Only	Optional	Description
x	number	No	No	Component on the X axis. The value is a real number.
y	number	No	No	Component on the Y axis. The value is a real number.
z	number	No	No	Component on the Z axis. The value is a real number.
w	number	No	No	Component on the W axis. The value is a real number.

Aabb

Axis aligned boundary box used to determine whether two objects in space are overlapping.

System capability: SystemCapability.ArkUi.Graphics3D

Name	Type	Read Only	Optional	Description
aabbMin	Vec3	No	No	Minimum bounds of the AABB.
aabbMax	Vec3	No	No	Maximum bounds of the AABB.

Color

Color in RGBA format. It consists of four components: red, green, blue, and alpha.

System capability: SystemCapability.ArkUi.Graphics3D

Name	Type	Read Only	Optional	Description
r	number	No	No	Red component. The value range is [0, 1].
g	number	No	No	Green component. The value range is [0, 1].
b	number	No	No	Blue component. The value range is [0, 1].
a	number	No	No	Alpha component. The value range is [0, 1].

Rect

Rectangle in a plane.

System capability: SystemCapability.ArkUi.Graphics3D

Name	Type	Read Only	Optional	Description
x	number	No	No	X axis component in the lower left corner of the rectangle. The value is a real number.
y	number	No	No	Y axis component in the lower left corner of the rectangle. The value is a real number.
width	number	No	No	Width of the rectangle. The value must be greater than 0.
height	number	No	No	Height of the rectangle. The value must be greater than 0.

GeometryType¹⁸⁺

Enumerates the geometry types.

System capability: SystemCapability.ArkUi.Graphics3D

Name	Value	Description
CUSTOM	0	Undefined.
CUBE	1	Cube.
PLANE	2	Plane.
SPHERE	3	Sphere.

GeometryDefinition¹⁸⁺

An abstract class used to define the properties of specific geometry types.

System capability: SystemCapability.ArkUi.Graphics3D

Name	Type	Read Only	Optional	Description
geometryType	GeometryType	Yes	No	Type of geometry.

PrimitiveTopology¹⁸⁺

Enumerates the vertex processing methods.

System capability: SystemCapability.ArkUi.Graphics3D

Name	Value	Description
TRIANGLE_LIST	0	A set of vertices forming separate triangles without intersecting.
TRIANGLE_STRIP	1	Each vertex and the edge of the previous triangle create a new triangle.

CustomGeometry¹⁸⁺

A custom geometry type that inherits from GeometryDefinition.

System capability: SystemCapability.ArkUi.Graphics3D

Name	Type	Read Only	Optional	Description
topology	PrimitiveTopology	No	Yes	Parsing mode of triangle primitives. The default value is TRIANGLE_LIST.
vertices	Vec3[]	No	No	Array of vertices that make up the model.
indices	number[]	No	Yes	Array of indices for the vertices, with values starting at 0. The default value is undefined.
normals	Vec3[]	No	Yes	Array of normals corresponding to the vertices. The default value is undefined.
uvs	Vec2[]	No	Yes	Array of UV coordinates for the vertices. The default value is undefined.
colors	Color[]	No	Yes	Array of colors for the vertices. The default value is undefined.

CubeGeometry¹⁸⁺

A cube geometry type that inherits from GeometryDefinition.

System capability: SystemCapability.ArkUi.Graphics3D

Name	Type	Read Only	Optional	Description
size	Vec3	No	No	Width, height, and depth of the cube, defining its size.

PlaneGeometry¹⁸⁺

A plane geometry type that inherits from GeometryDefinition.

System capability: SystemCapability.ArkUi.Graphics3D

Name	Type	Read Only	Optional	Description
size	Vec2	No	No	Width and height of the plane, defining its size.

SphereGeometry¹⁸⁺

A sphere geometry type that inherits from GeometryDefinition.

System capability: SystemCapability.ArkUi.Graphics3D

Name	Type	Read Only	Optional	Description
radius	number	No	No	Radius of the sphere. The value must be greater than 0.
segmentCount	number	No	No	Number of segments dividing the sphere along latitude and longitude. The value must be greater than 0.

Position3

type Position3 = Vec3

Position of an object in 3D space. The value is of the Vec3 type.

System capability: SystemCapability.ArkUi.Graphics3D

Type	Description
Vec3	Any 3D vector.

Rotation3

type Rotation3 = Vec3

Rotation of an object in 3D space. The value is of the Vec3 type.

System capability: SystemCapability.ArkUi.Graphics3D

Type	Description
Vec3	Any 3D vector.

Scale3

type Scale3 = Vec3

Scaling of an object in 3D space. The type is Vec3.

System capability: SystemCapability.ArkUi.Graphics3D

Type	Description
Vec3	Any 3D vector.

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkGraphics 3D

harmony 鸿蒙SceneNode

harmony 鸿蒙ScenePostProcessSettings

harmony 鸿蒙SceneResource

harmony 鸿蒙Scene

harmony 鸿蒙@ohos.graphics.scene (ArkGraphics 3D)