Back ArrowExplore all kits

Tween/Animate Fog in three.js

share link

by Abdul Rawoof A R dot icon Updated: Apr 6, 2023

technology logo
technology logo

Solution Kit Solution Kit  

In Three.js, the Fog class adds fog or mist to a scene to create depth and atmosphere. With the help of the GreenSock Animation Platform (GSAP) library, you can easily animate the fog density and create dynamic fog effects in your Three.js scenes.


This code initializes a Three.js scene with a box mesh and a fog object. The fog object is defined using the FogExp2 class, which creates an exponential fog effect. The initial fog density is set to 0.5.


The GSAP to() function is then used to tween the value property of the myfog object, representing the fog density. The onUpdate callback function is called on each frame update to update the fog density of the scene with the current myfog value. Animating the fog density can create interesting and dynamic visual effects, such as making objects in the scene gradually appear or disappear as the fog density changes. It can also help stimulate natural weather conditions like mist, fog, or smoke. Overall, animating the fog density adds depth and atmosphere to the Three.js scenes.

Fig : Preview of the output that you will get on running this code from your IDE.

Code

In this solution we're using React, Nodejs, three.js and GSAP libraries.

How to tween/animate fog three.js

JavaScriptdotLines of Code : 49dotLicense : Strong Copyleft (CC BY-SA 4.0)

var scene = new THREE.Scene();
var camera = new THREE.PerspectiveCamera(75, window.innerWidth / window.innerHeight, 0.1, 1000);
camera.position.z = 5;
camera.position.y = 2;

// Init the object and fog here
var myfog = { value: .5 }
scene.fog = new THREE.FogExp2(0x00ff00, myfog.value);

var geometry = new THREE.BoxGeometry(1, 1, 5);
var mat = new THREE.MeshBasicMaterial({
  color: 0xff0000
});
var mesh = new THREE.Mesh(geometry, mat);

scene.add(mesh);

var renderer = new THREE.WebGLRenderer({
  antialias: true
});
renderer.setSize(window.innerWidth, window.innerHeight);
renderer.setClearColor(0x00ff00);
document.body.appendChild(renderer.domElement);

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

function animate() {
  requestAnimationFrame(animate);
  render();
}

animate();

// This animates the fog
gsap.to(myfog, {
  duration: 2,
  value: 0.002, // The end value
  onUpdate: function() {
    // New fog with current myfog value
    scene.fog = new THREE.FogExp2(0x00ff00, myfog.value);
  },
  // These just infinitely repeat the animation
  yoyo: true,
  repeat: -1,
});
<script src="https://cdnjs.cloudflare.com/ajax/libs/gsap/3.6.1/gsap.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/three.js/r127/three.min.js"></script>

Instructions

Follow the steps carefully to get the output easily.

  1. Install the Node.js and React on your IDE(preferable Visual Studio Code).
  2. Create React Application using npx create-react-app foldername.
  3. cd foldername.
  4. Install npm install gsap.
  5. Open the folder in IDE.
  6. Copy the code using "copy" button above and paste it in app.js file(remove the earlier code from app.js).
  7. Cut the script tag which is present at the end of code and paste it in index.html file(remove the earlier code from index.html).
  8. Import three.js library as import * as THREE from 'three'.
  9. Import GSAP library as import {gsap} from 'gsap'.
  10. Add export default statement as 'export default animate' at end of the code.
  11. Open the terminal from IDE.
  12. npm start to run the file.


I hope you found this useful. I have added the link to dependent library, version information in the following sections.


I found this code snippet by searching for 'tween animate fog in three.js' in kandi. You can try any such use case!

Environment Tested

I tested this solution in the following versions. Be mindful of changes when working with other versions.

  1. The solution is created in Visual Studio Code 1.73.1.
  2. The solution is tested on node v18.12.1 and npm v8.19.2.
  3. React version-18.2.0.
  4. three version-0.148.0.
  5. GSAP version-3.11.4.


Using this solution, we are able to tween/animate fog in three.js with simple steps. This process also facilities an easy way to use, hassle-free method to create a hands-on working version of code which would help us to tween/animate fog in three.js.

Dependent Libraries

reactby facebook

JavaScript doticonstar image 209050 doticonVersion:v18.2.0doticon
License: Permissive (MIT)

The library for web and native user interfaces

Support
    Quality
      Security
        License
          Reuse

            reactby facebook

            JavaScript doticon star image 209050 doticonVersion:v18.2.0doticon License: Permissive (MIT)

            The library for web and native user interfaces
            Support
              Quality
                Security
                  License
                    Reuse

                      nodeby nodejs

                      JavaScript doticonstar image 95980 doticonVersion:v20.3.0doticon
                      License: Others (Non-SPDX)

                      Node.js JavaScript runtime :sparkles::turtle::rocket::sparkles:

                      Support
                        Quality
                          Security
                            License
                              Reuse

                                nodeby nodejs

                                JavaScript doticon star image 95980 doticonVersion:v20.3.0doticon License: Others (Non-SPDX)

                                Node.js JavaScript runtime :sparkles::turtle::rocket::sparkles:
                                Support
                                  Quality
                                    Security
                                      License
                                        Reuse

                                          react-three-legacyby Izzimach

                                          JavaScript doticonstar image 1535 doticonVersion:Currentdoticon
                                          License: Others (Non-SPDX)

                                          React bindings to create and control a 3D scene using three.js

                                          Support
                                            Quality
                                              Security
                                                License
                                                  Reuse

                                                    react-three-legacyby Izzimach

                                                    JavaScript doticon star image 1535 doticonVersion:Currentdoticon License: Others (Non-SPDX)

                                                    React bindings to create and control a 3D scene using three.js
                                                    Support
                                                      Quality
                                                        Security
                                                          License
                                                            Reuse

                                                              GSAPby greensock

                                                              JavaScript doticonstar image 16408 doticonVersion:Currentdoticon
                                                              no licences License: No License (null)

                                                              GreenSock's GSAP JavaScript animation library (including Draggable).

                                                              Support
                                                                Quality
                                                                  Security
                                                                    License
                                                                      Reuse

                                                                        GSAPby greensock

                                                                        JavaScript doticon star image 16408 doticonVersion:Currentdoticonno licences License: No License

                                                                        GreenSock's GSAP JavaScript animation library (including Draggable).
                                                                        Support
                                                                          Quality
                                                                            Security
                                                                              License
                                                                                Reuse

                                                                                  You can also search for any dependent libraries on kandi like 'react', 'nodejs', 'three.js' and 'GSAP'.

                                                                                  Support

                                                                                  1. For any support on kandi solution kits, please use the chat
                                                                                  2. For further learning resources, visit the Open Weaver Community learning page.


                                                                                  See similar Kits and Libraries

                                                                                  Open Weaver – Develop Applications Faster with Open Source

                                                                                  kandi

                                                                                  Community and Support

                                                                                  Company

                                                                                  Follow

                                                                                  • © 2023 Open Weaver Inc.