@types/three 0.181.0 → 0.183.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (351) hide show
  1. three/README.md +1 -1
  2. three/examples/jsm/Addons.d.ts +0 -3
  3. three/examples/jsm/controls/ArcballControls.d.ts +1 -1
  4. three/examples/jsm/controls/DragControls.d.ts +1 -1
  5. three/examples/jsm/controls/FirstPersonControls.d.ts +1 -1
  6. three/examples/jsm/controls/FlyControls.d.ts +1 -1
  7. three/examples/jsm/controls/OrbitControls.d.ts +40 -1
  8. three/examples/jsm/controls/PointerLockControls.d.ts +1 -1
  9. three/examples/jsm/controls/TrackballControls.d.ts +1 -1
  10. three/examples/jsm/controls/TransformControls.d.ts +1 -1
  11. three/examples/jsm/effects/AnaglyphEffect.d.ts +4 -0
  12. three/examples/jsm/environments/ColorEnvironment.d.ts +9 -0
  13. three/examples/jsm/gpgpu/BitonicSort.d.ts +5 -5
  14. three/examples/jsm/helpers/AnimationPathHelper.d.ts +38 -0
  15. three/examples/jsm/helpers/ViewHelper.d.ts +4 -1
  16. three/examples/jsm/inspector/tabs/Parameters.d.ts +3 -0
  17. three/examples/jsm/inspector/ui/Item.d.ts +5 -0
  18. three/examples/jsm/libs/meshopt_decoder.module.d.ts +1 -1
  19. three/examples/jsm/lights/LightProbeGenerator.d.ts +11 -5
  20. three/examples/jsm/loaders/ColladaLoader.d.ts +27 -4
  21. three/examples/jsm/loaders/UltraHDRLoader.d.ts +7 -0
  22. three/examples/jsm/loaders/VOXLoader.d.ts +22 -5
  23. three/examples/jsm/math/Octree.d.ts +36 -14
  24. three/examples/jsm/objects/SkyMesh.d.ts +16 -6
  25. three/examples/jsm/objects/Water2Mesh.d.ts +7 -7
  26. three/examples/jsm/objects/WaterMesh.d.ts +6 -6
  27. three/examples/jsm/physics/AmmoPhysics.d.ts +1 -1
  28. three/examples/jsm/postprocessing/EffectComposer.d.ts +9 -10
  29. three/examples/jsm/postprocessing/OutputPass.d.ts +10 -6
  30. three/examples/jsm/postprocessing/RenderPass.d.ts +15 -10
  31. three/examples/jsm/postprocessing/UnrealBloomPass.d.ts +4 -9
  32. three/examples/jsm/transpiler/AST.d.ts +17 -0
  33. three/examples/jsm/transpiler/TSLEncoder.d.ts +2 -0
  34. three/examples/jsm/tsl/display/AnaglyphPassNode.d.ts +30 -0
  35. three/examples/jsm/tsl/display/AnamorphicNode.d.ts +1 -1
  36. three/examples/jsm/tsl/display/BilateralBlurNode.d.ts +27 -0
  37. three/examples/jsm/tsl/display/BleachBypass.d.ts +1 -1
  38. three/examples/jsm/tsl/display/BloomNode.d.ts +5 -5
  39. three/examples/jsm/tsl/display/CRT.d.ts +22 -0
  40. three/examples/jsm/tsl/display/DenoiseNode.d.ts +5 -5
  41. three/examples/jsm/tsl/display/DotScreenNode.d.ts +4 -6
  42. three/examples/jsm/tsl/display/GTAONode.d.ts +8 -8
  43. three/examples/jsm/tsl/display/GaussianBlurNode.d.ts +4 -2
  44. three/examples/jsm/tsl/display/GodraysNode.d.ts +20 -0
  45. three/examples/jsm/tsl/display/LensflareNode.d.ts +6 -6
  46. three/examples/jsm/tsl/display/Lut3DNode.d.ts +5 -5
  47. three/examples/jsm/tsl/display/MotionBlur.d.ts +1 -1
  48. three/examples/jsm/tsl/display/OutlineNode.d.ts +6 -6
  49. three/examples/jsm/tsl/display/PixelationPassNode.d.ts +10 -10
  50. three/examples/jsm/tsl/display/RGBShiftNode.d.ts +2 -2
  51. three/examples/jsm/tsl/display/RetroPassNode.d.ts +17 -0
  52. three/examples/jsm/tsl/display/SSAAPassNode.d.ts +1 -1
  53. three/examples/jsm/tsl/display/SSGINode.d.ts +11 -11
  54. three/examples/jsm/tsl/display/SSRNode.d.ts +6 -6
  55. three/examples/jsm/tsl/display/SSSNode.d.ts +7 -5
  56. three/examples/jsm/tsl/display/Shape.d.ts +3 -0
  57. three/examples/jsm/tsl/display/TRAANode.d.ts +5 -0
  58. three/examples/jsm/tsl/display/TransitionNode.d.ts +3 -3
  59. three/examples/jsm/tsl/display/boxBlur.d.ts +1 -1
  60. three/examples/jsm/tsl/display/depthAwareBlend.d.ts +15 -0
  61. three/examples/jsm/tsl/display/hashBlur.d.ts +1 -1
  62. three/examples/jsm/tsl/display/radialBlur.d.ts +12 -0
  63. three/examples/jsm/tsl/math/Bayer.d.ts +2 -0
  64. three/examples/jsm/tsl/utils/Raymarching.d.ts +2 -2
  65. three/package.json +4 -4
  66. three/src/Three.Core.d.ts +1 -1
  67. three/src/Three.TSL.d.ts +20 -13
  68. three/src/Three.WebGPU.Nodes.d.ts +2 -0
  69. three/src/Three.WebGPU.d.ts +3 -0
  70. three/src/Three.d.ts +2 -2
  71. three/src/animation/AnimationClip.d.ts +1 -1
  72. three/src/animation/AnimationMixer.d.ts +42 -0
  73. three/src/animation/AnimationUtils.d.ts +3 -8
  74. three/src/animation/KeyframeTrack.d.ts +19 -5
  75. three/src/animation/PropertyMixer.d.ts +5 -4
  76. three/src/audio/Audio.d.ts +224 -157
  77. three/src/audio/AudioAnalyser.d.ts +32 -27
  78. three/src/audio/AudioContext.d.ts +12 -12
  79. three/src/audio/AudioListener.d.ts +44 -65
  80. three/src/audio/PositionalAudio.d.ts +69 -62
  81. three/src/cameras/ArrayCamera.d.ts +21 -24
  82. three/src/cameras/Camera.d.ts +14 -53
  83. three/src/cameras/CubeCamera.d.ts +32 -28
  84. three/src/cameras/OrthographicCamera.d.ts +70 -100
  85. three/src/cameras/PerspectiveCamera.d.ts +133 -146
  86. three/src/cameras/StereoCamera.d.ts +24 -30
  87. three/src/constants.d.ts +28 -2
  88. three/src/core/BufferGeometry.d.ts +3 -1
  89. three/src/core/Clock.d.ts +3 -0
  90. three/src/core/Object3D.d.ts +31 -7
  91. three/src/extras/Controls.d.ts +3 -3
  92. three/src/geometries/TorusGeometry.d.ts +22 -3
  93. three/src/helpers/ArrowHelper.d.ts +34 -50
  94. three/src/helpers/AxesHelper.d.ts +22 -36
  95. three/src/helpers/Box3Helper.d.ts +14 -25
  96. three/src/helpers/BoxHelper.d.ts +28 -39
  97. three/src/helpers/CameraHelper.d.ts +31 -52
  98. three/src/helpers/DirectionalLightHelper.d.ts +32 -53
  99. three/src/helpers/GridHelper.d.ts +15 -29
  100. three/src/helpers/HemisphereLightHelper.d.ts +26 -49
  101. three/src/helpers/PlaneHelper.d.ts +21 -33
  102. three/src/helpers/PointLightHelper.d.ts +25 -50
  103. three/src/helpers/PolarGridHelper.d.ts +19 -32
  104. three/src/helpers/SkeletonHelper.d.ts +26 -50
  105. three/src/helpers/SpotLightHelper.d.ts +28 -55
  106. three/src/lights/AmbientLight.d.ts +15 -23
  107. three/src/lights/DirectionalLight.d.ts +49 -83
  108. three/src/lights/DirectionalLightShadow.d.ts +6 -61
  109. three/src/lights/HemisphereLight.d.ts +27 -47
  110. three/src/lights/Light.d.ts +22 -56
  111. three/src/lights/LightProbe.d.ts +31 -32
  112. three/src/lights/LightShadow.d.ts +107 -91
  113. three/src/lights/PointLight.d.ts +47 -77
  114. three/src/lights/PointLightShadow.d.ts +7 -11
  115. three/src/lights/RectAreaLight.d.ts +39 -59
  116. three/src/lights/SpotLight.d.ts +78 -117
  117. three/src/lights/SpotLightShadow.d.ts +17 -59
  118. three/src/lights/webgpu/IESSpotLight.d.ts +13 -1
  119. three/src/lights/webgpu/ProjectorLight.d.ts +9 -10
  120. three/src/materials/Material.d.ts +1 -0
  121. three/src/materials/MeshLambertMaterial.d.ts +6 -0
  122. three/src/materials/MeshPhongMaterial.d.ts +6 -0
  123. three/src/materials/ShaderMaterial.d.ts +18 -3
  124. three/src/materials/nodes/Line2NodeMaterial.d.ts +0 -6
  125. three/src/materials/nodes/LineBasicNodeMaterial.d.ts +0 -4
  126. three/src/materials/nodes/MeshBasicNodeMaterial.d.ts +1 -2
  127. three/src/materials/nodes/MeshLambertNodeMaterial.d.ts +0 -2
  128. three/src/materials/nodes/MeshNormalNodeMaterial.d.ts +0 -2
  129. three/src/materials/nodes/MeshSSSNodeMaterial.d.ts +5 -8
  130. three/src/materials/nodes/MeshToonNodeMaterial.d.ts +0 -4
  131. three/src/materials/nodes/NodeMaterial.d.ts +15 -2
  132. three/src/materials/nodes/SpriteNodeMaterial.d.ts +0 -3
  133. three/src/materials/nodes/VolumeNodeMaterial.d.ts +0 -2
  134. three/src/materials/nodes/manager/NodeMaterialObserver.d.ts +39 -93
  135. three/src/math/Color.d.ts +1 -0
  136. three/src/math/Vector3.d.ts +2 -2
  137. three/src/math/interpolants/BezierInterpolant.d.ts +7 -0
  138. three/src/nodes/Nodes.d.ts +55 -35
  139. three/src/nodes/TSL.d.ts +6 -6
  140. three/src/nodes/accessors/Arrays.d.ts +19 -10
  141. three/src/nodes/accessors/BufferAttributeNode.d.ts +108 -41
  142. three/src/nodes/accessors/BufferNode.d.ts +21 -7
  143. three/src/nodes/accessors/Camera.d.ts +10 -10
  144. three/src/nodes/accessors/CubeTextureNode.d.ts +1 -1
  145. three/src/nodes/accessors/InstanceNode.d.ts +13 -6
  146. three/src/nodes/accessors/Lights.d.ts +9 -6
  147. three/src/nodes/accessors/MaterialNode.d.ts +1 -3
  148. three/src/nodes/accessors/MaterialProperties.d.ts +4 -4
  149. three/src/nodes/accessors/MaterialReferenceNode.d.ts +1 -1
  150. three/src/nodes/accessors/ModelNode.d.ts +34 -17
  151. three/src/nodes/accessors/MorphNode.d.ts +1 -1
  152. three/src/nodes/accessors/Normal.d.ts +13 -15
  153. three/src/nodes/accessors/Object3DNode.d.ts +35 -16
  154. three/src/nodes/accessors/Position.d.ts +9 -7
  155. three/src/nodes/accessors/ReferenceNode.d.ts +16 -7
  156. three/src/nodes/accessors/ReflectVector.d.ts +4 -5
  157. three/src/nodes/accessors/RendererReferenceNode.d.ts +1 -1
  158. three/src/nodes/accessors/SceneProperties.d.ts +5 -0
  159. three/src/nodes/accessors/SkinningNode.d.ts +5 -3
  160. three/src/nodes/accessors/StorageBufferNode.d.ts +49 -22
  161. three/src/nodes/accessors/StorageTextureNode.d.ts +1 -1
  162. three/src/nodes/accessors/Tangent.d.ts +5 -7
  163. three/src/nodes/accessors/Texture3DNode.d.ts +13 -1
  164. three/src/nodes/accessors/TextureBicubic.d.ts +3 -2
  165. three/src/nodes/accessors/TextureNode.d.ts +19 -18
  166. three/src/nodes/accessors/UV.d.ts +1 -1
  167. three/src/nodes/accessors/UniformArrayNode.d.ts +10 -8
  168. three/src/nodes/accessors/UserDataNode.d.ts +1 -1
  169. three/src/nodes/accessors/VelocityNode.d.ts +3 -3
  170. three/src/nodes/accessors/VertexColorNode.d.ts +1 -1
  171. three/src/nodes/code/FunctionCallNode.d.ts +0 -1
  172. three/src/nodes/code/FunctionNode.d.ts +7 -3
  173. three/src/nodes/core/ArrayNode.d.ts +2 -3
  174. three/src/nodes/core/AttributeNode.d.ts +12 -6
  175. three/src/nodes/core/BypassNode.d.ts +2 -3
  176. three/src/nodes/core/ConstNode.d.ts +10 -3
  177. three/src/nodes/core/ContextNode.d.ts +32 -21
  178. three/src/nodes/core/IndexNode.d.ts +1 -1
  179. three/src/nodes/core/InputNode.d.ts +12 -4
  180. three/src/nodes/core/InspectorNode.d.ts +2 -3
  181. three/src/nodes/core/IsolateNode.d.ts +2 -7
  182. three/src/nodes/core/MRTNode.d.ts +7 -0
  183. three/src/nodes/core/Node.d.ts +258 -39
  184. three/src/nodes/core/NodeAttribute.d.ts +30 -5
  185. three/src/nodes/core/NodeBuilder.d.ts +5 -3
  186. three/src/nodes/core/NodeCache.d.ts +24 -48
  187. three/src/nodes/core/NodeError.d.ts +9 -0
  188. three/src/nodes/core/NodeParser.d.ts +2 -0
  189. three/src/nodes/core/NodeUniform.d.ts +33 -9
  190. three/src/nodes/core/NodeUtils.d.ts +1 -1
  191. three/src/nodes/core/NodeVar.d.ts +33 -5
  192. three/src/nodes/core/NodeVarying.d.ts +32 -4
  193. three/src/nodes/core/ParameterNode.d.ts +11 -4
  194. three/src/nodes/core/PropertyNode.d.ts +45 -33
  195. three/src/nodes/core/StackTrace.d.ts +9 -0
  196. three/src/nodes/core/StructType.d.ts +3 -1
  197. three/src/nodes/core/StructTypeNode.d.ts +19 -5
  198. three/src/nodes/core/TempNode.d.ts +9 -3
  199. three/src/nodes/core/UniformNode.d.ts +53 -15
  200. three/src/nodes/core/VarNode.d.ts +15 -14
  201. three/src/nodes/core/VaryingNode.d.ts +14 -19
  202. three/src/nodes/core/constants.d.ts +9 -4
  203. three/src/nodes/display/BlendModes.d.ts +7 -27
  204. three/src/nodes/display/ColorAdjustment.d.ts +8 -9
  205. three/src/nodes/display/ColorSpaceNode.d.ts +2 -8
  206. three/src/nodes/display/FrontFacingNode.d.ts +1 -1
  207. three/src/nodes/display/NormalMapNode.d.ts +3 -1
  208. three/src/nodes/display/PassNode.d.ts +16 -4
  209. three/src/nodes/display/RenderOutputNode.d.ts +3 -7
  210. three/src/nodes/display/ScreenNode.d.ts +25 -17
  211. three/src/nodes/display/ToneMappingNode.d.ts +3 -7
  212. three/src/nodes/display/ViewportDepthNode.d.ts +11 -7
  213. three/src/nodes/display/ViewportTextureNode.d.ts +2 -0
  214. three/src/nodes/fog/Fog.d.ts +5 -3
  215. three/src/nodes/functions/BSDF/DFGLUT.d.ts +12 -0
  216. three/src/nodes/functions/PhysicalLightingModel.d.ts +8 -1
  217. three/src/nodes/geometry/RangeNode.d.ts +51 -9
  218. three/src/nodes/gpgpu/AtomicFunctionNode.d.ts +2 -0
  219. three/src/nodes/gpgpu/BarrierNode.d.ts +2 -0
  220. three/src/nodes/gpgpu/ComputeNode.d.ts +2 -7
  221. three/src/nodes/lighting/AnalyticLightNode.d.ts +3 -1
  222. three/src/nodes/lighting/HemisphereLightNode.d.ts +3 -2
  223. three/src/nodes/lighting/LightProbeNode.d.ts +1 -1
  224. three/src/nodes/lighting/LightUtils.d.ts +1 -1
  225. three/src/nodes/lighting/LightingContextNode.d.ts +1 -1
  226. three/src/nodes/lighting/PointShadowNode.d.ts +11 -15
  227. three/src/nodes/lighting/ShadowFilterNode.d.ts +2 -0
  228. three/src/nodes/lighting/SpotLightNode.d.ts +0 -6
  229. three/src/nodes/materialx/MaterialXNodes.d.ts +11 -11
  230. three/src/nodes/math/BitcountNode.d.ts +23 -0
  231. three/src/nodes/math/ConditionalNode.d.ts +43 -22
  232. three/src/nodes/math/Hash.d.ts +1 -1
  233. three/src/nodes/math/MathNode.d.ts +603 -267
  234. three/src/nodes/math/MathUtils.d.ts +9 -5
  235. three/src/nodes/math/OperatorNode.d.ts +490 -227
  236. three/src/nodes/math/PackFloatNode.d.ts +19 -0
  237. three/src/nodes/math/TriNoise3D.d.ts +3 -3
  238. three/src/nodes/math/UnpackFloatNode.d.ts +18 -0
  239. three/src/nodes/pmrem/PMREMNode.d.ts +1 -1
  240. three/src/nodes/procedural/Checker.d.ts +1 -1
  241. three/src/nodes/tsl/TSLCore.d.ts +1683 -224
  242. three/src/nodes/utils/ArrayElementNode.d.ts +9 -4
  243. three/src/nodes/utils/DebugNode.d.ts +2 -5
  244. three/src/nodes/utils/Discard.d.ts +2 -3
  245. three/src/nodes/utils/FlipNode.d.ts +11 -0
  246. three/src/nodes/utils/LoopNode.d.ts +17 -13
  247. three/src/nodes/utils/MaxMipLevelNode.d.ts +1 -1
  248. three/src/nodes/utils/Oscillators.d.ts +4 -4
  249. three/src/nodes/utils/Packing.d.ts +3 -2
  250. three/src/nodes/utils/PostProcessingUtils.d.ts +6 -4
  251. three/src/nodes/utils/RemapNode.d.ts +33 -39
  252. three/src/nodes/utils/RotateNode.d.ts +17 -8
  253. three/src/nodes/utils/SplitNode.d.ts +1 -2
  254. three/src/nodes/utils/SpriteSheetUV.d.ts +7 -0
  255. three/src/nodes/utils/StorageArrayElementNode.d.ts +18 -9
  256. three/src/nodes/utils/Timer.d.ts +4 -4
  257. three/src/nodes/utils/TriplanarTextures.d.ts +2 -2
  258. three/src/nodes/utils/UVUtils.d.ts +8 -3
  259. three/src/objects/BatchedMesh.d.ts +6 -4
  260. three/src/objects/InstancedMesh.d.ts +32 -24
  261. three/src/objects/LOD.d.ts +1 -1
  262. three/src/objects/Skeleton.d.ts +4 -2
  263. three/src/renderers/WebGLRenderer.d.ts +25 -96
  264. three/src/renderers/common/Animation.d.ts +46 -9
  265. three/src/renderers/common/Attributes.d.ts +11 -13
  266. three/src/renderers/common/Backend.d.ts +0 -2
  267. three/src/renderers/common/Background.d.ts +17 -15
  268. three/src/renderers/common/BindGroup.d.ts +27 -13
  269. three/src/renderers/common/Binding.d.ts +21 -3
  270. three/src/renderers/common/Bindings.d.ts +41 -17
  271. three/src/renderers/common/BlendMode.d.ts +22 -0
  272. three/src/renderers/common/Buffer.d.ts +53 -5
  273. three/src/renderers/common/BufferUtils.d.ts +3 -4
  274. three/src/renderers/common/BundleGroup.d.ts +16 -6
  275. three/src/renderers/common/CanvasTarget.d.ts +76 -13
  276. three/src/renderers/common/ChainMap.d.ts +18 -8
  277. three/src/renderers/common/ClippingContext.d.ts +61 -10
  278. three/src/renderers/common/Color4.d.ts +10 -5
  279. three/src/renderers/common/ComputePipeline.d.ts +16 -2
  280. three/src/renderers/common/Constants.d.ts +5 -3
  281. three/src/renderers/common/CubeRenderTarget.d.ts +24 -7
  282. three/src/renderers/common/DataMap.d.ts +10 -18
  283. three/src/renderers/common/Geometries.d.ts +45 -19
  284. three/src/renderers/common/Info.d.ts +62 -9
  285. three/src/renderers/common/InspectorBase.d.ts +19 -7
  286. three/src/renderers/common/Lighting.d.ts +2 -6
  287. three/src/renderers/common/Pipeline.d.ts +14 -2
  288. three/src/renderers/common/Pipelines.d.ts +58 -60
  289. three/src/renderers/common/PostProcessing.d.ts +14 -17
  290. three/src/renderers/common/ProgrammableStage.d.ts +48 -8
  291. three/src/renderers/common/RenderBundle.d.ts +4 -2
  292. three/src/renderers/common/RenderBundles.d.ts +6 -3
  293. three/src/renderers/common/RenderContext.d.ts +175 -7
  294. three/src/renderers/common/RenderContexts.d.ts +21 -24
  295. three/src/renderers/common/RenderList.d.ts +77 -11
  296. three/src/renderers/common/RenderLists.d.ts +16 -4
  297. three/src/renderers/common/RenderObject.d.ts +229 -47
  298. three/src/renderers/common/{RenderPipeline.d.ts → RenderObjectPipeline.d.ts} +17 -5
  299. three/src/renderers/common/RenderObjects.d.ts +55 -22
  300. three/src/renderers/common/Renderer.d.ts +645 -216
  301. three/src/renderers/common/Textures.d.ts +24 -46
  302. three/src/renderers/common/TimestampQueryPool.d.ts +62 -8
  303. three/src/renderers/common/Uniform.d.ts +143 -58
  304. three/src/renderers/common/UniformBuffer.d.ts +7 -5
  305. three/src/renderers/common/UniformsGroup.d.ts +51 -35
  306. three/src/renderers/common/XRManager.d.ts +321 -83
  307. three/src/renderers/common/XRRenderTarget.d.ts +49 -6
  308. three/src/renderers/common/nodes/NodeBuilderState.d.ts +75 -15
  309. three/src/renderers/common/nodes/NodeLibrary.d.ts +25 -5
  310. three/src/renderers/common/nodes/{Nodes.d.ts → NodeManager.d.ts} +54 -73
  311. three/src/renderers/common/nodes/NodeUniform.d.ts +60 -70
  312. three/src/renderers/common/nodes/NodeUniformsGroup.d.ts +23 -4
  313. three/src/renderers/shaders/ShaderLib.d.ts +1 -1
  314. three/src/renderers/shaders/UniformsLib.d.ts +0 -3
  315. three/src/renderers/webgl/WebGLAttributes.d.ts +9 -7
  316. three/src/renderers/webgl/WebGLCapabilities.d.ts +2 -2
  317. three/src/renderers/webgl/WebGLEnvironments.d.ts +8 -0
  318. three/src/renderers/webgl/WebGLExtensions.d.ts +1 -1
  319. three/src/renderers/webgl/WebGLIndexedBufferRenderer.d.ts +9 -5
  320. three/src/renderers/webgl/WebGLLights.d.ts +19 -18
  321. three/src/renderers/webgl/WebGLObjects.d.ts +15 -2
  322. three/src/renderers/webgl/WebGLProgram.d.ts +2 -10
  323. three/src/renderers/webgl/WebGLPrograms.d.ts +2 -3
  324. three/src/renderers/webgl/WebGLRenderLists.d.ts +1 -3
  325. three/src/renderers/webgl/WebGLShadowMap.d.ts +0 -5
  326. three/src/renderers/webgl/WebGLState.d.ts +305 -28
  327. three/src/renderers/webgl/WebGLTextures.d.ts +10 -9
  328. three/src/renderers/webgl/WebGLUniforms.d.ts +0 -7
  329. three/src/renderers/webgpu/WebGPUBackend.d.ts +0 -1
  330. three/src/renderers/webgpu/nodes/BasicNodeLibrary.d.ts +2 -4
  331. three/src/renderers/webgpu/nodes/StandardNodeLibrary.d.ts +15 -4
  332. three/src/renderers/webgpu/nodes/WGSLNodeBuilder.d.ts +1 -1
  333. three/src/scenes/Fog.d.ts +31 -37
  334. three/src/scenes/FogExp2.d.ts +26 -31
  335. three/src/scenes/Scene.d.ts +51 -65
  336. three/src/textures/CompressedArrayTexture.d.ts +1 -1
  337. three/src/textures/CubeDepthTexture.d.ts +41 -0
  338. three/src/textures/CubeTexture.d.ts +4 -4
  339. three/src/textures/DataArrayTexture.d.ts +1 -1
  340. three/src/utils.d.ts +18 -1
  341. three/examples/jsm/materials/MeshGouraudMaterial.d.ts +0 -18
  342. three/examples/jsm/materials/MeshPostProcessingMaterial.d.ts +0 -13
  343. three/examples/jsm/shaders/GodRaysShader.d.ts +0 -44
  344. three/src/nodes/accessors/SceneNode.d.ts +0 -21
  345. three/src/nodes/code/ScriptableNode.d.ts +0 -21
  346. three/src/nodes/code/ScriptableValueNode.d.ts +0 -9
  347. three/src/nodes/display/PosterizeNode.d.ts +0 -13
  348. three/src/nodes/functions/BSDF/DFGApprox.d.ts +0 -10
  349. three/src/nodes/utils/SpriteSheetUVNode.d.ts +0 -15
  350. three/src/renderers/webgl/WebGLCubeMaps.d.ts +0 -8
  351. three/src/renderers/webgl/WebGLCubeUVMaps.d.ts +0 -9
@@ -1,80 +1,59 @@
1
1
  import { Camera } from "../cameras/Camera.js";
2
2
  import { Color } from "../math/Color.js";
3
- import { Matrix4 } from "../math/Matrix4.js";
4
3
  import { LineSegments } from "../objects/LineSegments.js";
5
4
 
6
5
  /**
7
- * This helps with visualizing what a camera contains in its frustum
8
- * @remarks
9
- * It visualizes the frustum of a camera using a {@link THREE.LineSegments | LineSegments}.
10
- * @remarks {@link CameraHelper} must be a child of the scene.
11
- * @example
12
- * ```typescript
13
- * const camera = new THREE.PerspectiveCamera(75, window.innerWidth / window.innerHeight, 0.1, 1000);
14
- * const helper = new THREE.CameraHelper(camera);
15
- * scene.add(helper);
6
+ * This helps with visualizing what a camera contains in its frustum. It
7
+ * visualizes the frustum of a camera using a line segments.
8
+ *
9
+ * Based on frustum visualization in [lightgl.js shadowmap example](https://github.com/evanw/lightgl.js/blob/master/tests/shadowmap.html).
10
+ *
11
+ * `CameraHelper` must be a child of the scene.
12
+ *
13
+ * When the camera is transformed or its projection matrix is changed, it's necessary
14
+ * to call the `update()` method of the respective helper.
15
+ *
16
+ * ```js
17
+ * const camera = new THREE.PerspectiveCamera( 75, window.innerWidth / window.innerHeight, 0.1, 1000 );
18
+ * const helper = new THREE.CameraHelper( camera );
19
+ * scene.add( helper );
16
20
  * ```
17
- * @see Example: {@link https://threejs.org/examples/#webgl_camera | WebGL / camera}
18
- * @see Example: {@link https://threejs.org/examples/#webgl_geometry_extrude_splines | WebGL / extrude / splines}
19
- * @see {@link https://threejs.org/docs/index.html#api/en/helpers/CameraHelper | Official Documentation}
20
- * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/CameraHelper.js | Source}
21
21
  */
22
22
  export class CameraHelper extends LineSegments {
23
23
  /**
24
- * This create a new {@link CameraHelper} for the specified camera.
25
- * @param camera The camera to visualize.
24
+ * Constructs a new arrow helper.
25
+ *
26
+ * @param {Camera} camera - The camera to visualize.
26
27
  */
27
28
  constructor(camera: Camera);
28
-
29
- /**
30
- * A Read-only _string_ to check if `this` object type.
31
- * @remarks Sub-classes will update this value.
32
- * @override
33
- * @defaultValue `CameraHelper`
34
- */
35
- override readonly type: string | "CameraHelper";
36
-
37
29
  /**
38
30
  * The camera being visualized.
39
31
  */
40
32
  camera: Camera;
41
-
42
33
  /**
43
34
  * This contains the points used to visualize the camera.
44
35
  */
45
- pointMap: { [id: string]: number[] };
46
-
47
- /**
48
- * Reference to the {@link THREE.Camera.matrixWorld | camera.matrixWorld}.
49
- */
50
- matrix: Matrix4;
51
-
52
- /**
53
- * Is set to `false`, as the helper is using the {@link THREE.Camera.matrixWorld | camera.matrixWorld}.
54
- * @see {@link THREE.Object3D.matrixAutoUpdate | Object3D.matrixAutoUpdate}.
55
- * @defaultValue `false`.
56
- */
57
- override matrixAutoUpdate: boolean;
58
-
36
+ pointMap: {
37
+ [x: string]: number[];
38
+ };
59
39
  /**
60
40
  * Defines the colors of the helper.
61
- * @param frustum
62
- * @param cone
63
- * @param up
64
- * @param target
65
- * @param cross
41
+ *
42
+ * @param {Color} frustum - The frustum line color.
43
+ * @param {Color} cone - The cone line color.
44
+ * @param {Color} up - The up line color.
45
+ * @param {Color} target - The target line color.
46
+ * @param {Color} cross - The cross line color.
47
+ * @return {CameraHelper} A reference to this helper.
66
48
  */
67
- setColors(frustum: Color, cone: Color, up: Color, target: Color, cross: Color): this;
68
-
49
+ setColors(frustum: Color, cone: Color, up: Color, target: Color, cross: Color): CameraHelper;
69
50
  /**
70
- * Updates the helper based on the projectionMatrix of the camera.
51
+ * Updates the helper based on the projection matrix of the camera.
71
52
  */
72
53
  update(): void;
73
-
74
54
  /**
75
- * Frees the GPU-related resources allocated by this instance
76
- * @remarks
77
- * Call this method whenever this instance is no longer used in your app.
55
+ * Frees the GPU-related resources allocated by this instance. Call this
56
+ * method whenever this instance is no longer used in your app.
78
57
  */
79
58
  dispose(): void;
80
59
  }
@@ -5,77 +5,56 @@ import { Matrix4 } from "../math/Matrix4.js";
5
5
  import { Line } from "../objects/Line.js";
6
6
 
7
7
  /**
8
- * Helper object to assist with visualizing a {@link THREE.DirectionalLight | DirectionalLight}'s effect on the scene
9
- * @remarks
10
- * This consists of plane and a line representing the light's position and direction.
11
- * @example
12
- * ```typescript
13
- * const light = new THREE.DirectionalLight(0xFFFFFF);
14
- * scene.add(light);
8
+ * Helper object to assist with visualizing a {@link DirectionalLight}'s
9
+ * effect on the scene. This consists of a plane and a line representing the
10
+ * light's position and direction.
15
11
  *
16
- * const helper = new THREE.DirectionalLightHelper(light, 5);
17
- * scene.add(helper);
12
+ * When the directional light or its target are transformed or light properties
13
+ * are changed, it's necessary to call the `update()` method of the respective helper.
14
+ *
15
+ * ```js
16
+ * const light = new THREE.DirectionalLight( 0xFFFFFF );
17
+ * scene.add( light );
18
+ *
19
+ * const helper = new THREE.DirectionalLightHelper( light, 5 );
20
+ * scene.add( helper );
18
21
  * ```
19
- * @see {@link https://threejs.org/docs/index.html#api/en/helpers/DirectionalLightHelper | Official Documentation}
20
- * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/DirectionalLightHelper.js | Source}
21
22
  */
22
23
  export class DirectionalLightHelper extends Object3D {
23
24
  /**
24
- * Create a new instance of {@link DirectionalLightHelper}
25
- * @param light The light to be visualized.
26
- * @param size Dimensions of the plane. Default `1`
27
- * @param color If this is not the set the helper will take the color of the light. Default `light.color`
25
+ * Constructs a new directional light helper.
26
+ *
27
+ * @param {DirectionalLight} light - The light to be visualized.
28
+ * @param {number} [size=1] - The dimensions of the plane.
29
+ * @param {number|Color|string} [color] - The helper's color. If not set, the helper will take
30
+ * the color of the light.
28
31
  */
29
32
  constructor(light: DirectionalLight, size?: number, color?: ColorRepresentation);
30
-
31
33
  /**
32
- * A Read-only _string_ to check if `this` object type.
33
- * @remarks Sub-classes will update this value.
34
- * @override
35
- * @defaultValue `DirectionalLightHelper`
36
- */
37
- override readonly type: string | "DirectionalLightHelper";
38
-
39
- /**
40
- * Contains the line mesh showing the location of the directional light.
41
- */
42
- lightPlane: Line;
43
-
44
- /**
45
- * Reference to the {@link THREE.DirectionalLight | directionalLight} being visualized.
34
+ * The light being visualized.
46
35
  */
47
36
  light: DirectionalLight;
48
-
49
37
  /**
50
- * Reference to the {@link THREE.DirectionalLight.matrixWorld | light.matrixWorld}.
38
+ * The color parameter passed in the constructor.
39
+ * If not set, the helper will take the color of the light.
51
40
  */
52
- matrix: Matrix4;
53
-
41
+ color: ColorRepresentation | undefined;
54
42
  /**
55
- * Is set to `false`, as the helper is using the {@link THREE.DirectionalLight.matrixWorld | light.matrixWorld}.
56
- * @see {@link THREE.Object3D.matrixAutoUpdate | Object3D.matrixAutoUpdate}.
57
- * @defaultValue `false`.
43
+ * Contains the line showing the location of the directional light.
58
44
  */
59
- override matrixAutoUpdate: boolean;
60
-
45
+ lightPlane: Line;
61
46
  /**
62
- * The color parameter passed in the constructor.
63
- * @remarks If this is changed, the helper's color will update the next time {@link update} is called.
64
- * @defaultValue `undefined`
47
+ * Represents the target line of the directional light.
65
48
  */
66
- color: ColorRepresentation | undefined;
67
-
68
- targetLine: Line; // TODO: Double check if this need to be exposed or not.
69
-
49
+ targetLine: Line;
70
50
  /**
71
- * Updates the helper to match the position and direction of the {@link light | DirectionalLight} being visualized.
51
+ * Frees the GPU-related resources allocated by this instance. Call this
52
+ * method whenever this instance is no longer used in your app.
72
53
  */
73
- update(): void;
74
-
54
+ dispose(): void;
75
55
  /**
76
- * Frees the GPU-related resources allocated by this instance
77
- * @remarks
78
- * Call this method whenever this instance is no longer used in your app.
56
+ * Updates the helper to match the position and direction of the
57
+ * light being visualized.
79
58
  */
80
- dispose(): void;
59
+ update(): void;
81
60
  }
@@ -4,44 +4,30 @@ import { ColorRepresentation } from "../math/Color.js";
4
4
  import { LineSegments } from "../objects/LineSegments.js";
5
5
 
6
6
  /**
7
- * The {@link GridHelper} is an object to define grids
8
- * @remarks
9
- * Grids are two-dimensional arrays of lines.
10
- * @example
11
- * ```typescript
7
+ * The helper is an object to define grids. Grids are two-dimensional
8
+ * arrays of lines.
9
+ *
10
+ * ```js
12
11
  * const size = 10;
13
12
  * const divisions = 10;
14
- * const {@link GridHelper} = new THREE.GridHelper(size, divisions);
15
- * scene.add(gridHelper);
13
+ *
14
+ * const gridHelper = new THREE.GridHelper( size, divisions );
15
+ * scene.add( gridHelper );
16
16
  * ```
17
- * @see Example: {@link https://threejs.org/examples/#webgl_helpers | WebGL / helpers}
18
- * @see {@link https://threejs.org/docs/index.html#api/en/helpers/GridHelper | Official Documentation}
19
- * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/GridHelper.js | Source}
20
17
  */
21
18
  export class GridHelper extends LineSegments<BufferGeometry, LineBasicMaterial> {
22
19
  /**
23
- * Creates a new {@link GridHelper} of size 'size' and divided into 'divisions' segments per side
24
- * @remarks
25
- * Colors are optional.
26
- * @param size The size of the grid. Default `10`
27
- * @param divisions The number of divisions across the grid. Default `10`
28
- * @param colorCenterLine The color of the centerline. This can be a {@link THREE.Color | Color}, a hexadecimal value and an CSS-Color name. Default `0x444444`
29
- * @param colorGrid The color of the lines of the grid. This can be a {@link THREE.Color | Color}, a hexadecimal value and an CSS-Color name. Default `0x888888`
20
+ * Constructs a new grid helper.
21
+ *
22
+ * @param {number} [size=10] - The size of the grid.
23
+ * @param {number} [divisions=10] - The number of divisions across the grid.
24
+ * @param {number|Color|string} [color1=0x444444] - The color of the center line.
25
+ * @param {number|Color|string} [color2=0x888888] - The color of the lines of the grid.
30
26
  */
31
27
  constructor(size?: number, divisions?: number, color1?: ColorRepresentation, color2?: ColorRepresentation);
32
-
33
- /**
34
- * A Read-only _string_ to check if `this` object type.
35
- * @remarks Sub-classes will update this value.
36
- * @override
37
- * @defaultValue `GridHelper`
38
- */
39
- override readonly type: string | "GridHelper";
40
-
41
28
  /**
42
- * Frees the GPU-related resources allocated by this instance
43
- * @remarks
44
- * Call this method whenever this instance is no longer used in your app.
29
+ * Frees the GPU-related resources allocated by this instance. Call this
30
+ * method whenever this instance is no longer used in your app.
45
31
  */
46
32
  dispose(): void;
47
33
  }
@@ -2,71 +2,48 @@ import { Object3D } from "../core/Object3D.js";
2
2
  import { HemisphereLight } from "../lights/HemisphereLight.js";
3
3
  import { MeshBasicMaterial } from "../materials/MeshBasicMaterial.js";
4
4
  import { ColorRepresentation } from "../math/Color.js";
5
- import { Matrix4 } from "../math/Matrix4.js";
6
5
 
7
6
  /**
8
- * Creates a visual aid consisting of a spherical {@link THREE.Mesh | Mesh} for a {@link THREE.HemisphereLight | HemisphereLight}.
9
- * @example
10
- * ```typescript
11
- * const light = new THREE.HemisphereLight(0xffffbb, 0x080820, 1);
12
- * const helper = new THREE.HemisphereLightHelper(light, 5);
13
- * scene.add(helper);
7
+ * Creates a visual aid consisting of a spherical mesh for a
8
+ * given {@link HemisphereLight}.
9
+ *
10
+ * When the hemisphere light is transformed or its light properties are changed,
11
+ * it's necessary to call the `update()` method of the respective helper.
12
+ *
13
+ * ```js
14
+ * const light = new THREE.HemisphereLight( 0xffffbb, 0x080820, 1 );
15
+ * const helper = new THREE.HemisphereLightHelper( light, 5 );
16
+ * scene.add( helper );
14
17
  * ```
15
- * @see {@link https://threejs.org/docs/index.html#api/en/helpers/HemisphereLightHelper | Official Documentation}
16
- * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/HemisphereLightHelper.js | Source}
17
18
  */
18
19
  export class HemisphereLightHelper extends Object3D {
19
20
  /**
20
- * Create a new instance of {@link HemisphereLightHelper}
21
- * @param light The light being visualized.
22
- * @param size Thr sphere size
23
- * @param color If this is not the set the helper will take the color of the light.
21
+ * Constructs a new hemisphere light helper.
22
+ *
23
+ * @param {HemisphereLight} light - The light to be visualized.
24
+ * @param {number} [size=1] - The size of the mesh used to visualize the light.
25
+ * @param {number|Color|string} [color] - The helper's color. If not set, the helper will take
26
+ * the color of the light.
24
27
  */
25
- constructor(light: HemisphereLight, size: number, color?: ColorRepresentation);
26
-
28
+ constructor(light: HemisphereLight, size?: number, color?: ColorRepresentation);
27
29
  /**
28
- * A Read-only _string_ to check if `this` object type.
29
- * @remarks Sub-classes will update this value.
30
- * @override
31
- * @defaultValue `HemisphereLightHelper`
32
- */
33
- override readonly type: string | "HemisphereLightHelper";
34
-
35
- /**
36
- * Reference to the HemisphereLight being visualized.
30
+ * The light being visualized.
37
31
  */
38
32
  light: HemisphereLight;
39
-
40
- /**
41
- * Reference to the {@link THREE.HemisphereLight.matrixWorld | light.matrixWorld}.
42
- */
43
- matrix: Matrix4;
44
-
45
- /**
46
- * Is set to `false`, as the helper is using the {@link THREE.HemisphereLight.matrixWorld | light.matrixWorld}.
47
- * @see {@link THREE.Object3D.matrixAutoUpdate | Object3D.matrixAutoUpdate}.
48
- * @defaultValue `false`.
49
- */
50
- override matrixAutoUpdate: boolean;
51
-
52
- material: MeshBasicMaterial; // TODO: Double check if this need to be exposed or not.
53
-
54
33
  /**
55
34
  * The color parameter passed in the constructor.
56
- * @remarks If this is changed, the helper's color will update the next time {@link update} is called.
57
- * @defaultValue `undefined`
35
+ * If not set, the helper will take the color of the light.
58
36
  */
59
37
  color: ColorRepresentation | undefined;
60
-
38
+ material: MeshBasicMaterial;
61
39
  /**
62
- * Updates the helper to match the position and direction of the {@link .light | HemisphereLight}.
40
+ * Frees the GPU-related resources allocated by this instance. Call this
41
+ * method whenever this instance is no longer used in your app.
63
42
  */
64
- update(): void;
65
-
43
+ dispose(): void;
66
44
  /**
67
- * Frees the GPU-related resources allocated by this instance
68
- * @remarks
69
- * Call this method whenever this instance is no longer used in your app.
45
+ * Updates the helper to match the position and direction of the
46
+ * light being visualized.
70
47
  */
71
- dispose(): void;
48
+ update(): void;
72
49
  }
@@ -1,50 +1,38 @@
1
+ import { ColorRepresentation } from "../math/Color.js";
1
2
  import { Plane } from "../math/Plane.js";
2
- import { LineSegments } from "../objects/LineSegments.js";
3
+ import { Line } from "../objects/Line.js";
3
4
 
4
5
  /**
5
- * Helper object to visualize a {@link THREE.Plane | Plane}.
6
- * @example
7
- * ```typescript
8
- * const plane = new THREE.Plane(new THREE.Vector3(1, 1, 0.2), 3);
9
- * const helper = new THREE.PlaneHelper(plane, 1, 0xffff00);
10
- * scene.add(helper);
6
+ * A helper object to visualize an instance of {@link Plane}.
7
+ *
8
+ * ```js
9
+ * const plane = new THREE.Plane( new THREE.Vector3( 1, 1, 0.2 ), 3 );
10
+ * const helper = new THREE.PlaneHelper( plane, 1, 0xffff00 );
11
+ * scene.add( helper );
11
12
  * ```
12
- * @see {@link https://threejs.org/docs/index.html#api/en/helpers/PlaneHelper | Official Documentation}
13
- * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/PlaneHelper.js | Source}
14
13
  */
15
- export class PlaneHelper extends LineSegments {
14
+ export class PlaneHelper extends Line {
16
15
  /**
17
- * Creates a new wireframe representation of the passed plane.
18
- * @param plane The plane to visualize.
19
- * @param size Side length of plane helper. Expects a `Float`. Default `1`
20
- * @param hex Color. Default `0xffff00`
16
+ * Constructs a new plane helper.
17
+ *
18
+ * @param {Plane} plane - The plane to be visualized.
19
+ * @param {number} [size=1] - The side length of plane helper.
20
+ * @param {number|Color|string} [hex=0xffff00] - The helper's color.
21
21
  */
22
- constructor(plane: Plane, size?: number, hex?: number);
23
-
24
- /**
25
- * A Read-only _string_ to check if `this` object type.
26
- * @remarks Sub-classes will update this value.
27
- * @override
28
- * @defaultValue `PlaneHelper`
29
- */
30
- override readonly type: string | "PlaneHelper";
31
-
22
+ constructor(plane: Plane, size?: number, hex?: ColorRepresentation);
32
23
  /**
33
- * The {@link Plane | plane} being visualized.
24
+ * The plane being visualized.
34
25
  */
35
26
  plane: Plane;
36
-
37
27
  /**
38
- * The side lengths of plane helper.
39
- * @remarks Expects a `Float`
40
- * @defaultValue `1`
28
+ * The side length of plane helper.
29
+ *
30
+ * @default 1
41
31
  */
42
32
  size: number;
43
-
44
33
  /**
45
- * Frees the GPU-related resources allocated by this instance
46
- * @remarks
47
- * Call this method whenever this instance is no longer used in your app.
34
+ * Updates the helper to match the position and direction of the
35
+ * light being visualized.
48
36
  */
49
37
  dispose(): void;
50
38
  }
@@ -1,73 +1,48 @@
1
- import { Object3D } from "../core/Object3D.js";
2
1
  import { PointLight } from "../lights/PointLight.js";
3
2
  import { ColorRepresentation } from "../math/Color.js";
4
- import { Matrix4 } from "../math/Matrix4.js";
3
+ import { Mesh } from "../objects/Mesh.js";
5
4
 
6
5
  /**
7
- * This displays a helper object consisting of a spherical {@link THREE.Mesh | Mesh} for visualizing a {@link THREE.PointLight | PointLight}.
8
- * @example
9
- * ```typescript
10
- * const pointLight = new THREE.PointLight(0xff0000, 1, 100);
11
- * pointLight.position.set(10, 10, 10);
12
- * scene.add(pointLight);
6
+ * This displays a helper object consisting of a spherical mesh for
7
+ * visualizing an instance of {@link PointLight}.
8
+ *
9
+ * ```js
10
+ * const pointLight = new THREE.PointLight( 0xff0000, 1, 100 );
11
+ * pointLight.position.set( 10, 10, 10 );
12
+ * scene.add( pointLight );
13
+ *
13
14
  * const sphereSize = 1;
14
- * const {@link PointLightHelper} = new THREE.PointLightHelper(pointLight, sphereSize);
15
- * scene.add(pointLightHelper);
15
+ * const pointLightHelper = new THREE.PointLightHelper( pointLight, sphereSize );
16
+ * scene.add( pointLightHelper );
16
17
  * ```
17
- * @see Example: {@link https://threejs.org/examples/#webgl_helpers | WebGL / helpers}
18
- * @see {@link https://threejs.org/docs/index.html#api/en/helpers/PointLightHelper | Official Documentation}
19
- * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/PointLightHelper.js | Source}
20
18
  */
21
- export class PointLightHelper extends Object3D {
19
+ export class PointLightHelper extends Mesh {
22
20
  /**
23
- * Create a new instance of {@link PointLightHelper}
24
- * @param light The light to be visualized.
25
- * @param sphereSize The size of the sphere helper. Expects a `Float`. Default `1`
26
- * @param color If this is not the set the helper will take the color of the light.
21
+ * Constructs a new point light helper.
22
+ *
23
+ * @param {PointLight} light - The light to be visualized.
24
+ * @param {number} [sphereSize=1] - The size of the sphere helper.
25
+ * @param {number|Color|string} [color] - The helper's color. If not set, the helper will take
26
+ * the color of the light.
27
27
  */
28
28
  constructor(light: PointLight, sphereSize?: number, color?: ColorRepresentation);
29
-
30
- /**
31
- * A Read-only _string_ to check if `this` object type.
32
- * @remarks Sub-classes will update this value.
33
- * @override
34
- * @defaultValue `PointLightHelper`
35
- */
36
- override readonly type: string | "PointLightHelper";
37
-
38
29
  /**
39
- * The {@link THREE.PointLight | PointLight} that is being visualized.
30
+ * The light being visualized.
40
31
  */
41
32
  light: PointLight;
42
-
43
- /**
44
- * Reference to the {@link THREE.PointLight.matrixWorld | light.matrixWorld}.
45
- */
46
- matrix: Matrix4;
47
-
48
33
  /**
49
34
  * The color parameter passed in the constructor.
50
- * @remarks If this is changed, the helper's color will update the next time {@link update} is called.
51
- * @defaultValue `undefined`
35
+ * If not set, the helper will take the color of the light.
52
36
  */
53
37
  color: ColorRepresentation | undefined;
54
-
55
38
  /**
56
- * Is set to `false`, as the helper is using the {@link THREE.PointLight.matrixWorld | light.matrixWorld}.
57
- * @see {@link THREE.Object3D.matrixAutoUpdate | Object3D.matrixAutoUpdate}.
58
- * @defaultValue `false`.
39
+ * Frees the GPU-related resources allocated by this instance. Call this
40
+ * method whenever this instance is no longer used in your app.
59
41
  */
60
- override matrixAutoUpdate: boolean;
61
-
42
+ dispose(): void;
62
43
  /**
63
- * Updates the helper to match the position of the {@link THREE..light | .light}.
44
+ * Updates the helper to match the position of the
45
+ * light being visualized.
64
46
  */
65
47
  update(): void;
66
-
67
- /**
68
- * Frees the GPU-related resources allocated by this instance
69
- * @remarks
70
- * Call this method whenever this instance is no longer used in your app.
71
- */
72
- dispose(): void;
73
48
  }
@@ -2,54 +2,41 @@ import { ColorRepresentation } from "../math/Color.js";
2
2
  import { LineSegments } from "../objects/LineSegments.js";
3
3
 
4
4
  /**
5
- * The {@link PolarGridHelper} is an object to define polar grids
6
- * @remarks
7
- * Grids are two-dimensional arrays of lines.
8
- * @example
9
- * ```typescript
5
+ * This helper is an object to define polar grids. Grids are
6
+ * two-dimensional arrays of lines.
7
+ *
8
+ * ```js
10
9
  * const radius = 10;
11
10
  * const sectors = 16;
12
11
  * const rings = 8;
13
12
  * const divisions = 64;
14
- * const helper = new THREE.PolarGridHelper(radius, sectors, rings, divisions);
15
- * scene.add(helper);
13
+ *
14
+ * const helper = new THREE.PolarGridHelper( radius, sectors, rings, divisions );
15
+ * scene.add( helper );
16
16
  * ```
17
- * @see Example: {@link https://threejs.org/examples/#webgl_helpers | WebGL / helpers}
18
- * @see {@link https://threejs.org/docs/index.html#api/en/helpers/PolarGridHelper | Official Documentation}
19
- * @see {@link https://github.com/mrdoob/three.js/blob/master/src/helpers/PolarGridHelper.js | Source}
20
17
  */
21
18
  export class PolarGridHelper extends LineSegments {
22
19
  /**
23
- * Creates a new {@link PolarGridHelper} of radius 'radius' with 'sectors' number of sectors and 'rings' number of rings, where each circle is smoothed into 'divisions' number of line segments.
24
- * @remarks Colors are optional.
25
- * @param radius The radius of the polar grid. This can be any positive number. Default `10`.
26
- * @param sectors The number of sectors the grid will be divided into. This can be any positive integer. Default `16`.
27
- * @param rings The number of rings. This can be any positive integer. Default `8`.
28
- * @param divisions The number of line segments used for each circle. This can be any positive integer that is 3 or greater. Default `64`.
29
- * @param color1 The first color used for grid elements. This can be a {@link THREE.Color | Color}, a hexadecimal value and an CSS-Color name. Default `0x444444`.
30
- * @param color2 The second color used for grid elements. This can be a {@link THREE.Color | Color}, a hexadecimal value and an CSS-Color name. Default `0x888888`.
20
+ * Constructs a new polar grid helper.
21
+ *
22
+ * @param {number} [radius=10] - The radius of the polar grid. This can be any positive number.
23
+ * @param {number} [sectors=16] - The number of sectors the grid will be divided into. This can be any positive integer.
24
+ * @param {number} [rings=16] - The number of rings. This can be any positive integer.
25
+ * @param {number} [divisions=64] - The number of line segments used for each circle. This can be any positive integer.
26
+ * @param {number|Color|string} [color1=0x444444] - The first color used for grid elements.
27
+ * @param {number|Color|string} [color2=0x888888] - The second color used for grid elements.
31
28
  */
32
29
  constructor(
33
30
  radius?: number,
34
- radials?: number,
35
- circles?: number,
31
+ sectors?: number,
32
+ rings?: number,
36
33
  divisions?: number,
37
34
  color1?: ColorRepresentation,
38
35
  color2?: ColorRepresentation,
39
36
  );
40
-
41
- /**
42
- * A Read-only _string_ to check if `this` object type.
43
- * @remarks Sub-classes will update this value.
44
- * @override
45
- * @defaultValue `PolarGridHelper`
46
- */
47
- override readonly type: string | "PolarGridHelper";
48
-
49
37
  /**
50
- * Frees the GPU-related resources allocated by this instance
51
- * @remarks
52
- * Call this method whenever this instance is no longer used in your app.
38
+ * Frees the GPU-related resources allocated by this instance. Call this
39
+ * method whenever this instance is no longer used in your app.
53
40
  */
54
41
  dispose(): void;
55
42
  }