SceneResource

The SceneResource module provides basic resource 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 { SceneResourceType, SceneResource, Shader, MaterialType, CullMode, Blend, RenderSort, Material,
  MaterialProperty, MetallicRoughnessMaterial, ShaderMaterial, SamplerFilter, SamplerAddressMode, Sampler,
  SubMesh, Morpher, Mesh, MeshResource, Animation, EnvironmentBackgroundType, Environment, Image } from '@kit.ArkGraphics3D';

SceneResourceType

Enumerates the scene resource types, which are used to classify resources in a scene.

System capability: SystemCapability.ArkUi.Graphics3D

SceneResource

Describes a resource in a scene.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

destroy

destroy(): void

Destroys the scene resource and releases all associated resources or references. Once released, the resource can no longer be used or accessed.

System capability: SystemCapability.ArkUi.Graphics3D

Example

import { Image, Shader, MaterialType, Material, ShaderMaterial, Animation, Environment, Container, SceneNodeParameters,
  LightType, Light, Camera, SceneResourceParameters, SceneResourceFactory, Scene, Node } from '@kit.ArkGraphics3D';

function destroy() : void {
  let scene: Promise<Scene> = Scene.load($rawfile("gltf/CubeWithFloor/glTF/AnimatedCube.gltf"));
  scene.then(async (result: Scene) => {
    if (result) {
      let sceneFactory: SceneResourceFactory = result.getResourceFactory();
      let sceneResourceParameter: SceneResourceParameters = { name: "shaderResource",
        uri: $rawfile("shaders/custom_shader/custom_material_sample.shader") };
      let shader: Promise<Shader> = sceneFactory.createShader(sceneResourceParameter);
      shader.then(async (shaderResult:Shader) => {
         // Release the resource.
         shaderResult.destroy();
      });
    }
  });
}

Shader

Shader resource, which inherits from SceneResource.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

MaterialType

Enumerates the material types in a scene. The material type defines how materials in a scene are rendered.

System capability: SystemCapability.ArkUi.Graphics3D

CullMode²⁰⁺

Enumerates the culling modes of PBR materials. You can improve rendering performance and visual quality by determining whether the front or back faces of objects are culled.

System capability: SystemCapability.ArkUi.Graphics3D

Blend²⁰⁺

Controls the transparency of materials.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

RenderSort²⁰⁺

Describes the order in which materials are rendered, controlling the sequence of drawing in the rendering pipeline.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

Material

Material resource, which inherits from SceneResource.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

MaterialProperty²⁰⁺

Defines the textures, property factors, and texture samplers used by a material.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

MetallicRoughnessMaterial²⁰⁺

Material resource for creating realistic appearances, using the Metallic-Roughness model based on PBR. It simulates the surface lighting and reflection effects of different materials like metal and plastic by adjusting metallicity and roughness parameters. It inherits from Material.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

ShaderMaterial

Shader material, which inherits from Material.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

SamplerFilter²⁰⁺

Enumerates the filtering modes of a sampler. The filtering mode determines the interpolation method used when sampling textures, controlling how final pixel colors are calculated during texture scaling or deformation.

System capability: SystemCapability.ArkUi.Graphics3D

SamplerAddressMode²⁰⁺

Enumerates the sampler addressing modes, which are used to control how texture coordinates are handled when they go beyond the [0, 1] range.

System capability: SystemCapability.ArkUi.Graphics3D

Sampler²⁰⁺

Describes the sampling modes used during texture sampling.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

SubMesh

Sub-mesh resource.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

Morpher²⁰⁺

Defines the deformation of 3D models by adjusting the weights of different deformation targets to create dynamic effects.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

Mesh

Mesh resource, which inherits from SceneResource.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

MeshResource¹⁸⁺

Mesh resource, which inherits from SceneResource.

System capability: SystemCapability.ArkUi.Graphics3D

Animation

Animation resource, which inherits from SceneResource.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

onFinished

onFinished(callback: Callback<void>): void

Called when the animation playback is complete or the finish API is called.

System capability: SystemCapability.ArkUi.Graphics3D

Parameters |Name|Type|Mandatory|Description| |—-|—-|—-|—-| |callback|Callback<void>|Yes|Callback function. The return value is null.|

Example

import { Image, Shader, MaterialType, Material, ShaderMaterial, Animation, Environment, Container, SceneNodeParameters,
  LightType, Light, Camera, SceneResourceParameters, SceneResourceFactory, Scene, Node } from '@kit.ArkGraphics3D';

function onFinished() : void {
  let scene: Promise<Scene> = Scene.load($rawfile("gltf/CubeWithFloor/glTF/AnimatedCube.gltf"));
  scene.then(async (result: Scene) => {
    if (result) {
      let anim: Animation = result.animations[0];
      // Register a callback.
      anim.onFinished(()=>{
        console.info("onFinished");  
      });
    }
  });
}

onStarted

onStarted(callback: Callback<void>): void

Called when the animation starts to play. The start operation is triggered by calling start or restart.

Parameters |Name|Type|Mandatory|Description| |—-|—-|—-|—-| |callback|Callback<void>|Yes|Callback function. The return value is null.|

System capability: SystemCapability.ArkUi.Graphics3D

Example

import { Image, Shader, MaterialType, Material, ShaderMaterial, Animation, Environment, Container, SceneNodeParameters,
  LightType, Light, Camera, SceneResourceParameters, SceneResourceFactory, Scene, Node } from '@kit.ArkGraphics3D';

function onStarted() : void {
  let scene: Promise<Scene> = Scene.load($rawfile("gltf/CubeWithFloor/glTF/AnimatedCube.gltf"));
  scene.then(async (result: Scene) => {
    if (result) {
      let anim: Animation = result.animations[0];
      // Register a callback.
      anim.onStarted(()=>{
        console.info("onStarted");  
      });
    }
  });
}

pause

pause(): void

Pauses the animation. The animation remains in the current playing progress.

System capability: SystemCapability.ArkUi.Graphics3D

Example

import { Image, Shader, MaterialType, Material, ShaderMaterial, Animation, Environment, Container, SceneNodeParameters,
  LightType, Light, Camera, SceneResourceParameters, SceneResourceFactory, Scene, Node } from '@kit.ArkGraphics3D';

function pause() : void {
  let scene: Promise<Scene> = Scene.load($rawfile("gltf/CubeWithFloor/glTF/AnimatedCube.gltf"));
  scene.then(async (result: Scene) => {
    if (result) {
      let anim: Animation = result.animations[0];
      // Pause the animation.
      anim.pause();
    }
  });
}

restart

restart(): void

Plays the animation from the beginning.

System capability: SystemCapability.ArkUi.Graphics3D

Example

import { Image, Shader, MaterialType, Material, ShaderMaterial, Animation, Environment, Container, SceneNodeParameters,
  LightType, Light, Camera, SceneResourceParameters, SceneResourceFactory, Scene, Node } from '@kit.ArkGraphics3D';

function restart() : void {
  let scene: Promise<Scene> = Scene.load($rawfile("gltf/CubeWithFloor/glTF/AnimatedCube.gltf"));
  scene.then(async (result: Scene) => {
    if (result) {
      let anim: Animation = result.animations[0];
      // Restart the animation.
      anim.restart();
    }
  });
}

seek

seek(position: number): void

Plays the animation from the specified position.

System capability: SystemCapability.ArkUi.Graphics3D

Parameters |Name|Type|Mandatory|Description| |—-|—-|—-|—-| |position|number|Yes|Position from which the animation playback starts. The value range is [0, 1].|

Example

import { Image, Shader, MaterialType, Material, ShaderMaterial, Animation, Environment, Container, SceneNodeParameters,
  LightType, Light, Camera, SceneResourceParameters, SceneResourceFactory, Scene, Node } from '@kit.ArkGraphics3D';

function seek() : void {
  let scene: Promise<Scene> = Scene.load($rawfile("gltf/CubeWithFloor/glTF/AnimatedCube.gltf"));
  scene.then(async (result: Scene) => {
    if (result) {
      let anim: Animation = result.animations[0];
      // Set the animation playback progress to 10%.
      anim.seek(0.1);
    }
  });
}

start

start(): void

Plays the animation based on the current progress.

System capability: SystemCapability.ArkUi.Graphics3D

Example

import { Image, Shader, MaterialType, Material, ShaderMaterial, Animation, Environment, Container, SceneNodeParameters,
  LightType, Light, Camera, SceneResourceParameters, SceneResourceFactory, Scene, Node } from '@kit.ArkGraphics3D';

function start() : void {
  let scene: Promise<Scene> = Scene.load($rawfile("gltf/CubeWithFloor/glTF/AnimatedCube.gltf"));
  scene.then(async (result: Scene) => {
    if (result) {
      let anim: Animation = result.animations[0];
      // Start the animation.
      anim.start();
    }
  });
}

stop

stop(): void

Stops playing the animation and sets its progress to 0 (not started).

System capability: SystemCapability.ArkUi.Graphics3D

Example

import { Image, Shader, MaterialType, Material, ShaderMaterial, Animation, Environment, Container, SceneNodeParameters,
  LightType, Light, Camera, SceneResourceParameters, SceneResourceFactory, Scene, Node } from '@kit.ArkGraphics3D';

function stop() : void {
  let scene: Promise<Scene> = Scene.load($rawfile("gltf/CubeWithFloor/glTF/AnimatedCube.gltf"));
  scene.then(async (result: Scene) => {
    if (result) {
      let anim: Animation = result.animations[0];
      // Stop playing the animation and set its progress to 0 (not started).
      anim.stop();
    }
  });
}

finish

finish(): void

Finishes the playing of the animation and sets its progress of 1 (finished).

System capability: SystemCapability.ArkUi.Graphics3D

import { Image, Shader, MaterialType, Material, ShaderMaterial, Animation, Environment, Container, SceneNodeParameters,
  LightType, Light, Camera, SceneResourceParameters, SceneResourceFactory, Scene, Node } from '@kit.ArkGraphics3D';

function finish() : void {
  let scene: Promise<Scene> = Scene.load($rawfile("gltf/CubeWithFloor/glTF/AnimatedCube.gltf"));
  scene.then(async (result: Scene) => {
    if (result) {
      let anim: Animation = result.animations[0];
      // Finish the playing of the animation and set its progress of **1** (finished).
      anim.finish();
    }
  });
}

EnvironmentBackgroundType

Enumerates the environment background types, which are used to define how the background of a scene is presented.

System capability: SystemCapability.ArkUi.Graphics3D

Environment

Environment resource, which inherits from SceneResource.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

Image

Image resource, which inherits from SceneResource.

Properties

System capability: SystemCapability.ArkUi.Graphics3D

你可能感兴趣的鸿蒙文章

harmony 鸿蒙ArkGraphics 3D

harmony 鸿蒙SceneNode

harmony 鸿蒙ScenePostProcessSettings

harmony 鸿蒙SceneType

harmony 鸿蒙Scene

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