当前仓库属于关闭状态,部分功能使用受限,详情请查阅 仓库状态说明
1.4K Star 7.4K Fork 8.2K

OpenHarmony/docs
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
docker
en
zh-cn
application-dev
IDL
account
ads-service/oaid
ai
application-models
application-test
arkts-utils
communication
connectivity
database
device-usage-statistics
device
dfx
faqs
file-management
internationalization
key-features/multi-device-app-dev
kit-readme
media
napi
notification
performance
public_sys-resources
quick-start
reference
apis
arkui-js-lite
arkui-js
arkui-ts
figures
public_sys-resources
Readme-CN.md
ohos-arkui-advanced-counter.md
ohos-arkui-advanced-popup.md
ohos-arkui-advanced-segmentbutton.md
ohos-multimedia-avcastpicker.md
ts-animatorproperty.md
ts-appendix-enums.md
ts-basic-components-blank.md
ts-basic-components-button.md
ts-basic-components-calendarpicker.md
ts-basic-components-checkbox.md
ts-basic-components-checkboxgroup.md
ts-basic-components-component3d.md
ts-basic-components-datapanel.md
ts-basic-components-datepicker.md
ts-basic-components-divider.md
ts-basic-components-formcomponent.md
ts-basic-components-gauge.md
ts-basic-components-image.md
ts-basic-components-imageanimator.md
ts-basic-components-imagespan.md
ts-basic-components-loadingprogress.md
ts-basic-components-marquee.md
ts-basic-components-menu.md
ts-basic-components-menuitem.md
ts-basic-components-menuitemgroup.md
ts-basic-components-navdestination.md
ts-basic-components-navigation.md
ts-basic-components-navrouter.md
ts-basic-components-patternlock.md
ts-basic-components-plugincomponent.md
ts-basic-components-progress.md
ts-basic-components-qrcode.md
ts-basic-components-radio.md
ts-basic-components-rating.md
ts-basic-components-remotewindow.md
ts-basic-components-richeditor.md
ts-basic-components-richtext.md
ts-basic-components-scrollbar.md
ts-basic-components-search.md
ts-basic-components-select.md
ts-basic-components-slider.md
ts-basic-components-span.md
ts-basic-components-stepper.md
ts-basic-components-stepperitem.md
ts-basic-components-text.md
ts-basic-components-textarea.md
ts-basic-components-textclock.md
ts-basic-components-textinput.md
ts-basic-components-textpicker.md
ts-basic-components-texttimer.md
ts-basic-components-timepicker.md
ts-basic-components-toggle.md
ts-basic-components-web.md
ts-basic-components-xcomponent.md
ts-basic-gestures-longpressgesture.md
ts-basic-gestures-pangesture.md
ts-basic-gestures-pinchgesture.md
ts-basic-gestures-rotationgesture.md
ts-basic-gestures-swipegesture.md
ts-basic-gestures-tapgesture.md
ts-canvasrenderingcontext2d.md
ts-combined-gestures.md
ts-components-canvas-canvas.md
ts-components-canvas-canvasgradient.md
ts-components-canvas-canvaspattern.md
ts-components-canvas-imagebitmap.md
ts-components-canvas-imagedata.md
ts-components-canvas-matrix2d.md
ts-components-canvas-path2d.md
ts-components-offscreencanvas.md
ts-components-summary.md
ts-composite-components-chip.md
ts-composite-components-composelistitem.md
ts-composite-components-composetitlebar.md
ts-composite-components-dialog.md
ts-composite-components-editabletitlebar.md
ts-composite-components-filter.md
ts-composite-components-progressbutton.md
ts-composite-components-selectionmenu.md
ts-composite-components-selecttitlebar.md
ts-composite-components-splitlayout.md
ts-composite-components-subheader.md
ts-composite-components-swiperefresher.md
ts-composite-components-tabtitlebar.md
ts-composite-components-toolbar.md
ts-composite-components-treeview.md
ts-container-ability-component.md
ts-container-alphabet-indexer.md
ts-container-badge.md
ts-container-column.md
ts-container-columnsplit.md
ts-container-counter.md
ts-container-effectcomponent.md
ts-container-flex.md
ts-container-flowitem.md
ts-container-folderstack.md
ts-container-formlink.md
ts-container-grid.md
ts-container-gridcol.md
ts-container-gridcontainer.md
ts-container-griditem.md
ts-container-gridrow.md
ts-container-hyperlink.md
ts-container-list.md
ts-container-listitem.md
ts-container-listitemgroup.md
ts-container-navigator.md
ts-container-panel.md
ts-container-refresh.md
ts-container-relativecontainer.md
ts-container-row.md
ts-container-rowsplit.md
ts-container-scroll.md
ts-container-sidebarcontainer.md
ts-container-stack.md
ts-container-swiper.md
ts-container-tabcontent.md
ts-container-tabs.md
ts-container-ui-extension-component.md
ts-container-waterflow.md
ts-custom-component-api.md
ts-custom-component-lifecycle.md
ts-drawing-components-circle.md
ts-drawing-components-ellipse.md
ts-drawing-components-line.md
ts-drawing-components-path.md
ts-drawing-components-polygon.md
ts-drawing-components-polyline.md
ts-drawing-components-rect.md
ts-drawing-components-shape.md
ts-explicit-animatetoimmediately.md
ts-explicit-animation.md
ts-gesture-customize-judge.md
ts-gesture-settings.md
ts-keyframeAnimateTo.md
ts-media-components-video.md
ts-methods-action-sheet.md
ts-methods-alert-dialog-box.md
ts-methods-calendarpicker-dialog.md
ts-methods-custom-dialog-box.md
ts-methods-datepicker-dialog.md
ts-methods-menu.md
ts-methods-textpicker-dialog.md
ts-methods-timepicker-dialog.md
ts-motion-path-animation.md
ts-offscreencanvasrenderingcontext2d.md
ts-page-transition-animation.md
ts-particle-animation.md
ts-pixel-units.md
ts-security-components-locationbutton.md
ts-security-components-pastebutton.md
ts-security-components-savebutton.md
ts-securitycomponent-attributes.md
ts-state-management.md
ts-transition-animation-component.md
ts-transition-animation-geometrytransition.md
ts-transition-animation-shared-elements.md
ts-types.md
ts-universal-attributes-accessibility.md
ts-universal-attributes-attribute-modifier.md
ts-universal-attributes-background.md
ts-universal-attributes-border-image.md
ts-universal-attributes-border.md
ts-universal-attributes-click-effect.md
ts-universal-attributes-click.md
ts-universal-attributes-component-id.md
ts-universal-attributes-cursor.md
ts-universal-attributes-drag-drop.md
ts-universal-attributes-enable.md
ts-universal-attributes-expand-safe-area.md
ts-universal-attributes-flex-layout.md
ts-universal-attributes-focus.md
ts-universal-attributes-foreground-blur-style.md
ts-universal-attributes-foreground-color.md
ts-universal-attributes-gradient-color.md
ts-universal-attributes-grid.md
ts-universal-attributes-hit-test-behavior.md
ts-universal-attributes-hover-effect.md
ts-universal-attributes-image-effect.md
ts-universal-attributes-layout-constraints.md
ts-universal-attributes-location.md
ts-universal-attributes-menu.md
ts-universal-attributes-modal-transition.md
ts-universal-attributes-monopolize-events.md
ts-universal-attributes-obscured.md
ts-universal-attributes-on-child-touch-test.md
ts-universal-attributes-opacity.md
ts-universal-attributes-outline.md
ts-universal-attributes-overlay.md
ts-universal-attributes-polymorphic-style.md
ts-universal-attributes-popup.md
ts-universal-attributes-renderfit.md
ts-universal-attributes-restoreId.md
ts-universal-attributes-sharp-clipping.md
ts-universal-attributes-sheet-transition.md
ts-universal-attributes-size.md
ts-universal-attributes-text-style.md
ts-universal-attributes-touch-target.md
ts-universal-attributes-transformation.md
ts-universal-attributes-use-effect.md
ts-universal-attributes-visibility.md
ts-universal-attributes-z-order.md
ts-universal-component-area-change-event.md
ts-universal-component-visible-area-change-event.md
ts-universal-events-click.md
ts-universal-events-drag-drop.md
ts-universal-events-key.md
ts-universal-events-keyboardshortcut.md
ts-universal-events-show-hide.md
ts-universal-events-touch.md
ts-universal-focus-event.md
ts-universal-mouse-key.md
errorcodes
figures
js-service-widget-ui
native-apis
native-lib
Readme-CN.md
native-api-intro.md
syscap-list.md
syscap.md
security
task-management
telephony
tools
ui
web
webgl
windowmanager
Readme-CN.md
Samples.md
application-dev-guide-for-gitee.md
application-dev-guide.md
website.md
contribute
design
device-dev
figures
readme
release-notes
third-party-cases
third-party-components
Legal-Notices.md
OpenHarmony-Overview_zh.md
glossary.md
readme.md
website.md
.gitattributes
.gitignore
CODEOWNERS
DCO.txt
LICENSE
OAT.xml
README.md
README_zh.md
image.png
克隆/下载
ts-basic-components-component3d.md 6.06 KB
一键复制 编辑 原始数据 按行查看 历史
胡笑鸣 提交于 2年前 . add component3d

Component3D

3D渲染组件,可以加载3D模型资源并做自定义渲染,通常用于3D动效场景。

说明:

该组件从API Version 11开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

子组件

接口

Component3D((sceneOptions?: SceneOptions))

参数:

参数名 参数类型 必填 参数描述
sceneOptions SceneOptions 3D场景配置选项。
说明:
3D场景配置选项在控件创建后不支持动态修改。

SceneOptions对象说明

Component3D组件配置选项。

名称 类型 必填 说明
scene Resource 3D模型资源文件。
说明:
目前仅支持GLTF格式资源。
modelType ModelType 3D场景显示合成方式。
默认值:ModelType.SURFACE
说明:
设置为ModelType.TEXTURE时通过GPU合成显示。
设置为ModelType.SURFACE时通过专有硬件合成显示。
一般开发者可以使用默认值而无需关心此项设置。

ModelType枚举说明

名称 描述
TEXTURE 使用GPU合成显示3D场景。
SURFACE 使用专有硬件显示3D场景。

属性

除支持通用属性外,还支持以下属性:

名称 参数类型 描述
environment Resource 设置3D环境资源。
说明:
目前仅支持GLTF格式资源,模型资源在控件创建后不支持动态修改。
customRender uri: Resource
selfRenderUpdate: boolean
uri:自定义渲染管线的配置文件。
selfRenderUpdate: 当设置为true时外部UI没有更新时也能触发动效渲染,当设置为false时只有外部UI更新才能触发渲染。
说明:
管线配置及自渲染属性在控件创建后不支持动态修改。
shader Resource 自定义渲染的shader文件资源。
说明:
自定义渲染的shader文件资源在控件创建后不支持动态修改。
shaderImageTexture Resource 自定义渲染用到的纹理资源。
说明:
若自定义渲染用到多个纹理资源则则调用多次,绑定点与调用顺序一致,不支持纹理更换。纹理资源在控件创建后不支持动态修改。
shaderInputBuffer Array<number> 自定义渲染用到的动效参数。
renderWidth Dimension 3D渲染分辨率的宽度。
说明:
渲染分辨率的长宽可以不同于控件的长宽,若渲染分辨率与控件分辨率长宽不一致时会上采样或下采样到控件长宽。
不调用此属性时默认渲染分辨率。
渲染分辨率在控件创建后不支持动态修改。
renderHeight Dimension 3D渲染分辨率的长度。
说明:
渲染分辨率的长宽可以不同于控件的长宽,若渲染分辨率与控件分辨率长宽不一致时会上采样或下采样到控件长宽。
不调用此属性时默认渲染分辨率。
渲染分辨率在控件创建后不支持动态修改。

事件

支持通用事件

示例

示例效果请以真机运行为准,当前IDE预览器不支持。
GLTF模型加载示例。

// xxx.ets
@Entry
@Component
struct Index {
  scene: SceneOptions = { scene: $rawfile('gltf/DamageHemlt/glTF/DamagedHelmet.gltf'), modelType: ModelType.SURFACE};
  build() {
    Row() {
      Column() {
        Text('GLTF Example')
        Component3D( this.scene )
          .environment($rawfile('gltf/Environment/glTF/Environment.gltf'))
          .renderWidth('90%').renderHeight('90%')
      }.width('100%')
    }
    .height('100%')
  }
}

自定义渲染示例。

import animator, { AnimatorResult } from '@ohos.animator';
class EngineTime {
  totalTimeUs = 0;
  deltaTimeUs = 0;
};

let engineTime = new EngineTime();
let frameCount: number = 0;

function TickFrame() {
  if (frameCount == 10) {
    engineTime.totalTimeUs += 1.0;
    engineTime.deltaTimeUs += 1.0;
    frameCount = 0;
  } else {
    frameCount++;
  }
}

@Entry
@Component
struct Index {
  scene: SceneOptions = { scene: $rawfile('gltf/DamageHemlt/glTF/DamagedHelmet.gltf'), modelType: ModelType.SURFACE};
  backAnimator: AnimatorResult = animator.create({
    duration: 2000,
    easing: "ease",
    delay: 0,
    fill: "none",
    direction: "normal",
    iterations: -1,
    begin: 100,
    end: 200,
  });
  @State timeDelta: number[] = [1.0, 2.0];
  create() {
    this.backAnimator.onfinish = () => {
      console.log('backAnimator onfinish');
    }
    this.backAnimator.onframe = value => {
      TickFrame();
      this.timeDelta[0] = engineTime.deltaTimeUs;
    }

  }
  build() {
    Row() {
      Column() {
        Text('custom rendering')
        Component3D()
          .shader($rawfile('assets/app/shaders'))
          .shaderImageTexture($rawfile('assets/London.jpg'))
          .shaderInputBuffer(this.timeDelta)
          .customRender($rawfile('assets/app/rendernodegraphs/London.rng'), true)
          .renderWidth('90%').renderHeight('90%')
          .onAppear(() => {
            this.create();
            this.backAnimator.play();
          }).width('50%').height('50%')
      }.width('100%')
    }
    .height('100%')
  }
}
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
其他
1
https://gitee.com/openharmony/docs.git
git@gitee.com:openharmony/docs.git
openharmony
docs
docs
OpenHarmony-4.1-Beta1

搜索帮助