程序包 ohos.agp.render.render3d.gltf

接口 GltfLoader

public interface GltfLoader

Imports 3D models and related data (such as animations and materials) from a glTF file.

从以下版本开始:

3

嵌套类概要

嵌套类

限定符和类型	接口	说明
static interface	GltfLoader.ImportListener	Listener for asynchronous import result.

字段概要

字段

限定符和类型	字段	说明
static int	RESOURCE_IMPORT_BIT_ANIMATION	Indicates the flag used to import animations.
static int	RESOURCE_IMPORT_BIT_IMAGE	Indicates the flag used to import images.
static int	RESOURCE_IMPORT_BIT_MATERIAL	Indicates the flag used to import materials.
static int	RESOURCE_IMPORT_BIT_MESH	Indicates the flag used to import meshes.
static int	RESOURCE_IMPORT_BIT_SAMPLER	Indicates the flag used to import samplers.
static int	RESOURCE_IMPORT_BIT_SKIN	Indicates the flag used to import skins.
static int	RESOURCE_IMPORT_BIT_TEXTURE	Indicates the flag used to import textures.
static int	RESOURCE_IMPORT_FLAG_BITS_ALL	Indicates the flag used to import all resources.
static int	SCENE_IMPORT_BIT_CAMERA	Indicates the flag used to import cameras.
static int	SCENE_IMPORT_BIT_LIGHT	Indicates the flag used to import lights.
static int	SCENE_IMPORT_BIT_MESH	Indicates the flag used to import meshes.
static int	SCENE_IMPORT_BIT_MORPH	Indicates the flag used to import morphing data.
static int	SCENE_IMPORT_BIT_SCENE	Indicates the flag used to import scenes.
static int	SCENE_IMPORT_BIT_SKIN	Indicates the flag used to import skins.
static int	SCENE_IMPORT_FLAG_BITS_ALL	Indicates the flag used to import all data.

方法概要

限定符和类型	方法	说明
int	getDefaultResourceImportFlags()	Obtains the default flag for importing resources.
int	getDefaultSceneImportFlags()	Obtains the default flag for importing scenes.
GltfImportData	importGltf(GltfData gltfData, int flags)	Imports the glTF data to the engine synchronously.
Task	importGltfAsync(GltfData gltfData, int flags, GltfLoader.ImportListener listener)	Creates a task for asynchronously importing glTF data.
Entity	importScene(int sceneIndex, GltfData data, GltfImportData importData, Entity rootEntity, int flags)	Imports a glTF scene from specified glTF data and resources.
GltfData	loadGltf(String gltfUri)	Loads a glTF file with a specified URI.
GltfData	loadGltf(ByteBuffer gltfBytes)	Loads a glTF data buffer of bytes.

字段详细资料

RESOURCE_IMPORT_BIT_ANIMATION

static final int RESOURCE_IMPORT_BIT_ANIMATION

Indicates the flag used to import animations. It is used in importGltf(ohos.agp.render.render3d.gltf.GltfData,int).

另请参阅:

常量字段值

RESOURCE_IMPORT_BIT_IMAGE

static final int RESOURCE_IMPORT_BIT_IMAGE

Indicates the flag used to import images. It is used in importGltf(ohos.agp.render.render3d.gltf.GltfData,int).

另请参阅:

常量字段值

RESOURCE_IMPORT_BIT_MATERIAL

static final int RESOURCE_IMPORT_BIT_MATERIAL

Indicates the flag used to import materials. It is used in importGltf(ohos.agp.render.render3d.gltf.GltfData,int).

另请参阅:

常量字段值

RESOURCE_IMPORT_BIT_MESH

static final int RESOURCE_IMPORT_BIT_MESH

Indicates the flag used to import meshes. It is used in importGltf(ohos.agp.render.render3d.gltf.GltfData,int).

另请参阅:

常量字段值

RESOURCE_IMPORT_BIT_SAMPLER

static final int RESOURCE_IMPORT_BIT_SAMPLER

Indicates the flag used to import samplers. It is used in importGltf(ohos.agp.render.render3d.gltf.GltfData,int).

另请参阅:

常量字段值

RESOURCE_IMPORT_BIT_SKIN

static final int RESOURCE_IMPORT_BIT_SKIN

Indicates the flag used to import skins. It is used in importGltf(ohos.agp.render.render3d.gltf.GltfData,int).

另请参阅:

常量字段值

RESOURCE_IMPORT_BIT_TEXTURE

static final int RESOURCE_IMPORT_BIT_TEXTURE

Indicates the flag used to import textures. It is used in importGltf(ohos.agp.render.render3d.gltf.GltfData,int).

另请参阅:

常量字段值

RESOURCE_IMPORT_FLAG_BITS_ALL

static final int RESOURCE_IMPORT_FLAG_BITS_ALL

Indicates the flag used to import all resources. It is used in importGltf(ohos.agp.render.render3d.gltf.GltfData,int).

另请参阅:

常量字段值

SCENE_IMPORT_BIT_CAMERA

static final int SCENE_IMPORT_BIT_CAMERA

Indicates the flag used to import cameras. It is used in importScene(int,ohos.agp.render.render3d.gltf.GltfData,ohos.agp.render.render3d.gltf.GltfImportData,ohos.agp.render.render3d.Entity,int).

另请参阅:

常量字段值

SCENE_IMPORT_BIT_LIGHT

static final int SCENE_IMPORT_BIT_LIGHT

Indicates the flag used to import lights. It is used in importScene(int,ohos.agp.render.render3d.gltf.GltfData,ohos.agp.render.render3d.gltf.GltfImportData,ohos.agp.render.render3d.Entity,int).

另请参阅:

常量字段值

SCENE_IMPORT_BIT_MESH

static final int SCENE_IMPORT_BIT_MESH

Indicates the flag used to import meshes. It is used in importScene(int,ohos.agp.render.render3d.gltf.GltfData,ohos.agp.render.render3d.gltf.GltfImportData,ohos.agp.render.render3d.Entity,int).

另请参阅:

常量字段值

SCENE_IMPORT_BIT_MORPH

static final int SCENE_IMPORT_BIT_MORPH

Indicates the flag used to import morphing data. It is used in importScene(int,ohos.agp.render.render3d.gltf.GltfData,ohos.agp.render.render3d.gltf.GltfImportData,ohos.agp.render.render3d.Entity,int).

另请参阅:

常量字段值

SCENE_IMPORT_BIT_SCENE

static final int SCENE_IMPORT_BIT_SCENE

Indicates the flag used to import scenes. It is used in importScene(int,ohos.agp.render.render3d.gltf.GltfData,ohos.agp.render.render3d.gltf.GltfImportData,ohos.agp.render.render3d.Entity,int).

另请参阅:

常量字段值

SCENE_IMPORT_BIT_SKIN

static final int SCENE_IMPORT_BIT_SKIN

Indicates the flag used to import skins. It is used in importScene(int,ohos.agp.render.render3d.gltf.GltfData,ohos.agp.render.render3d.gltf.GltfImportData,ohos.agp.render.render3d.Entity,int).

另请参阅:

常量字段值

SCENE_IMPORT_FLAG_BITS_ALL

static final int SCENE_IMPORT_FLAG_BITS_ALL

Indicates the flag used to import all data. It is used in importScene(int,ohos.agp.render.render3d.gltf.GltfData,ohos.agp.render.render3d.gltf.GltfImportData,ohos.agp.render.render3d.Entity,int).

另请参阅:

常量字段值

方法详细资料

getDefaultResourceImportFlags

int getDefaultResourceImportFlags()

Obtains the default flag for importing resources.

返回:

Returns the default flag for importing resources.

getDefaultSceneImportFlags

int getDefaultSceneImportFlags()

Obtains the default flag for importing scenes.

返回:

Returns the default flag for importing scenes.

loadGltf

GltfData loadGltf(String gltfUri)

Loads a glTF file with a specified URI.

参数:

gltfUri - Indicates the URI of the glTF file to be loaded.

返回:

Returns GltfData containing the load result.

loadGltf

GltfData loadGltf(ByteBuffer gltfBytes)

Loads a glTF data buffer of bytes.

参数:

gltfBytes - Indicates the glTF data to be loaded.

返回:

Returns GltfData containing the load result.

抛出:

IllegalArgumentException - Throws this exception if the glTF data buffer is not a direct buffer.

importGltf

GltfImportData importGltf(GltfData gltfData,
                          int flags)

Imports the glTF data to the engine synchronously.

参数:

gltfData - Indicates the glTF data in a parsed glTF file.

flags - Indicates the flag that specifies the resources to be imported, which can be set using getDefaultResourceImportFlags().

返回:

Returns a report containing the import result and the resources that have been imported.

importGltfAsync

Task importGltfAsync(GltfData gltfData,
                     int flags,
                     GltfLoader.ImportListener listener)

Creates a task for asynchronously importing glTF data.

This method does not import any data. Instead, it creates a task for importing data.

参数:

gltfData - Indicates the glTF data in a parsed glTF file.

flags - Indicates the flag that specifies the resources to be imported, which can be set using getDefaultResourceImportFlags().

listener - Indicates the listener that monitors the import.

返回:

Returns the task for asynchronously importing glTF data.

importScene

Entity importScene(int sceneIndex,
                   GltfData data,
                   GltfImportData importData,
                   Entity rootEntity,
                   int flags)

Imports a glTF scene from specified glTF data and resources.

参数:

sceneIndex - Indicates the index of the glTF scene to be imported.

data - Indicates the glTF data that contains structure information of the glTF scene to be created.

importData - Indicates the glTF resources that have been loaded, such as meshes and skins.

rootEntity - Indicates the root entity of the glTF scene to be imported. This parameter can be null.

flags - Indicates the flag that specifies the resources to be imported, which can be set using getDefaultResourceImportFlags().

返回:

Returns the root entity of the glTF scene.