Using tween.js with the THREE.AnimationMixer

Video Lecture

Using tween.js with the THREE.AnimationMixer Using tween.js with the THREE.AnimationMixer Using tween.js with the THREE.AnimationMixer Using tween.js with the THREE.AnimationMixer

Description

In this lesson, I will demonstrate using a mixture of the concepts demonstrated in the previous lessons GLTF Animations, Raycaster, tween.js and SpotLight Shadow

I will import a GLTF model, import several animations clips, add the RayCaster and tween the location of the GLTF model to the clicked mouse coordinates so that the model animates to the new location.

Start Code

./src/server/server.ts

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
import express from "express"
import path from "path"
import http from "http"

const port: number = 3000

class App {
    private server: http.Server
    private port: number

    constructor(port: number) {
        this.port = port
        const app = express()
        app.use(express.static(path.join(__dirname, '../client')))
        app.use('/build/three.module.js', express.static(path.join(__dirname, '../../node_modules/three/build/three.module.js')))
        app.use('/jsm/controls/OrbitControls', express.static(path.join(__dirname, '../../node_modules/three/examples/jsm/controls/OrbitControls.js')))
        app.use('/jsm/loaders/GLTFLoader', express.static(path.join(__dirname, '../../node_modules/three/examples/jsm/loaders/GLTFLoader.js')))
        app.use('/jsm/libs/stats.module', express.static(path.join(__dirname, '../../node_modules/three/examples/jsm/libs/stats.module.js')))
        app.use('/jsm/libs/dat.gui.module', express.static(path.join(__dirname, '../../node_modules/three/examples/jsm/libs/dat.gui.module.js')))
        app.use('/jsm/libs/tween.module.min', express.static(path.join(__dirname, '../../node_modules/three/examples/jsm/libs/tween.module.min.js')))

        this.server = new http.Server(app);
    }

    public Start() {
        this.server.listen(this.port, () => {
            console.log( `Server listening on port ${this.port}.` )
        })
    }
}

new App(port).Start()

./src/client/client.ts

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
import * as THREE from '/build/three.module.js'
import { OrbitControls } from '/jsm/controls/OrbitControls'
import { GLTFLoader } from '/jsm/loaders/GLTFLoader'
import Stats from '/jsm/libs/stats.module'
import { GUI } from '/jsm/libs/dat.gui.module'
import { TWEEN } from '/jsm/libs/tween.module.min'

const scene: THREE.Scene = new THREE.Scene()
const axesHelper = new THREE.AxesHelper(5)
scene.add(axesHelper)

var light1 = new THREE.PointLight(); //new THREE.SpotLight();
light1.position.set(2.5, 5, 2.5)
// light1.angle = Math.PI / 8
// light1.penumbra = 0.5
// light1.castShadow = true;
// light1.shadow.mapSize.width = 1024;
// light1.shadow.mapSize.height = 1024;
// light1.shadow.camera.near = 0.5;
// light1.shadow.camera.far = 20
scene.add(light1);

var light2 = new THREE.PointLight(); //new THREE.SpotLight();
light2.position.set(-2.5, 5, 2.5)
// light2.angle = Math.PI / 8
// light2.penumbra = 0.5
// light2.castShadow = true;
// light2.shadow.mapSize.width = 1024;
// light2.shadow.mapSize.height = 1024;
// light2.shadow.camera.near = 0.5;
// light2.shadow.camera.far = 20
scene.add(light2);

const camera: THREE.PerspectiveCamera = new THREE.PerspectiveCamera(75, window.innerWidth / window.innerHeight, 0.01, 1000)
camera.position.set(0.8, 1.4, 1.0)

const renderer: THREE.WebGLRenderer = new THREE.WebGLRenderer()
renderer.setSize(window.innerWidth, window.innerHeight)
//renderer.shadowMap.enabled = true
document.body.appendChild(renderer.domElement)

const controls = new OrbitControls(camera, renderer.domElement)
controls.screenSpacePanning = true
controls.target.set(0, 1, 0)

// let sceneMeshes = new Array()

// const planeGeometry: THREE.PlaneGeometry = new THREE.PlaneGeometry(25, 25)
// const texture = new THREE.TextureLoader().load("img/grid.png")
// const plane: THREE.Mesh = new THREE.Mesh(planeGeometry, new THREE.MeshPhongMaterial({ map: texture }))
// plane.rotateX(-Math.PI / 2)
// plane.receiveShadow = true
// scene.add(plane)
// sceneMeshes.push(plane)

let mixer: THREE.AnimationMixer
let modelReady = false
//let modelMesh: THREE.Object3D
let animationActions: THREE.AnimationAction[] = new Array()
let activeAction: THREE.AnimationAction
let lastAction: THREE.AnimationAction
const gltfLoader: GLTFLoader = new GLTFLoader();

gltfLoader.load(
    'models/vanguard.glb',
    (gltf) => {

        // gltf.scene.traverse(function (child) {
        //     if ((<THREE.Mesh>child).isMesh) {
        //         let m = <THREE.Mesh>child
        //         m.castShadow = true
        //         //m.frustumCulled = false;
        //         //m.geometry.computeVertexNormals()
        //     }
        // })

        mixer = new THREE.AnimationMixer(gltf.scene)

        let animationAction = mixer.clipAction((gltf as any).animations[0])
        animationActions.push(animationAction)
        animationsFolder.add(animations, "default")
        activeAction = animationActions[0]

        scene.add(gltf.scene);
        //modelMesh = gltf.scene

        //add an animation from another file
        gltfLoader.load('models/vanguard@samba.glb',
            (gltf) => {
                console.log("loaded samba")
                let animationAction = mixer.clipAction((gltf as any).animations[0]);
                animationActions.push(animationAction)
                animationsFolder.add(animations, "samba")

                //add an animation from another file
                gltfLoader.load('models/vanguard@bellydance.glb',
                    (gltf) => {
                        console.log("loaded bellydance")
                        let animationAction = mixer.clipAction((gltf as any).animations[0]);
                        animationActions.push(animationAction)
                        animationsFolder.add(animations, "bellydance")

                        //add an animation from another file
                        gltfLoader.load('models/vanguard@goofyrunning.glb',
                            (gltf) => {
                                console.log("loaded goofyrunning");
                                (gltf as any).animations[0].tracks.shift() //delete the specific track that moves the object forward while running
                                let animationAction = mixer.clipAction((gltf as any).animations[0]);
                                animationActions.push(animationAction)
                                animationsFolder.add(animations, "goofyrunning")

                                modelReady = true
                            },
                            (xhr) => {
                                console.log((xhr.loaded / xhr.total * 100) + '% loaded')
                            },
                            (error) => {
                                console.log(error);
                            }
                        )
                    },
                    (xhr) => {
                        console.log((xhr.loaded / xhr.total * 100) + '% loaded')
                    },
                    (error) => {
                        console.log(error);
                    }
                )
            },
            (xhr) => {
                console.log((xhr.loaded / xhr.total * 100) + '% loaded')
            },
            (error) => {
                console.log(error);
            }
        )
    },
    (xhr) => {
        console.log((xhr.loaded / xhr.total * 100) + '% loaded')
    },
    (error) => {
        console.log(error);
    }
)

window.addEventListener('resize', onWindowResize, false)
function onWindowResize() {
    camera.aspect = window.innerWidth / window.innerHeight
    camera.updateProjectionMatrix()
    renderer.setSize(window.innerWidth, window.innerHeight)
    render()
}

// const raycaster = new THREE.Raycaster();
// //const targetQuaternion = new THREE.Quaternion()

// renderer.domElement.addEventListener('dblclick', onDoubleClick, false);
// function onDoubleClick(event) {
//     const mouse = {
//         x: (event.clientX / renderer.domElement.clientWidth) * 2 - 1,
//         y: -(event.clientY / renderer.domElement.clientHeight) * 2 + 1
//     }
//     raycaster.setFromCamera(mouse, camera);

//     const intersects = raycaster.intersectObjects(sceneMeshes, false);

//     if (intersects.length > 0) {

//         const p = intersects[0].point

//         //const distance = modelMesh.position.distanceTo(p);

//         // const rotationMatrix = new THREE.Matrix4();
//         // rotationMatrix.lookAt(p, modelMesh.position, modelMesh.up);
//         // targetQuaternion.setFromRotationMatrix(rotationMatrix);

//         // setAction(animationActions[3])

//         //TWEEN.removeAll()
//         new TWEEN.Tween(modelMesh.position)
//             .to({
//                 x: p.x,
//                 y: p.y,
//                 z: p.z
//             }, 1000 ) /// 2 * distance) //walks 2 meters a second * the distance
//             // .onUpdate(() => {
//             //     controls.target.set(
//             //         modelMesh.position.x,
//             //         modelMesh.position.y + 1,
//             //         modelMesh.position.z)
//             //     light1.target = modelMesh;
//             //     light2.target = modelMesh;
//             // })
//             .start()
//             //.onComplete(() => setAction(animationActions[2]))
//     }
// }

const stats = Stats()
document.body.appendChild(stats.dom)

var animations = {
    default: function () {
        setAction(animationActions[0])
    },
    samba: function () {
        setAction(animationActions[1])
    },
    bellydance: function () {
        setAction(animationActions[2])
    },
    goofyrunning: function () {
        setAction(animationActions[3])
    },
}

const setAction = (toAction: THREE.AnimationAction) => {
    if (toAction != activeAction) {
        lastAction = activeAction
        activeAction = toAction
        //lastAction.stop()
        lastAction.fadeOut(.2)
        activeAction.reset()
        activeAction.fadeIn(.2)
        activeAction.play()
    }
}

const gui = new GUI()
const animationsFolder = gui.addFolder("Animations")
animationsFolder.open()

const clock: THREE.Clock = new THREE.Clock()

var animate = function () {
    requestAnimationFrame(animate)

    controls.update()

    if (modelReady) {
        mixer.update(clock.getDelta());

        // if (!modelMesh.quaternion.equals(targetQuaternion)) {
        //     modelMesh.quaternion.rotateTowards(targetQuaternion, clock.getDelta() * 1000);
        // }
    }

    TWEEN.update();

    render()

    stats.update()
};

function render() {
    renderer.render(scene, camera)
}
animate();

Final Script

./src/client/client.ts

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
import * as THREE from '/build/three.module.js'
import { OrbitControls } from '/jsm/controls/OrbitControls'
import { GLTFLoader } from '/jsm/loaders/GLTFLoader'
import Stats from '/jsm/libs/stats.module'
import { GUI } from '/jsm/libs/dat.gui.module'
import { TWEEN } from '/jsm/libs/tween.module.min'

const scene: THREE.Scene = new THREE.Scene()
const axesHelper = new THREE.AxesHelper(5)
scene.add(axesHelper)

var light1 = new THREE.SpotLight();
light1.position.set(2.5, 5, 2.5)
light1.angle = Math.PI / 8
light1.penumbra = 0.5
light1.castShadow = true;
light1.shadow.mapSize.width = 1024;
light1.shadow.mapSize.height = 1024;
light1.shadow.camera.near = 0.5;
light1.shadow.camera.far = 20
scene.add(light1);

var light2 = new THREE.SpotLight();
light2.position.set(-2.5, 5, 2.5)
light2.angle = Math.PI / 8
light2.penumbra = 0.5
light2.castShadow = true;
light2.shadow.mapSize.width = 1024;
light2.shadow.mapSize.height = 1024;
light2.shadow.camera.near = 0.5;
light2.shadow.camera.far = 20
scene.add(light2);

const camera: THREE.PerspectiveCamera = new THREE.PerspectiveCamera(75, window.innerWidth / window.innerHeight, 0.01, 1000)
camera.position.set(0.8, 1.4, 1.0)

const renderer: THREE.WebGLRenderer = new THREE.WebGLRenderer()
renderer.setSize(window.innerWidth, window.innerHeight)
renderer.shadowMap.enabled = true
document.body.appendChild(renderer.domElement)

const controls = new OrbitControls(camera, renderer.domElement)
controls.screenSpacePanning = true
controls.target.set(0, 1, 0)

let sceneMeshes = new Array()

const planeGeometry: THREE.PlaneGeometry = new THREE.PlaneGeometry(25, 25)
const texture = new THREE.TextureLoader().load("img/grid.png")
const plane: THREE.Mesh = new THREE.Mesh(planeGeometry, new THREE.MeshPhongMaterial({ map: texture }))
plane.rotateX(-Math.PI / 2)
plane.receiveShadow = true
scene.add(plane)
sceneMeshes.push(plane)

let mixer: THREE.AnimationMixer
let modelReady = false
let modelMesh: THREE.Object3D
let animationActions: THREE.AnimationAction[] = new Array()
let activeAction: THREE.AnimationAction
let lastAction: THREE.AnimationAction
const gltfLoader: GLTFLoader = new GLTFLoader();

gltfLoader.load(
    'models/vanguard.glb',
    (gltf) => {

        gltf.scene.traverse(function (child) {
            if ((<THREE.Mesh>child).isMesh) {
                let m = <THREE.Mesh>child
                m.castShadow = true
                m.frustumCulled = false;
                m.geometry.computeVertexNormals()
            }
        })

        mixer = new THREE.AnimationMixer(gltf.scene)

        let animationAction = mixer.clipAction((gltf as any).animations[0])
        animationActions.push(animationAction)
        animationsFolder.add(animations, "default")
        activeAction = animationActions[0]

        scene.add(gltf.scene);
        modelMesh = gltf.scene

        //add an animation from another file
        gltfLoader.load('models/vanguard@samba.glb',
            (gltf) => {
                console.log("loaded samba")
                let animationAction = mixer.clipAction((gltf as any).animations[0]);
                animationActions.push(animationAction)
                animationsFolder.add(animations, "samba")

                //add an animation from another file
                gltfLoader.load('models/vanguard@bellydance.glb',
                    (gltf) => {
                        console.log("loaded bellydance")
                        let animationAction = mixer.clipAction((gltf as any).animations[0]);
                        animationActions.push(animationAction)
                        animationsFolder.add(animations, "bellydance")

                        //add an animation from another file
                        gltfLoader.load('models/vanguard@goofyrunning.glb',
                            (gltf) => {
                                console.log("loaded goofyrunning");
                                (gltf as any).animations[0].tracks.shift() //delete the specific track that moves the object forward while running
                                let animationAction = mixer.clipAction((gltf as any).animations[0]);
                                animationActions.push(animationAction)
                                animationsFolder.add(animations, "goofyrunning")

                                modelReady = true
                            },
                            (xhr) => {
                                console.log((xhr.loaded / xhr.total * 100) + '% loaded')
                            },
                            (error) => {
                                console.log(error);
                            }
                        )
                    },
                    (xhr) => {
                        console.log((xhr.loaded / xhr.total * 100) + '% loaded')
                    },
                    (error) => {
                        console.log(error);
                    }
                )
            },
            (xhr) => {
                console.log((xhr.loaded / xhr.total * 100) + '% loaded')
            },
            (error) => {
                console.log(error);
            }
        )
    },
    (xhr) => {
        console.log((xhr.loaded / xhr.total * 100) + '% loaded')
    },
    (error) => {
        console.log(error);
    }
)

window.addEventListener('resize', onWindowResize, false)
function onWindowResize() {
    camera.aspect = window.innerWidth / window.innerHeight
    camera.updateProjectionMatrix()
    renderer.setSize(window.innerWidth, window.innerHeight)
    render()
}

const raycaster = new THREE.Raycaster();
const targetQuaternion = new THREE.Quaternion()

renderer.domElement.addEventListener('dblclick', onDoubleClick, false);
function onDoubleClick(event) {
    const mouse = {
        x: (event.clientX / renderer.domElement.clientWidth) * 2 - 1,
        y: -(event.clientY / renderer.domElement.clientHeight) * 2 + 1
    }
    raycaster.setFromCamera(mouse, camera);

    const intersects = raycaster.intersectObjects(sceneMeshes, false);

    if (intersects.length > 0) {

        const p = intersects[0].point

        const distance = modelMesh.position.distanceTo(p);

        //modelMesh.lookAt(p)

        const rotationMatrix = new THREE.Matrix4();
        rotationMatrix.lookAt(p, modelMesh.position, modelMesh.up);
        targetQuaternion.setFromRotationMatrix(rotationMatrix);

        setAction(animationActions[3])

        TWEEN.removeAll()
        new TWEEN.Tween(modelMesh.position)
            .to({
                x: p.x,
                y: p.y,
                z: p.z
            }, 1000 / 2.2 * distance) //walks 2 meters a second * the distance
            .onUpdate(() => {
                controls.target.set(
                    modelMesh.position.x,
                    modelMesh.position.y + 1,
                    modelMesh.position.z)
                light1.target = modelMesh;
                light2.target = modelMesh;
            })
            .start()
            .onComplete(() => {
                setAction(animationActions[2])
                activeAction.clampWhenFinished = true;
                activeAction.loop = THREE.LoopOnce
            })
    }
}

const stats = Stats()
document.body.appendChild(stats.dom)

var animations = {
    default: function () {
        setAction(animationActions[0])
    },
    samba: function () {
        setAction(animationActions[1])
    },
    bellydance: function () {
        setAction(animationActions[2])
    },
    goofyrunning: function () {
        setAction(animationActions[3])
    },
}

const setAction = (toAction: THREE.AnimationAction) => {
    if (toAction != activeAction) {
        lastAction = activeAction
        activeAction = toAction
        //lastAction.stop()
        lastAction.fadeOut(.2)
        activeAction.reset()
        activeAction.fadeIn(.2)
        activeAction.play()
    }
}

const gui = new GUI()
const animationsFolder = gui.addFolder("Animations")
animationsFolder.open()

const clock: THREE.Clock = new THREE.Clock()

var animate = function () {
    requestAnimationFrame(animate)

    controls.update()

    const delta = clock.getDelta()

    if (modelReady) {
        mixer.update(delta);

        if (!modelMesh.quaternion.equals(targetQuaternion)) {
            modelMesh.quaternion.rotateTowards(targetQuaternion, delta * 10);
        }
    }

    TWEEN.update();

    render()

    stats.update()
};

function render() {
    renderer.render(scene, camera)
}
animate();