Component Loader | Three Vue3

type

Component

GLTF Loader

Default Usage

Click me to view the codes

<template>
  <tv-scene class="scene" @created="created">
    <tv-gltf-loader v-model="gltfUrl" :scale="[0.8, 0.8, 0.8]"></tv-gltf-loader>
  </tv-scene>
</template>

<script lang="ts" setup>
import { ref } from 'vue'

const gltfUrl = ref('/models/perseverance.glb')

const created = (scene, { camera }) => {
  camera.position.set(0, 1.5, 3)
}
</script>

<style>
.scene {
  margin-top: 10px;
  width: 100%;
  height: 300px;
}
</style>

FBX Loader

Default Usage

Click me to view the codes

<template>
  <tv-scene class="scene" @created="created">
    <tv-fbx-loader v-model="fbxUrl" :scale="[0.8, 0.8, 0.8]"></tv-fbx-loader>
  </tv-scene>
</template>

<script lang="ts" setup>
import { ref } from 'vue'

const fbxUrl = ref('/models/perseverance.fbx')

const created = (scene, { camera }) => {
  camera.position.set(0, 1.5, 3)
}
</script>

<style>
.scene {
  margin-top: 10px;
  width: 100%;
  height: 300px;
}
</style>

OBJ Loader

Default Usage

Click me to view the codes

<template>
  <tv-scene class="scene" @created="created">
    <tv-obj-loader v-model="objUrl" :mtl="mtlUrl" :scale="[0.8, 0.8, 0.8]"></tv-obj-loader>
  </tv-scene>
</template>

<script lang="ts" setup>
import { ref } from 'vue'

const objUrl = ref('/models/obj/perseverance.obj')
const mtlUrl = ref('/models/obj/perseverance.mtl')

const created = (scene, { camera }) => {
  camera.position.set(0, 1.5, 3)
}
</script>

<style>
.scene {
  margin-top: 10px;
  width: 100%;
  height: 300px;
}
</style>

Props

Name	Type	Default	Description
v-model	string	string	`required` The model url.
scene	THREE.Scene	THREE.Scene	`required` The Scene where the model will be rendered.
scale	[number, number, number]	[1.0, 1.0, 1.0]	`optional` The scale of the model.
cache	boolean	true	`optional` The model will be cached into the indexDB.
mtl	string		`optional` When using OBJLoader, the mtl file url.

Methods

Name	Parameters	Description
onProgress	(event: {type: string, progress: number}) => void	The callback function when loading the model.
loaded	(model: THREE.Mesh) => void	The callback function that will be called when the model is loaded.