Instances

L'idée principale de Tres est un catalogue généré automatiquement de tous les éléments ThreeJS. Ce catalogue est généré à partir du code source ThreeJS, il est donc toujours à jour.

Lorsque vous utilisez ThreeJS, vous devez importer les éléments que vous souhaitez utiliser. Par exemple, si vous souhaitez utiliser une « PerspectiveCamera », vous devez l'importer depuis le package three:

import { PerspectiveCamera } from 'three'

const camera = new PerspectiveCamera(45, width / height, 1, 1000)

Avec Tres, vous n'avez pas besoin d'importer quoi que ce soit, car Tres génère automatiquement un composant Vue basé sur l'objet Three que vous souhaitez utiliser dans PascalCase avec un préfixe Tres. Par exemple, si vous souhaitez utiliser une PerspectiveCamera, vous pouvez utiliser le composant <TresPerspectiveCamera />.

<template>
  <TresCanvas>
    <TresPerspectiveCamera />
    <!-- Votre scène -->
  </TresCanvas>
</template>

Cela signifie que vous pouvez utiliser la même documentation que celle que vous utiliseriez lors de l'utilisation de ThreeJS de base, mais avec la puissance de Vue.

Déclarer des objets

Si nous suivons cet argument, vous devriez pouvoir définir une instance comme celle-ci : ❌

<template>
  <TresCanvas>
    <TresPerspectiveCamera
      visible
      :position="new THREE.Vector3(1, 2, 3)"
    />
    <!-- Votre scène -->
  </TresCanvas>
</template>

Mais avec Tres ce n'est pas nécessaire, vous pouvez définir les propriétés de manière déclarative comme suit : ✅

<template>
  <TresCanvas>
    <TresPerspectiveCamera
      visible
      :position="[1, 2, 3]"
    />
    <!-- Votre scène -->
  </TresCanvas>
</template>

Arguments

Certains objets ThreeJS ont des arguments, par exemple le constructeur « PerspectiveCamera » a les arguments suivants :

• fov - Champ de vision vertical de la caméra.
• aspect - Rapport hauteur/largeur du tronc de la caméra.
• near - Plan rapproché du tronc de la caméra.
• far - Plan lointain du tronc de la caméra.

Pour transmettre ces arguments au composant TresPerspectiveCamera, vous pouvez utiliser la propriété args :

<template>
  <TresCanvas>
    <TresPerspectiveCamera :args="[45, 1, 0.1, 1000]" />
    <!-- Votre scène -->
  </TresCanvas>
</template>

C'est la même chose que de faire ceci :

const camera = new PerspectiveCamera(45, 1, 0.1, 1000)

Propriétés

Vous pouvez également transmettre des propriétés au composant, par exemple TresAmbientLight a une propriété intensity, vous pouvez donc la transmettre au composant comme ceci :

<TresAmbientLight :intensity="0.5" />

Set

Toutes les propriétés dont l'objet sous-jacent a une méthode .set() ont un raccourci pour recevoir la valeur sous forme de tableau. Par exemple, TresPerspectiveCamera a une propriété position, qui est un objet Vector3, vous pouvez donc la transmettre au composant comme ceci :

<TresPerspectiveCamera :position="[1, 2, 3]" />

Pour spécifier les propriétés de transformation telles que la position, la rotation et l'échelle, un raccourci est disponible qui vous permet d'indiquer directement l'axe que vous souhaitez définir dans les propriétés. Un raccourci similaire est également disponible pour la propriété color.

<TresMesh :position-x="1" :scale-y="2" :rotation-x="Math.PI * 2">
  <TresMeshBasicMaterial :color-r="0.7" :color-b="0.3" />
</TresMesh>

WARNING

Lorsque vous définissez la propriété de rotation avec three.js, l'ordre 'XYZ' sera utilisé par défaut. Il est important de noter que lors de la définition de la propriété rotation avec le raccourci, l'ordre dans lequel vous définissez les angles est important. Pour plus d'informations sur ce sujet, voir Angle d'Euler

<TresMesh :rotation-x="1" :rotation-y="2" :rotation-z="Math.PI * 2" />

<TresMesh :rotation-z="Math.PI * 2" :rotation-x="1" :rotation-y="2" />

Scalaire

Un autre raccourci que vous pouvez utiliser consiste à transmettre une valeur scalaire à une propriété qui attend un objet « Vector3 », en utilisant la même valeur pour le reste du vecteur :

<TresPerspectiveCamera :position="5" /> ✅

<TresPerspectiveCamera :position="[5, 5, 5]" /> ✅

Couleurs

Vous pouvez transmettre des couleurs aux composants en utilisant la propriété color, qui accepte une chaîne avec le nom de la couleur ou une valeur hexadécimale :

<TresAmbientLight color="teal" /> ✅

<TresAmbientLight color="#008080" /> ✅

Méthodes

Certaines propriétés sous-jacentes sont en fait des méthodes, le TresPerspectiveCamera a une méthode lookAt héritée de Object3d, vous pouvez donc transmettre les coordonnées au composant comme ceci :

<TresPerspectiveCamera :look-at="[1, 2, 3]" />