1# ArkGraphics 3D场景搭建以及管理
2
3一个3D场景通常由光源、相机、模型三个关键部分组成。
4- 光源:为整个3D场景提供光照,使得3D场景中的模型变得可见。与真实物理场景一致,没有光源场景将变得一片漆黑,得到的渲染结果也就是全黑色。
5- 相机:为3D场景提供一个观察者。3D渲染本质上是从一个角度观察3D场景并投影到一张2D图片上。没有相机就没有3D场景的观察者,也就不会得到渲染结果。
6- 模型:3D场景中的模型用于描述对象的形状、结构和外观,一般具有网格、材质、纹理、动画等属性。一些常见的3D模型格式有OBJ、FBX、glTF等。
7
8模型加载后,可以通过ArkUI的[Component3D](../reference/apis-arkui/arkui-ts/ts-basic-components-component3d.md)渲染组件呈现给用户,Component3D也可以对3D模型做自定义渲染。开发者也可以使用ArkTS API对相机和光源进行调节,获得合适的观察角度和光照效果。ArkTS API可通过napi调用AGP中由C++实现的相应能力。
9
10![3D场景显示流程](./figures/scene.PNG)
11
12## 模型的加载及呈现
13模型的格式多种多样,目前ArkGraphics 3D仅支持glTF模型的加载,glTF是一种对于3D场景描述的格式,glTF作为一种开源3D场景格式在业界被广泛采用。关于glTF的介绍可以参照[glTF-2.0](https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html)。
14
15一个glTF模型可以包含光源、相机、模型等3D场景关键要素,如果一个glTF模型中包含相机,使用ArkGraphics 3D提供的接口加载glTF就可以直接完成该相机视角下3D场景的渲染。如果不包含相机,也可以利用ArkGraphics 3D创建一个相机完成渲染。由于3D模型往往数据量很大,通常采用异步方式进行加载,加载成功后将返回一个scene对象,通过该对象可对整个3D场景进行编辑。
16
17glTF模型可用Scene提供的[load](../reference/apis-arkgraphics3d/js-apis-inner-scene.md#load)接口加载,示例代码如下:
18```ts
19import { Image, Shader, MaterialType, Material, ShaderMaterial, Animation, Environment, Container, SceneNodeParameters,
20  LightType, Light, Camera, SceneResourceParameters, SceneResourceFactory, Scene, Node } from '@kit.ArkGraphics3D';
21
22function loadModel() : void {
23  // 加载模型
24  let scene: Promise<Scene> = Scene.load($rawfile("gltf/DamagedHelmet/glTF/DamagedHelmet.gltf"));
25  scene.then(async (result: Scene) => {});
26}
27```
28
29模型加载成功后,可通过SceneResourceFactory实例创建相机、光源等,再对相机和光源的参数做调节,调整观察角度和光照效果。最后,将Scene实例和ModelType作为SceneOptions传给Component3D组件显示到屏幕。
30
31模型显示的示例代码如下:
32```ts
33import { Image, Shader, MaterialType, Material, ShaderMaterial, Animation, Environment, Container, SceneNodeParameters,
34  LightType, Light, Camera, SceneResourceParameters, SceneResourceFactory, Scene, Node } from '@kit.ArkGraphics3D';
35
36@Entry
37@Component
38struct Model {
39  scene: Scene | null = null;
40  @State sceneOpt: SceneOptions | null = null;
41  cam: Camera | null = null;
42
43  onPageShow(): void {
44    this.Init();
45  }
46
47  Init(): void {
48    if (this.scene == null) {
49      // 加载模型,将gltf文件放置到相关路径,加载时以实际路径为准
50      Scene.load($rawfile('gltf/DamagedHelmet/glTF/DamagedHelmet.gltf'))
51      .then(async (result: Scene) => {
52        this.scene = result;
53        let rf:SceneResourceFactory = this.scene.getResourceFactory();
54        // 创建相机
55        this.cam = await rf.createCamera({ "name": "Camera" });
56        // 设置合适的相机参数
57        this.cam.enabled = true;
58        this.cam.position.z = 5;
59        this.sceneOpt = { scene: this.scene, modelType: ModelType.SURFACE } as SceneOptions;
60      })
61      .catch((reason: string) => {
62        console.log(reason);
63      });
64    }
65  }
66
67  build() {
68    Row() {
69      Column() {
70        if (this.sceneOpt) {
71          // 通过Component3D呈现3D场景
72          Component3D(this.sceneOpt)
73        } else {
74          Text("loading ...")
75        }
76      }.width('100%')
77    }.height('60%')
78  }
79}
80```
81
82## 相机的创建及管理
83
84相机作为3D场景中的重要部分,决定了整个3D场景向2D图片的投影过程,相机的近远平面、Fov角等关键参数也会对整个3D渲染产生重要的影响。开发者可以通过对于相机参数的设置。控制这个渲染过程,得到开发者想要的渲染效果。
85
86相机相关控制的示例代码如下:
87```ts
88import { Image, Shader, MaterialType, Material, ShaderMaterial, Animation, Environment, Container, SceneNodeParameters,
89  LightType, Light, Camera, SceneResourceParameters, SceneResourceFactory, Scene, Node } from '@kit.ArkGraphics3D';
90
91function createCameraPromise() : Promise<Camera> {
92  return new Promise(() => {
93    let scene: Promise<Scene> = Scene.load($rawfile("gltf/CubeWithFloor/glTF/AnimatedCube.gltf"));
94    scene.then(async (result: Scene) => {
95      let sceneFactory: SceneResourceFactory = result.getResourceFactory();
96      let sceneCameraParameter: SceneNodeParameters = { name: "camera1" };
97      // 创建相机
98      let camera: Promise<Camera> = sceneFactory.createCamera(sceneCameraParameter);
99      camera.then(async (cameraEntity: Camera) => {
100        // 使能相机节点
101        cameraEntity.enabled = true;
102
103        // 设置相机的位置
104        cameraEntity.position.z = 5;
105
106        // 设置相机Fov参数
107        cameraEntity.fov = 60 * Math.PI / 180;
108
109        // 可以参照此方式设置相机很多其他的参数
110        // ...
111      });
112      return camera;
113    });
114  });
115}
116```
117
118
119## 光源的创建及管理
120
1213D场景的光源是对于物理世界中光源的一种数据建模,模拟物理世界的光源对于3D场景中的物体产生影响。
122
123光源具有很多的类型,比如平行光、锥形光。平行光即是用来模拟生活中的太阳光照,发出的光线处处平行且强度均匀。锥形光则像是我们使用的手电筒,以一个点向一个扇形区域发射光线,且发出的光线会随着距离而衰减。光源的颜色也会对场景中的物体最终的着色产生影响,光源颜色与物体颜色相互作用的计算与真实物理世界保持一致。ArkGraphics 3D提供了创建光源,修改光源各种参数的能力,支撑开发者通过对于光源属性的设置对于3D场景进行调整,得到期望的渲染效果。
124
125光源相关控制的示例代码如下:
126```ts
127import { Image, Shader, MaterialType, Material, ShaderMaterial, Animation, Environment, Container, SceneNodeParameters,
128  LightType, Light, Camera, SceneResourceParameters, SceneResourceFactory, Scene, Node } from '@kit.ArkGraphics3D';
129
130function createLightPromise() : Promise<Light> {
131  return new Promise(() => {
132    let scene: Promise<Scene> = Scene.load($rawfile("gltf/CubeWithFloor/glTF/AnimatedCube.gltf"));
133    scene.then(async (result: Scene) => {
134      let sceneFactory: SceneResourceFactory = result.getResourceFactory();
135      let sceneLightParameter: SceneNodeParameters = { name: "light" };
136      // 创建平行光
137      let light: Promise<Light> = sceneFactory.createLight(sceneLightParameter, LightType.DIRECTIONAL);
138      light.then(async (lightEntity: Light) => {
139        // 设置平行光的颜色属性
140        lightEntity.color = { r: 0.8, g: 0.1, b: 0.2, a: 1.0 };
141
142        // 可以参照此方式设置光源很多其他的参数
143        // ...
144      });
145      return light;
146    });
147  });
148}
149```
150
151## 相关实例
152
153对于模型、相机和光源更加综合的使用可以参考以下实例:
154- [3D引擎接口示例(ArkTS)(API12)](https://gitee.com/openharmony/applications_app_samples/tree/master/code/BasicFeature/Graphics/Graphics3d) 
155
156