The loading manager.
@@ -58,7 +58,7 @@The path/URL of the file to be loaded. This can also be a data URI.
@@ -66,7 +66,7 @@Executed when the loading process has been finished.
@@ -74,7 +74,7 @@Executed while the loading is in progress.
@@ -82,7 +82,7 @@Executed when errors occur.
@@ -103,7 +103,7 @@The raw AMF asset data as an array buffer.
diff --git a/docs/pages/AMFLoader.html.md b/docs/pages/AMFLoader.html.md new file mode 100644 index 00000000000000..fb4700738ac1df --- /dev/null +++ b/docs/pages/AMFLoader.html.md @@ -0,0 +1,73 @@ +*Inheritance: Loader →* + +# AMFLoader + +A loader for the AMF format. + +The loader supports materials, color and ZIP compressed files. No constellation support (yet). + +## Code Example + +```js +const loader = new AMFLoader(); +const object = await loader.loadAsync( './models/amf/rook.amf' ); +scene.add( object ); +``` + +## Import + +AMFLoader is an addon, and must be imported explicitly, see [Installation#Addons](https://threejs.org/manual/#en/installation). + +```js +import { AMFLoader } from 'three/addons/loaders/AMFLoader.js'; +``` + +## Constructor + +### new AMFLoader( manager : LoadingManager ) + +Constructs a new AMF loader. + +**manager** + +The loading manager. + +## Methods + +### .load( url : string, onLoad : function, onProgress : onProgressCallback, onError : onErrorCallback ) + +Starts loading from the given URL and passes the loaded AMF asset to the `onLoad()` callback. + +**url** + +The path/URL of the file to be loaded. This can also be a data URI. + +**onLoad** + +Executed when the loading process has been finished. + +**onProgress** + +Executed while the loading is in progress. + +**onError** + +Executed when errors occur. + +**Overrides:** [Loader#load](Loader.html#load) + +### .parse( data : ArrayBuffer ) : Group + +Parses the given AMF data and returns the resulting group. + +**data** + +The raw AMF asset data as an array buffer. + +**Overrides:** [Loader#parse](Loader.html#parse) + +**Returns:** A group representing the parsed asset. + +## Source + +[examples/jsm/loaders/AMFLoader.js](https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/AMFLoader.js) \ No newline at end of file diff --git a/docs/pages/AONode.html b/docs/pages/AONode.html index f355ece4e79c48..31081c09dff073 100644 --- a/docs/pages/AONode.html +++ b/docs/pages/AONode.html @@ -29,7 +29,7 @@The ambient occlusion node.
diff --git a/docs/pages/AONode.html.md b/docs/pages/AONode.html.md new file mode 100644 index 00000000000000..73d2f4bb6cc3e2 --- /dev/null +++ b/docs/pages/AONode.html.md @@ -0,0 +1,29 @@ +*Inheritance: EventDispatcher → Node → LightingNode →* + +# AONode + +A generic class that can be used by nodes which contribute ambient occlusion to the scene. E.g. an ambient occlusion map node can be used as input for this module. Used in [NodeMaterial](NodeMaterial.html). + +## Constructor + +### new AONode( aoNode : Node.The renderer.
@@ -45,7 +45,7 @@The a configuration object for the AR session.
diff --git a/docs/pages/ARButton.html.md b/docs/pages/ARButton.html.md new file mode 100644 index 00000000000000..2f190e000a3a8b --- /dev/null +++ b/docs/pages/ARButton.html.md @@ -0,0 +1,37 @@ +# ARButton + +A utility class for creating a button that allows to initiate immersive AR sessions based on WebXR. The button can be created with a factory method and then appended ot the website's DOM. + +## Code Example + +```js +document.body.appendChild( ARButton.createButton( renderer ) ); +``` + +## Import + +ARButton is an addon, and must be imported explicitly, see [Installation#Addons](https://threejs.org/manual/#en/installation). + +```js +import { ARButton } from 'three/addons/webxr/ARButton.js'; +``` + +## Static Methods + +### .createButton( renderer : WebGLRenderer | WebGPURenderer, sessionInit : XRSessionInit ) : HTMLElement + +Constructs a new AR button. + +**renderer** + +The renderer. + +**sessionInit** + +The a configuration object for the AR session. + +**Returns:** The button or an error message if `immersive-ar` isn't supported. + +## Source + +[examples/jsm/webxr/ARButton.js](https://github.com/mrdoob/three.js/blob/master/examples/jsm/webxr/ARButton.js) \ No newline at end of file diff --git a/docs/pages/AfterImageNode.html b/docs/pages/AfterImageNode.html index 7fb4cd9e099178..4ad8637fc9a6cd 100644 --- a/docs/pages/AfterImageNode.html +++ b/docs/pages/AfterImageNode.html @@ -30,7 +30,7 @@The texture node that represents the input of the effect.
@@ -38,7 +38,7 @@The damping intensity. A higher value means a stronger after image effect.
@@ -104,7 +104,7 @@The width of the effect.
@@ -112,7 +112,7 @@The height of the effect.
@@ -130,7 +130,7 @@The current node builder.
@@ -151,7 +151,7 @@The current node frame.
diff --git a/docs/pages/AfterImageNode.html.md b/docs/pages/AfterImageNode.html.md new file mode 100644 index 00000000000000..f122ff2caf9332 --- /dev/null +++ b/docs/pages/AfterImageNode.html.md @@ -0,0 +1,97 @@ +*Inheritance: EventDispatcher → Node → TempNode →* + +# AfterImageNode + +Post processing node for creating an after image effect. + +## Import + +AfterImageNode is an addon, and must be imported explicitly, see [Installation#Addons](https://threejs.org/manual/#en/installation). + +```js +import { afterImage } from 'three/addons/tsl/display/AfterImageNode.js'; +``` + +## Constructor + +### new AfterImageNode( textureNode : TextureNode, damp : Node.The damping intensity. A higher value means a stronger after image effect.
@@ -93,7 +93,7 @@The renderer.
@@ -101,7 +101,7 @@The write buffer. This buffer is intended as the rendering @@ -110,7 +110,7 @@
The read buffer. The pass can access the result from the @@ -119,7 +119,7 @@
The delta time in seconds.
@@ -127,7 +127,7 @@Whether masking is active or not.
@@ -148,7 +148,7 @@The width to set.
@@ -156,7 +156,7 @@The height to set.
diff --git a/docs/pages/AfterimagePass.html.md b/docs/pages/AfterimagePass.html.md new file mode 100644 index 00000000000000..7b8366a8079c7f --- /dev/null +++ b/docs/pages/AfterimagePass.html.md @@ -0,0 +1,106 @@ +*Inheritance: Pass →* + +# AfterimagePass + +Pass for a basic after image effect. + +## Code Example + +```js +const afterimagePass = new AfterimagePass( 0.9 ); +composer.addPass( afterimagePass ); +``` + +## Import + +AfterimagePass is an addon, and must be imported explicitly, see [Installation#Addons](https://threejs.org/manual/#en/installation). + +```js +import { AfterimagePass } from 'three/addons/postprocessing/AfterimagePass.js'; +``` + +## Constructor + +### new AfterimagePass( damp : number ) + +Constructs a new after image pass. + +**damp** + +The damping intensity. A higher value means a stronger after image effect. + +Default is `0.96`. + +## Properties + +### .compFsMaterial : ShaderMaterial + +The composition material. + +### .copyFsMaterial : ShaderMaterial + +The copy material. + +### .damp : number + +The damping intensity, from 0.0 to 1.0. A higher value means a stronger after image effect. + +### .uniforms : Object + +The pass uniforms. Use this object if you want to update the `damp` value at runtime. + +```js +pass.uniforms.damp.value = 0.9; +``` + +## Methods + +### .dispose() + +Frees the GPU-related resources allocated by this instance. Call this method whenever the pass is no longer used in your app. + +**Overrides:** [Pass#dispose](Pass.html#dispose) + +### .render( renderer : WebGLRenderer, writeBuffer : WebGLRenderTarget, readBuffer : WebGLRenderTarget, deltaTime : number, maskActive : boolean ) + +Performs the after image pass. + +**renderer** + +The renderer. + +**writeBuffer** + +The write buffer. This buffer is intended as the rendering destination for the pass. + +**readBuffer** + +The read buffer. The pass can access the result from the previous pass from this buffer. + +**deltaTime** + +The delta time in seconds. + +**maskActive** + +Whether masking is active or not. + +**Overrides:** [Pass#render](Pass.html#render) + +### .setSize( width : number, height : number ) + +Sets the size of the pass. + +**width** + +The width to set. + +**height** + +The height to set. + +**Overrides:** [Pass#setSize](Pass.html#setSize) + +## Source + +[examples/jsm/postprocessing/AfterimagePass.js](https://github.com/mrdoob/three.js/blob/master/examples/jsm/postprocessing/AfterimagePass.js) \ No newline at end of file diff --git a/docs/pages/AmbientLight.html b/docs/pages/AmbientLight.html index 062a2508c3bf42..2393007ad428e7 100644 --- a/docs/pages/AmbientLight.html +++ b/docs/pages/AmbientLight.html @@ -32,7 +32,7 @@The light's color.
@@ -41,7 +41,7 @@The light's strength/intensity.
diff --git a/docs/pages/AmbientLight.html.md b/docs/pages/AmbientLight.html.md new file mode 100644 index 00000000000000..83155f7ba57bb5 --- /dev/null +++ b/docs/pages/AmbientLight.html.md @@ -0,0 +1,44 @@ +*Inheritance: EventDispatcher → Object3D → Light →* + +# AmbientLight + +This light globally illuminates all objects in the scene equally. + +It cannot be used to cast shadows as it does not have a direction. + +## Code Example + +```js +const light = new THREE.AmbientLight( 0x404040 ); // soft white light +scene.add( light ); +``` + +## Constructor + +### new AmbientLight( color : number | Color | string, intensity : number ) + +Constructs a new ambient light. + +**color** + +The light's color. + +Default is `0xffffff`. + +**intensity** + +The light's strength/intensity. + +Default is `1`. + +## Properties + +### .isAmbientLight : boolean (readonly) + +This flag can be used for type testing. + +Default is `true`. + +## Source + +[src/lights/AmbientLight.js](https://github.com/mrdoob/three.js/blob/master/src/lights/AmbientLight.js) \ No newline at end of file diff --git a/docs/pages/AmbientLightNode.html b/docs/pages/AmbientLightNode.html index 9084d20b4910e9..2b768f9d4d57c6 100644 --- a/docs/pages/AmbientLightNode.html +++ b/docs/pages/AmbientLightNode.html @@ -27,7 +27,7 @@The ambient light source.
diff --git a/docs/pages/AmbientLightNode.html.md b/docs/pages/AmbientLightNode.html.md new file mode 100644 index 00000000000000..bc317576e38c39 --- /dev/null +++ b/docs/pages/AmbientLightNode.html.md @@ -0,0 +1,21 @@ +*Inheritance: EventDispatcher → Node → LightingNode → AnalyticLightNode →* + +# AmbientLightNode + +Module for representing ambient lights as nodes. + +## Constructor + +### new AmbientLightNode( light : AmbientLight ) + +Constructs a new ambient light node. + +**light** + +The ambient light source. + +Default is `null`. + +## Source + +[src/nodes/lighting/AmbientLightNode.js](https://github.com/mrdoob/three.js/blob/master/src/nodes/lighting/AmbientLightNode.js) \ No newline at end of file diff --git a/docs/pages/AmmoPhysics.html b/docs/pages/AmmoPhysics.html index 3a8841b6f4d5db..efaeb9e30e7a87 100644 --- a/docs/pages/AmmoPhysics.html +++ b/docs/pages/AmmoPhysics.html @@ -39,7 +39,7 @@The mesh to add.
@@ -47,7 +47,7 @@The mass in kg of the mesh.
@@ -56,7 +56,7 @@The restitution of the mesh, usually from 0 to 1. Represents how "bouncy" objects are when they collide with each other.
@@ -79,7 +79,7 @@The scene or any type of 3D object to add.
@@ -98,7 +98,7 @@The mesh to update the position for.
@@ -106,7 +106,7 @@The new position.
@@ -114,7 +114,7 @@If the mesh is instanced, the index represents the instanced ID.
diff --git a/docs/pages/AmmoPhysics.html.md b/docs/pages/AmmoPhysics.html.md new file mode 100644 index 00000000000000..60c4049ab99c54 --- /dev/null +++ b/docs/pages/AmmoPhysics.html.md @@ -0,0 +1,79 @@ +# AmmoPhysics + +Can be used to include Ammo.js as a Physics engine into `three.js` apps. Make sure to include `ammo.wasm.js` first: + +It is then possible to initialize the API via: + +```js +const physics = await AmmoPhysics(); +``` + +## Code Example + +```js + +``` + +## Import + +AmmoPhysics is an addon, and must be imported explicitly, see [Installation#Addons](https://threejs.org/manual/#en/installation). + +```js +import { AmmoPhysics } from 'three/addons/physics/AmmoPhysics.js'; +``` + +## Methods + +### .addMesh( mesh : Mesh, mass : number, restitution : number ) + +Adds the given mesh to this physics simulation. + +**mesh** + +The mesh to add. + +**mass** + +The mass in kg of the mesh. + +Default is `0`. + +**restitution** + +The restitution of the mesh, usually from 0 to 1. Represents how "bouncy" objects are when they collide with each other. + +Default is `0`. + +### .addScene( scene : Object3D ) + +Adds the given scene to this physics simulation. Only meshes with a `physics` object in their [Object3D#userData](Object3D.html#userData) field will be honored. The object can be used to store the mass of the mesh. E.g.: + +```js +box.userData.physics = { mass: 1 }; +``` + +**scene** + +The scene or any type of 3D object to add. + +### .setMeshPosition( mesh : Mesh, position : Vector3, index : number ) + +Set the position of the given mesh which is part of the physics simulation. Calling this method will reset the current simulated velocity of the mesh. + +**mesh** + +The mesh to update the position for. + +**position** + +The new position. + +**index** + +If the mesh is instanced, the index represents the instanced ID. + +Default is `0`. + +## Source + +[examples/jsm/physics/AmmoPhysics.js](https://github.com/mrdoob/three.js/blob/master/examples/jsm/physics/AmmoPhysics.js) \ No newline at end of file diff --git a/docs/pages/AnaglyphEffect.html b/docs/pages/AnaglyphEffect.html index 6100a2b366876c..3836e1ec805e32 100644 --- a/docs/pages/AnaglyphEffect.html +++ b/docs/pages/AnaglyphEffect.html @@ -12,7 +12,11 @@A class that creates an anaglyph effect.
+A class that creates an anaglyph effect using physically-correct +off-axis stereo projection.
+This implementation uses CameraUtils.frameCorners() to align stereo +camera frustums to a virtual screen plane, providing accurate depth +perception with zero parallax at the plane distance.
Note that this class can only be used with WebGLRenderer. When using WebGPURenderer, use AnaglyphPassNode.
The renderer.
@@ -39,7 +43,7 @@The width of the effect in physical pixels.
@@ -48,7 +52,7 @@The height of the effect in physical pixels.
@@ -59,6 +63,28 @@The interpupillary distance (eye separation) in world units. +Typical human IPD is 0.064 meters (64mm).
+Default is 0.064.
The distance in world units from the viewer to the virtual +screen plane where zero parallax (screen depth) occurs. +Objects at this distance appear at the screen surface. +Objects closer appear in front of the screen (negative parallax). +Objects further appear behind the screen (positive parallax).
+The screen dimensions are derived from the camera's FOV and aspect ratio +at this distance, ensuring the stereo view matches the camera's field of view.
+Default is 0.5.
The scene to render.
@@ -85,7 +111,7 @@The camera.
@@ -103,7 +129,7 @@The width of the effect in logical pixels.
@@ -111,7 +137,7 @@The height of the effect in logical pixels.
diff --git a/docs/pages/AnaglyphEffect.html.md b/docs/pages/AnaglyphEffect.html.md new file mode 100644 index 00000000000000..6c3613c63f6bb5 --- /dev/null +++ b/docs/pages/AnaglyphEffect.html.md @@ -0,0 +1,87 @@ +# AnaglyphEffect + +A class that creates an anaglyph effect using physically-correct off-axis stereo projection. + +This implementation uses CameraUtils.frameCorners() to align stereo camera frustums to a virtual screen plane, providing accurate depth perception with zero parallax at the plane distance. + +Note that this class can only be used with [WebGLRenderer](WebGLRenderer.html). When using [WebGPURenderer](WebGPURenderer.html), use [AnaglyphPassNode](AnaglyphPassNode.html). + +## Import + +AnaglyphEffect is an addon, and must be imported explicitly, see [Installation#Addons](https://threejs.org/manual/#en/installation). + +```js +import { AnaglyphEffect } from 'three/addons/effects/AnaglyphEffect.js'; +``` + +## Constructor + +### new AnaglyphEffect( renderer : WebGLRenderer, width : number, height : number ) + +Constructs a new anaglyph effect. + +**renderer** + +The renderer. + +**width** + +The width of the effect in physical pixels. + +Default is `512`. + +**height** + +The height of the effect in physical pixels. + +Default is `512`. + +## Properties + +### .eyeSep : number + +The interpupillary distance (eye separation) in world units. Typical human IPD is 0.064 meters (64mm). + +Default is `0.064`. + +### .planeDistance : number + +The distance in world units from the viewer to the virtual screen plane where zero parallax (screen depth) occurs. Objects at this distance appear at the screen surface. Objects closer appear in front of the screen (negative parallax). Objects further appear behind the screen (positive parallax). + +The screen dimensions are derived from the camera's FOV and aspect ratio at this distance, ensuring the stereo view matches the camera's field of view. + +Default is `0.5`. + +## Methods + +### .dispose() + +Frees internal resources. This method should be called when the effect is no longer required. + +### .render( scene : Object3D, camera : Camera ) + +When using this effect, this method should be called instead of the default [WebGLRenderer#render](WebGLRenderer.html#render). + +**scene** + +The scene to render. + +**camera** + +The camera. + +### .setSize( width : number, height : number ) + +Resizes the effect. + +**width** + +The width of the effect in logical pixels. + +**height** + +The height of the effect in logical pixels. + +## Source + +[examples/jsm/effects/AnaglyphEffect.js](https://github.com/mrdoob/three.js/blob/master/examples/jsm/effects/AnaglyphEffect.js) \ No newline at end of file diff --git a/docs/pages/AnaglyphPassNode.html b/docs/pages/AnaglyphPassNode.html index 8a5d4f963976de..32a3c96f97b58e 100644 --- a/docs/pages/AnaglyphPassNode.html +++ b/docs/pages/AnaglyphPassNode.html @@ -13,12 +13,16 @@A render pass node that creates an anaglyph effect.
A render pass node that creates an anaglyph effect using physically-correct +off-axis stereo projection.
+This implementation uses CameraUtils.frameCorners() to align stereo +camera frustums to a virtual screen plane, providing accurate depth +perception with zero parallax at the plane distance.
AnaglyphPassNode is an addon, and must be imported explicitly, see Installation#Addons.
-import { anaglyphPass } from 'three/addons/tsl/display/AnaglyphPassNode.js';import { anaglyphPass, AnaglyphAlgorithm, AnaglyphColorMode } from 'three/addons/tsl/display/AnaglyphPassNode.js';The scene to render.
@@ -38,7 +42,7 @@The camera to render the scene with.
@@ -49,6 +53,38 @@Gets the current anaglyph algorithm.
+Sets the anaglyph algorithm.
+Gets the current color mode.
+Sets the color mode.
+The interpupillary distance (eye separation) in world units. +Typical human IPD is 0.064 meters (64mm).
+Default is 0.064.
The distance in world units from the viewer to the virtual +screen plane where zero parallax (screen depth) occurs. +Objects at this distance appear at the screen surface. +Objects closer appear in front of the screen (negative parallax). +Objects further appear behind the screen (positive parallax).
+The screen dimensions are derived from the camera's FOV and aspect ratio +at this distance, ensuring the stereo view matches the camera's field of view.
+Default is 0.5.
The current node builder.
@@ -78,6 +127,28 @@Updates the internal stereo camera using frameCorners for +physically-correct off-axis projection.
+| + coordinateSystem + | +
+ The current coordinate system. + |
+
examples/jsm/tsl/display/AnaglyphPassNode.js diff --git a/docs/pages/AnaglyphPassNode.html.md b/docs/pages/AnaglyphPassNode.html.md new file mode 100644 index 00000000000000..5938162abf9c63 --- /dev/null +++ b/docs/pages/AnaglyphPassNode.html.md @@ -0,0 +1,93 @@ +*Inheritance: EventDispatcher → Node → TempNode → PassNode → StereoCompositePassNode →* + +# AnaglyphPassNode + +A render pass node that creates an anaglyph effect using physically-correct off-axis stereo projection. + +This implementation uses CameraUtils.frameCorners() to align stereo camera frustums to a virtual screen plane, providing accurate depth perception with zero parallax at the plane distance. + +## Import + +AnaglyphPassNode is an addon, and must be imported explicitly, see [Installation#Addons](https://threejs.org/manual/#en/installation). + +```js +import { anaglyphPass, AnaglyphAlgorithm, AnaglyphColorMode } from 'three/addons/tsl/display/AnaglyphPassNode.js'; +``` + +## Constructor + +### new AnaglyphPassNode( scene : Scene, camera : Camera ) + +Constructs a new anaglyph pass node. + +**scene** + +The scene to render. + +**camera** + +The camera to render the scene with. + +## Properties + +### .algorithm : string + +Gets the current anaglyph algorithm. + +### .algorithm : string + +Sets the anaglyph algorithm. + +### .colorMode : string + +Gets the current color mode. + +### .colorMode : string + +Sets the color mode. + +### .eyeSep : number + +The interpupillary distance (eye separation) in world units. Typical human IPD is 0.064 meters (64mm). + +Default is `0.064`. + +### .isAnaglyphPassNode : boolean (readonly) + +This flag can be used for type testing. + +Default is `true`. + +### .planeDistance : number + +The distance in world units from the viewer to the virtual screen plane where zero parallax (screen depth) occurs. Objects at this distance appear at the screen surface. Objects closer appear in front of the screen (negative parallax). Objects further appear behind the screen (positive parallax). + +The screen dimensions are derived from the camera's FOV and aspect ratio at this distance, ensuring the stereo view matches the camera's field of view. + +Default is `0.5`. + +## Methods + +### .setup( builder : NodeBuilder ) : PassTextureNode + +This method is used to setup the effect's TSL code. + +**builder** + +The current node builder. + +**Overrides:** [StereoCompositePassNode#setup](StereoCompositePassNode.html#setup) + +### .updateStereoCamera( coordinateSystem : number ) + +Updates the internal stereo camera using frameCorners for physically-correct off-axis projection. + +**coordinateSystem** + +The current coordinate system. + +**Overrides:** [StereoCompositePassNode#updateStereoCamera](StereoCompositePassNode.html#updateStereoCamera) + +## Source + +[examples/jsm/tsl/display/AnaglyphPassNode.js](https://github.com/mrdoob/three.js/blob/master/examples/jsm/tsl/display/AnaglyphPassNode.js) \ No newline at end of file diff --git a/docs/pages/AnalyticLightNode.html b/docs/pages/AnalyticLightNode.html index 89bb32bf2551be..c5ef3303c0ff9f 100644 --- a/docs/pages/AnalyticLightNode.html +++ b/docs/pages/AnalyticLightNode.html @@ -27,7 +27,7 @@
The light source.
@@ -116,7 +116,7 @@The builder object used for setting up the light.
@@ -139,7 +139,7 @@The current node builder.
@@ -160,7 +160,7 @@The builder object used for setting up the light.
@@ -181,7 +181,7 @@The builder object used for setting up the light.
@@ -204,7 +204,7 @@The current node builder.
@@ -234,7 +234,7 @@A reference to the current node frame.
diff --git a/docs/pages/AnalyticLightNode.html.md b/docs/pages/AnalyticLightNode.html.md new file mode 100644 index 00000000000000..10b918f4d456b7 --- /dev/null +++ b/docs/pages/AnalyticLightNode.html.md @@ -0,0 +1,139 @@ +*Inheritance: EventDispatcher → Node → LightingNode →* + +# AnalyticLightNode + +Base class for analytic light nodes. + +## Constructor + +### new AnalyticLightNode( light : Light ) + +Constructs a new analytic light node. + +**light** + +The light source. + +Default is `null`. + +## Properties + +### .baseColorNode : Node + +This property is used to retain a reference to the original value of [AnalyticLightNode#colorNode](AnalyticLightNode.html#colorNode). The final color node is represented by a different node when using shadows. + +Default is `null`. + +### .color : Color + +The light's color value. + +### .colorNode : Node + +The light's color node. Points to `colorNode` of the light source, if set. Otherwise it creates a uniform node based on [AnalyticLightNode#color](AnalyticLightNode.html#color). + +### .isAnalyticLightNode : boolean (readonly) + +This flag can be used for type testing. + +Default is `true`. + +### .light : Light + +The light source. + +Default is `null`. + +### .shadowColorNode : Node + +Represents the light's shadow color. + +Default is `null`. + +### .shadowNode : ShadowNode + +Represents the light's shadow. + +Default is `null`. + +### .updateType : string + +Overwritten since analytic light nodes are updated once per frame. + +Default is `'frame'`. + +**Overrides:** [LightingNode#updateType](LightingNode.html#updateType) + +## Methods + +### .disposeShadow() + +Frees internal resources related to shadows. + +### .getLightVector( builder : NodeBuilder ) : Node.The texture node that represents the input of the effect.
@@ -38,7 +38,7 @@The threshold is one option to control the intensity and size of the effect.
@@ -46,7 +46,7 @@Defines the vertical scale of the flares.
@@ -54,7 +54,7 @@More samples result in larger flares and a more expensive runtime behavior.
@@ -151,7 +151,7 @@The width of the effect.
@@ -159,7 +159,7 @@The height of the effect.
@@ -177,7 +177,7 @@The current node builder.
@@ -198,7 +198,7 @@The current node frame.
diff --git a/docs/pages/AnamorphicNode.html.md b/docs/pages/AnamorphicNode.html.md new file mode 100644 index 00000000000000..513c182fd1f7fb --- /dev/null +++ b/docs/pages/AnamorphicNode.html.md @@ -0,0 +1,127 @@ +*Inheritance: EventDispatcher → Node → TempNode →* + +# AnamorphicNode + +Post processing node for adding an anamorphic flare effect. + +## Import + +AnamorphicNode is an addon, and must be imported explicitly, see [Installation#Addons](https://threejs.org/manual/#en/installation). + +```js +import { anamorphic } from 'three/addons/tsl/display/AnamorphicNode.js'; +``` + +## Constructor + +### new AnamorphicNode( textureNode : TextureNode, thresholdNode : Node.The mixer that is controlled by this action.
@@ -35,7 +35,7 @@The animation clip that holds the actual keyframes.
@@ -43,7 +43,7 @@The root object on which this action is performed.
@@ -52,7 +52,7 @@The blend mode.
@@ -166,7 +166,7 @@The animation action to fade out.
@@ -174,7 +174,7 @@The duration of the fade.
@@ -182,7 +182,7 @@Whether warping should be used or not.
@@ -205,7 +205,7 @@The animation action to fade in.
@@ -213,7 +213,7 @@The duration of the fade.
@@ -221,7 +221,7 @@Whether warping should be used or not.
@@ -244,7 +244,7 @@The duration of the fade.
@@ -266,7 +266,7 @@The duration of the fade.
@@ -332,7 +332,7 @@The duration.
@@ -389,7 +389,7 @@The duration to set.
@@ -412,7 +412,7 @@The time scale to set.
@@ -435,7 +435,7 @@The weight to set.
@@ -456,7 +456,7 @@The loop mode.
@@ -464,7 +464,7 @@The number of repetitions.
@@ -485,7 +485,7 @@The start time in seconds.
@@ -533,7 +533,7 @@The action to sync with.
@@ -556,7 +556,7 @@The start time scale.
@@ -564,7 +564,7 @@The end time scale.
@@ -572,7 +572,7 @@The duration.
diff --git a/docs/pages/AnimationAction.html.md b/docs/pages/AnimationAction.html.md new file mode 100644 index 00000000000000..83a50774142259 --- /dev/null +++ b/docs/pages/AnimationAction.html.md @@ -0,0 +1,337 @@ +# AnimationAction + +An instance of `AnimationAction` schedules the playback of an animation which is stored in [AnimationClip](AnimationClip.html). + +## Constructor + +### new AnimationAction( mixer : AnimationMixer, clip : AnimationClip, localRoot : Object3D, blendMode : NormalAnimationBlendMode | AdditiveAnimationBlendMode ) + +Constructs a new animation action. + +**mixer** + +The mixer that is controlled by this action. + +**clip** + +The animation clip that holds the actual keyframes. + +**localRoot** + +The root object on which this action is performed. + +Default is `null`. + +**blendMode** + +The blend mode. + +## Properties + +### .blendMode : NormalAnimationBlendMode | AdditiveAnimationBlendMode + +Defines how the animation is blended/combined when two or more animations are simultaneously played. + +### .clampWhenFinished : boolean + +If set to true the animation will automatically be paused on its last frame. + +If set to false, [AnimationAction#enabled](AnimationAction.html#enabled) will automatically be switched to `false` when the last loop of the action has finished, so that this action has no further impact. + +Note: This member has no impact if the action is interrupted (it has only an effect if its last loop has really finished). + +Default is `false`. + +### .enabled : boolean + +If set to `false`, the action is disabled so it has no impact. + +When the action is re-enabled, the animation continues from its current time (setting `enabled` to `false` doesn't reset the action). + +Default is `true`. + +### .loop : LoopRepeat | LoopOnce | LoopPingPong + +The loop mode, set via [AnimationAction#setLoop](AnimationAction.html#setLoop). + +Default is `LoopRepeat`. + +### .paused : boolean + +If set to `true`, the playback of the action is paused. + +Default is `false`. + +### .repetitions : number + +The number of repetitions of the performed clip over the course of this action. Can be set via [AnimationAction#setLoop](AnimationAction.html#setLoop). + +Setting this number has no effect if [AnimationAction#loop](AnimationAction.html#loop) is set to `THREE:LoopOnce`. + +Default is `Infinity`. + +### .time : number + +The local time of this action (in seconds, starting with `0`). + +The value gets clamped or wrapped to `[0,clip.duration]` (according to the loop state). + +Default is `Infinity`. + +### .timeScale : number + +Scaling factor for the [AnimationAction#time](AnimationAction.html#time). A value of `0` causes the animation to pause. Negative values cause the animation to play backwards. + +Default is `1`. + +### .weight : number + +The degree of influence of this action (in the interval `[0, 1]`). Values between `0` (no impact) and `1` (full impact) can be used to blend between several actions. + +Default is `1`. + +### .zeroSlopeAtEnd : boolean + +Enables smooth interpolation without separate clips for start, loop and end. + +Default is `true`. + +### .zeroSlopeAtStart : boolean + +Enables smooth interpolation without separate clips for start, loop and end. + +Default is `true`. + +## Methods + +### .crossFadeFrom( fadeOutAction : AnimationAction, duration : number, warp : boolean ) : AnimationAction + +Causes this action to fade in and the given action to fade out, within the passed time interval. + +**fadeOutAction** + +The animation action to fade out. + +**duration** + +The duration of the fade. + +**warp** + +Whether warping should be used or not. + +Default is `false`. + +**Returns:** A reference to this animation action. + +### .crossFadeTo( fadeInAction : AnimationAction, duration : number, warp : boolean ) : AnimationAction + +Causes this action to fade out and the given action to fade in, within the passed time interval. + +**fadeInAction** + +The animation action to fade in. + +**duration** + +The duration of the fade. + +**warp** + +Whether warping should be used or not. + +Default is `false`. + +**Returns:** A reference to this animation action. + +### .fadeIn( duration : number ) : AnimationAction + +Fades the animation in by increasing its weight gradually from `0` to `1`, within the passed time interval. + +**duration** + +The duration of the fade. + +**Returns:** A reference to this animation action. + +### .fadeOut( duration : number ) : AnimationAction + +Fades the animation out by decreasing its weight gradually from `1` to `0`, within the passed time interval. + +**duration** + +The duration of the fade. + +**Returns:** A reference to this animation action. + +### .getClip() : AnimationClip + +Returns the animation clip of this animation action. + +**Returns:** The animation clip. + +### .getEffectiveTimeScale() : number + +Returns the effective time scale of this action. + +**Returns:** The effective time scale. + +### .getEffectiveWeight() : number + +Returns the effective weight of this action. + +**Returns:** The effective weight. + +### .getMixer() : AnimationMixer + +Returns the animation mixer of this animation action. + +**Returns:** The animation mixer. + +### .getRoot() : Object3D + +Returns the root object of this animation action. + +**Returns:** The root object. + +### .halt( duration : number ) : AnimationAction + +Decelerates this animation's speed to `0` within the passed time interval. + +**duration** + +The duration. + +**Returns:** A reference to this animation action. + +### .isRunning() : boolean + +Returns `true` if the animation is running. + +**Returns:** Whether the animation is running or not. + +### .isScheduled() : boolean + +Returns `true` when [AnimationAction#play](AnimationAction.html#play) has been called. + +**Returns:** Whether the animation is scheduled or not. + +### .play() : AnimationAction + +Starts the playback of the animation. + +**Returns:** A reference to this animation action. + +### .reset() : AnimationAction + +Resets the playback of the animation. + +**Returns:** A reference to this animation action. + +### .setDuration( duration : number ) : AnimationAction + +Sets the duration for a single loop of this action. + +**duration** + +The duration to set. + +**Returns:** A reference to this animation action. + +### .setEffectiveTimeScale( timeScale : number ) : AnimationAction + +Sets the effective time scale of this action. + +An action has no effect and thus an effective time scale of zero when the action is paused. + +**timeScale** + +The time scale to set. + +**Returns:** A reference to this animation action. + +### .setEffectiveWeight( weight : number ) : AnimationAction + +Sets the effective weight of this action. + +An action has no effect and thus an effective weight of zero when the action is disabled. + +**weight** + +The weight to set. + +**Returns:** A reference to this animation action. + +### .setLoop( mode : LoopRepeat | LoopOnce | LoopPingPong, repetitions : number ) : AnimationAction + +Configures the loop settings for this action. + +**mode** + +The loop mode. + +**repetitions** + +The number of repetitions. + +**Returns:** A reference to this animation action. + +### .startAt( time : number ) : AnimationAction + +Defines the time when the animation should start. + +**time** + +The start time in seconds. + +**Returns:** A reference to this animation action. + +### .stop() : AnimationAction + +Stops the playback of the animation. + +**Returns:** A reference to this animation action. + +### .stopFading() : AnimationAction + +Stops any fading which is applied to this action. + +**Returns:** A reference to this animation action. + +### .stopWarping() : AnimationAction + +Stops any scheduled warping which is applied to this action. + +**Returns:** A reference to this animation action. + +### .syncWith( action : AnimationAction ) : AnimationAction + +Synchronizes this action with the passed other action. + +**action** + +The action to sync with. + +**Returns:** A reference to this animation action. + +### .warp( startTimeScale : number, endTimeScale : number, duration : number ) : AnimationAction + +Changes the playback speed, within the passed time interval, by modifying [AnimationAction#timeScale](AnimationAction.html#timeScale) gradually from `startTimeScale` to `endTimeScale`. + +**startTimeScale** + +The start time scale. + +**endTimeScale** + +The end time scale. + +**duration** + +The duration. + +**Returns:** A reference to this animation action. + +## Source + +[src/animation/AnimationAction.js](https://github.com/mrdoob/three.js/blob/master/src/animation/AnimationAction.js) \ No newline at end of file diff --git a/docs/pages/AnimationClip.html b/docs/pages/AnimationClip.html index 9e583ba691bc6d..9356472e489dea 100644 --- a/docs/pages/AnimationClip.html +++ b/docs/pages/AnimationClip.html @@ -29,7 +29,7 @@The clip's name.
@@ -38,7 +38,7 @@The clip's duration in seconds. If a negative value is passed, @@ -48,7 +48,7 @@
An array of keyframe tracks.
@@ -56,7 +56,7 @@Defines how the animation @@ -177,7 +177,7 @@
A sequence of morph targets.
@@ -185,7 +185,7 @@The Frames-Per-Second value.
@@ -193,7 +193,7 @@Whether the clip should be no loop or not.
@@ -217,7 +217,7 @@The name of the animation clip.
@@ -225,7 +225,7 @@A sequence of morph targets.
@@ -233,7 +233,7 @@The Frames-Per-Second value.
@@ -241,7 +241,7 @@Whether the clip should be no loop or not.
@@ -264,7 +264,7 @@The array or object to search through.
@@ -272,7 +272,7 @@The name to search for.
@@ -293,7 +293,7 @@The serialized animation clip.
@@ -305,7 +305,7 @@Parses the animation.hierarchy format and returns a new animation clip.
A serialized animation clip as JSON.
@@ -322,7 +322,7 @@An array of bones.
@@ -346,7 +346,7 @@The animation clip to serialize.
diff --git a/docs/pages/AnimationClip.html.md b/docs/pages/AnimationClip.html.md new file mode 100644 index 00000000000000..6949c162278a90 --- /dev/null +++ b/docs/pages/AnimationClip.html.md @@ -0,0 +1,197 @@ +# AnimationClip + +A reusable set of keyframe tracks which represent an animation. + +## Constructor + +### new AnimationClip( name : string, duration : number, tracks : Array.