目录

IArSceneView

Interface Info

public interface IArSceneView

AR展示场景组件,提供3D场景的模型呈现、AR场景真实环境识别与虚拟模型在真实环境的渲染。

Public Field Summary

Qualifier and Type

Field and Description

String

URL_SCHEMA_ASSET

传入应用内部文件路径所需添加的文件头,加载模型文件或背景文件时使用。

注意:

该常量已废弃,请使用IXrKitFeature.URL_SCHEMA_ASSET。

String

URL_SCHEMA_STORAGE

传入设备存储文件路径所需添加的文件头,加载模型或背景文件时使用。

注意:

该常量已废弃,请使用IXrKitFeature.URL_SCHEMA_STORAGE。

Public Method Summary

Qualifier and Type

Method Name and Description

void

destroy()

销毁IArSceneView场景,删除模型、关闭相机、清除数据,释放当前场景所有资源,关闭当前场景组件所提供的视图。

List<IModel>

getAllLoadedModels()

获取所有已加载的模型。

IModel

getSelectedModel()

获取选中模型。

view

getView()

获取IArSceneView场景的视图,用于在应用中显示。

void

loadModel(String url, Object modelTag)

在IArSceneView场景中加载虚拟模型。

void

pause()

暂停IArSceneView场景,不清除数据,调用后需要使用resume()恢复。

void

removeModel(IModel model)

在IArSceneView场景中,删除指定模型。

void

resume()

开始运行IArSceneView场景,或在调用pause()以后恢复IArSceneView场景的运行状态。

void

setArMode(boolean isArMode)

设置模式,true表示AR模式,false表示3D模式。

void

setBackground(String backgroundImageUrl)

设置3D模式下的背景。

void

setBodyOcclusionMode(boolean isOpenedOcclusion)

虚实主体遮挡开关,true开启虚实主体遮挡特性,false关闭。

void

setModelListener(IModelListener listener)

设置模型相关监听。

注意:

该方法已废弃,请使用IXrKitFeature.setFeatureEventListener。

void

setPlaneVisible(boolean visible)

设置AR场景下虚拟平面可见性,true为可见,false为不可见。

Public Fields

[h2]URL_SCHEMA_ASSET

该常量已废弃,请使用IXrKitFeature.URL_SCHEMA_ASSET。

Field

String URL_SCHEMA_ASSET

传入应用内部文件路径所需添加的文件头,加载模型文件或背景文件时使用。

另请参阅:Constant-values

[h2]URL_SCHEMA_STORAGE

该常量已废弃,请使用IXrKitFeature.URL_SCHEMA_STORAGE。

Field

String URL_SCHEMA_STORAGE

传入设备存储文件路径所需添加的文件头,加载模型或背景文件时使用。

另请参阅:Constant-values

Public Methods

[h2]destroy

Method

void destroy()

销毁IArSceneView场景,删除模型、关闭相机、清除数据,释放当前场景所有资源,关闭当前场景组件所提供的视图。

[h2]getAllLoadedModels

Method

List<IModel> getAllLoadedModels()

获取所有已加载的模型。

Returns

Type

Description

List<IModel>

选中的模型,实现自IModel。

[h2]getSelectedModel

Method

IModel getSelectedModel()

获取选中模型。

Returns

Type

Description

IModel

被选中的模型。

[h2]getView

Method

view getView()

获取IArSceneView场景的视图,用于在应用中显示。

Returns

Type

Description

view

IArSceneView场景的视图。

[h2]loadModel

Method

void loadModel(String url, Object modelTag)

在IArSceneView场景中加载虚拟模型。

Parameters

Name

Description

url

模型文件路径。

modelTag

模型标签。

[h2]pause

Method

void pause()

暂停IArSceneView场景,不清除数据,调用后需要使用resume()恢复。

[h2]removeModel

Method

void removeModel(IModel model)

在IArSceneView场景中,删除指定模型。

Parameters

Name

Description

model

模型类,实现自IModel。

[h2]resume

Method

void resume()

开始运行IArSceneView场景,或在调用pause()以后恢复IArSceneView场景的运行状态。

[h2]setArMode

Method

void setArMode(boolean isArMode)

设置模式,true表示AR模式,false表示3D模式。

Parameters

Name

Description

isArMode

模式标志,true表示AR模式,false表示3D模式。

[h2]setBackground

Method

void setBackground(String backgroundImageUrl)

设置3D模式下的背景。

Parameters

Name

Description

backgroundImageUrl

背景文件路径。

[h2]setBodyOcclusionMode

Method

default void setBodyOcclusionMode(boolean isOpenedOcclusion)

虚实主体遮挡开关,true开启虚实主体遮挡特性,false关闭,该接口在XRKit 11.1.1.330及以上版本生效。

Parameters

Name

Description

isOpenedOcclusion

虚实主体遮挡开关,true表示打开虚实主体遮挡,false表示关闭虚实主体遮挡。

Throws

Name

Description

XrKitUnavailableServiceApkTooOldException

设备上安装的XRKit APP版本不支持此方法时抛出异常。

[h2]setModelListener

该方法已废弃,请使用IXrKitFeature.setFeatureEventListener。

Method

void setModelListener(IModelListener listener)

设置模型相关监听。

Parameters

Name

Description

listener

模型监听,实现IModelListener接口。

[h2]setPlaneVisible

Method

void setPlaneVisible(boolean visible)

设置AR场景下虚拟平面可见性,true为可见,false为不可见。

Parameters

Name

Description

visible

平面可见性标志,true表示平面可见,false表示平面不可见。