Three Vue3Three Vue3
指南
在线演示
AI 智能体
  • English
  • 简体中文
GitHub
指南
在线演示
AI 智能体
  • English
  • 简体中文
GitHub
    • 快速开始
    • 场景
    • 参数总线
    • 天空盒
    • 模型加载器

      • 组件加载器
      • 函数加载器
    • 弹出窗口
    • 标注
    • 动态元素
    • 动画
    • 模型旋转器
    • 拾取
    • 相机自适应
    • 网格模型

      • 波动圆
      • 流动线网格
    • 效果

      • 自然

        • 雨
        • 雪
        • 海洋水面
        • 互动水池
        • 沙滩漫步
      • 天空与大气

        • 天空穹顶
        • 高度雾
        • 星云星系
      • 光照

        • 泛光
        • 扫光
        • 灯光渐变
        • 光柱
        • 雷达扫描
        • 信号波
        • 力场护盾
      • 粒子与精灵

        • 烟花
        • 文字烟花
          • 默认用法
          • 配置项
          • 成员
          • 方法
          • 类用法
        • 光晕精灵
    • 地理

      • 地理参考系
      • GeoObject 地理对象
      • GeoJsonLayer 图层
      • 瓦片图层

类型

类

TextFireworks 会把一行文字采样成字形粒子,并把它变成一场烟花。调用 launch() 后文字四散成若干组彩色爆炸,随后每个粒子又被拉回它原来的像素位置,重新看到可读的文字。每个粒子都是一块面向相机、以 CSS 像素定尺寸的四边形,因此无论距离多远都能保持一致的观感。

文字会被绘制到离屏 canvas 上并按固定网格采样,worldScale 负责把采样像素换算成世界单位。该类会自行推进时间轴,update(delta) 是可选的。

默认用法

点击我查看代码
<template>
  <div>
    <div class="toolbar">
      <input v-model="text" class="input" placeholder="输入一句话" @keyup.enter="launch" />
      <button type="button" class="button" @click="launch">发射</button>
    </div>
    <tv-scene class="scene" bg-color="rgb(40, 42, 54)" @created="created"></tv-scene>
  </div>
</template>

<script lang="ts" setup>
import { onBeforeUnmount, ref } from 'vue'
import { TextFireworks } from 'three-vue3'

const DEFAULT_TEXT = 'Good things are coming'

const text = ref(DEFAULT_TEXT)
let effect: TextFireworks | undefined

const created = (scene, { camera }) => {
  camera.position.set(0, 1, 6)
  camera.lookAt(0, 1, 0)

  effect = new TextFireworks({ text: DEFAULT_TEXT })
  scene.add(effect)
}

const launch = () => {
  if (!effect) return
  // 采样新的句子会重建粒子,然后重新播放一轮。
  effect.setText(text.value)
  effect.launch()
}

onBeforeUnmount(() => {
  effect?.dispose()
  effect = undefined
})
</script>

<style>
.scene {
  margin-top: 10px;
  margin-bottom: 16px;
  width: 100%;
  height: 300px;
}
.toolbar {
  display: flex;
  gap: 8px;
  margin-top: 10px;
}
.input {
  flex: 1;
  padding: 6px 10px;
  border-radius: 6px;
  border: 1px solid var(--vp-c-divider);
  background: var(--vp-c-bg);
  color: var(--vp-c-text-1);
}
.button {
  padding: 6px 14px;
  border-radius: 6px;
  cursor: pointer;
  color: var(--vp-c-white);
  background: var(--vp-c-brand-1);
  border: none;
}
</style>

配置项

名称类型默认值描述
textstring'Good things are coming'可选 被采样为粒子的文字。
colorsColorRepresentation[]['#ff8a3d', '#ffd166', '#4aa8ff', '#b06cff']可选 从左到右各组爆炸的颜色。
burstCenters[number, number][]四个错开的位置可选 各组爆炸中心,单位为世界单位。
burstScalenumber1可选 同时作用于爆炸中心和径向扩散的缩放。
groupDelaynumber0.22可选 相邻两组起爆的间隔,单位为秒。
groupJitternumber0.2可选 每个粒子的额外随机延迟,单位为秒。
pointSizenumber3.4可选 粒子大小,单位为 CSS 像素。
trailOffsetnumber0.105可选 拖尾层相对主层滞后的秒数。
trailOpacitynumber0.34可选 拖尾层的不透明度倍率。
restColorColorRepresentation0xffd4ad可选 文字静止以及最终回落的颜色。
worldScalenumber0.0068可选 每个采样到的 canvas 像素对应的世界单位。
offsetYnumber0.55可选 文字中心在世界坐标中的纵向偏移。
autoPlaybooleantrue可选 创建后是否自动播放一次。
autoPlayDelaynumber1.2可选 自动起爆前的等待秒数,由 update(delta) 累计。
seednumber1可选 每个粒子确定性随机数的种子。

成员

名称类型描述
pointsMesh主粒子层。
trailMesh滞后、更暗的同批粒子拖尾层。
textstring当前被采样为粒子云的文字。
particleCountnumber字形粒子数量,每个都渲染为一块公告板四边形。
durationnumber一轮「升起 / 爆炸 / 回落」的时长,单位为秒。
phasenumber时间轴上的当前位置,单位为秒。
playingboolean时间轴当前是否在推进。

方法

名称描述
update(delta)可选:手动推进时间轴;该类本身也会自行计时。
launch()从 0 重新开始「升起 / 爆炸 / 回落」这一轮。
setText(text)重新采样新的文字,并回到静止状态。
dispose()销毁几何体与两个材质,并从父级移除整个分组。

类用法

import { TextFireworks } from 'three-vue3'

const effect = new TextFireworks({ text: 'Good things are coming', autoPlay: false })
scene.add(effect)

// 效果会自行推进动画,`update(delta)` 是可选的。

// 用相同文字重播,或采样新的一行:
effect.launch()
effect.setText('Hello')

// 销毁时:
effect.dispose()
在 GitHub 上编辑此页
Last Updated:
Contributors: Shing Rui
Prev
烟花
Next
光晕精灵