x_ite 8.8.6 → 8.9.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 (384) hide show
  1. package/Makefile +6 -0
  2. package/build/docs/nodes.pl +434 -0
  3. package/dist/assets/components/Annotation.js +14 -14
  4. package/dist/assets/components/Annotation.min.js +1 -1
  5. package/dist/assets/components/CADGeometry.js +13 -13
  6. package/dist/assets/components/CADGeometry.min.js +1 -1
  7. package/dist/assets/components/CubeMapTexturing.js +28 -28
  8. package/dist/assets/components/CubeMapTexturing.min.js +1 -1
  9. package/dist/assets/components/DIS.js +14 -14
  10. package/dist/assets/components/DIS.min.js +1 -1
  11. package/dist/assets/components/EventUtilities.js +9 -9
  12. package/dist/assets/components/EventUtilities.min.js +1 -1
  13. package/dist/assets/components/Geometry2D.js +19 -19
  14. package/dist/assets/components/Geometry2D.min.js +1 -1
  15. package/dist/assets/components/Geospatial.js +52 -40
  16. package/dist/assets/components/Geospatial.min.js +1 -1
  17. package/dist/assets/components/HAnim.js +19 -19
  18. package/dist/assets/components/HAnim.min.js +1 -1
  19. package/dist/assets/components/KeyDeviceSensor.js +8 -8
  20. package/dist/assets/components/KeyDeviceSensor.min.js +1 -1
  21. package/dist/assets/components/Layout.js +27 -27
  22. package/dist/assets/components/Layout.min.js +1 -1
  23. package/dist/assets/components/NURBS.js +26 -26
  24. package/dist/assets/components/NURBS.min.js +1 -1
  25. package/dist/assets/components/ParticleSystems.js +76 -74
  26. package/dist/assets/components/ParticleSystems.min.js +1 -1
  27. package/dist/assets/components/Picking.js +18 -18
  28. package/dist/assets/components/Picking.min.js +1 -1
  29. package/dist/assets/components/RigidBodyPhysics.js +29 -30
  30. package/dist/assets/components/RigidBodyPhysics.min.js +1 -1
  31. package/dist/assets/components/Scripting.js +37 -37
  32. package/dist/assets/components/Scripting.min.js +1 -1
  33. package/dist/assets/components/Text.js +24 -24
  34. package/dist/assets/components/Text.min.js +1 -1
  35. package/dist/assets/components/TextureProjector.js +23 -23
  36. package/dist/assets/components/TextureProjector.min.js +1 -1
  37. package/dist/assets/components/Texturing3D.js +30 -30
  38. package/dist/assets/components/Texturing3D.min.js +1 -1
  39. package/dist/assets/components/VolumeRendering.js +21 -21
  40. package/dist/assets/components/VolumeRendering.min.js +1 -1
  41. package/dist/assets/components/X_ITE.js +9 -9
  42. package/dist/assets/components/X_ITE.min.js +1 -1
  43. package/dist/x_ite.css +1 -1
  44. package/dist/x_ite.js +1002 -133
  45. package/dist/x_ite.min.js +1 -1
  46. package/dist/x_ite.zip +0 -0
  47. package/docs/_config.yml +2 -2
  48. package/docs/_posts/components/CADGeometry/CADAssembly.md +47 -21
  49. package/docs/_posts/components/CADGeometry/CADFace.md +47 -21
  50. package/docs/_posts/components/CADGeometry/CADLayer.md +50 -21
  51. package/docs/_posts/components/CADGeometry/CADPart.md +56 -26
  52. package/docs/_posts/components/CADGeometry/IndexedQuadSet.md +55 -26
  53. package/docs/_posts/components/CADGeometry/QuadSet.md +52 -20
  54. package/docs/_posts/components/Core/MetadataBoolean.md +27 -36
  55. package/docs/_posts/components/Core/MetadataDouble.md +31 -16
  56. package/docs/_posts/components/Core/MetadataFloat.md +31 -16
  57. package/docs/_posts/components/Core/MetadataInteger.md +31 -16
  58. package/docs/_posts/components/Core/MetadataSet.md +30 -15
  59. package/docs/_posts/components/Core/MetadataString.md +31 -16
  60. package/docs/_posts/components/Core/WorldInfo.md +21 -10
  61. package/docs/_posts/components/CubeMapTexturing/ComposedCubeMapTexture.md +39 -30
  62. package/docs/_posts/components/CubeMapTexturing/GeneratedCubeMapTexture.md +19 -10
  63. package/docs/_posts/components/CubeMapTexturing/ImageCubeMapTexture.md +22 -18
  64. package/docs/_posts/components/DIS/DISEntityManager.md +43 -18
  65. package/docs/_posts/components/DIS/DISEntityTypeMapping.md +43 -34
  66. package/docs/_posts/components/DIS/EspduTransform.md +211 -78
  67. package/docs/_posts/components/DIS/ReceiverPdu.md +95 -45
  68. package/docs/_posts/components/DIS/SignalPdu.md +98 -44
  69. package/docs/_posts/components/DIS/TransmitterPdu.md +118 -68
  70. package/docs/_posts/components/EnvironmentalEffects/Background.md +80 -39
  71. package/docs/_posts/components/EnvironmentalEffects/Fog.md +39 -18
  72. package/docs/_posts/components/EnvironmentalEffects/FogCoordinate.md +10 -6
  73. package/docs/_posts/components/EnvironmentalEffects/LocalFog.md +21 -14
  74. package/docs/_posts/components/EnvironmentalEffects/TextureBackground.md +83 -31
  75. package/docs/_posts/components/EnvironmentalSensor/ProximitySensor.md +36 -8
  76. package/docs/_posts/components/EnvironmentalSensor/TransformSensor.md +31 -7
  77. package/docs/_posts/components/EnvironmentalSensor/VisibilitySensor.md +23 -7
  78. package/docs/_posts/components/EventUtilities/BooleanFilter.md +27 -14
  79. package/docs/_posts/components/EventUtilities/BooleanSequencer.md +46 -17
  80. package/docs/_posts/components/EventUtilities/BooleanToggle.md +29 -8
  81. package/docs/_posts/components/EventUtilities/BooleanTrigger.md +24 -7
  82. package/docs/_posts/components/EventUtilities/IntegerSequencer.md +46 -17
  83. package/docs/_posts/components/EventUtilities/IntegerTrigger.md +34 -9
  84. package/docs/_posts/components/EventUtilities/TimeTrigger.md +30 -9
  85. package/docs/_posts/components/Followers/ColorChaser.md +35 -11
  86. package/docs/_posts/components/Followers/ColorDamper.md +32 -12
  87. package/docs/_posts/components/Followers/CoordinateChaser.md +33 -9
  88. package/docs/_posts/components/Followers/CoordinateDamper.md +30 -10
  89. package/docs/_posts/components/Followers/OrientationChaser.md +34 -10
  90. package/docs/_posts/components/Followers/OrientationDamper.md +31 -11
  91. package/docs/_posts/components/Followers/PositionChaser.md +33 -9
  92. package/docs/_posts/components/Followers/PositionChaser2D.md +33 -9
  93. package/docs/_posts/components/Followers/PositionDamper.md +30 -10
  94. package/docs/_posts/components/Followers/PositionDamper2D.md +30 -10
  95. package/docs/_posts/components/Followers/ScalarChaser.md +33 -9
  96. package/docs/_posts/components/Followers/ScalarDamper.md +30 -10
  97. package/docs/_posts/components/Followers/TexCoordChaser2D.md +33 -9
  98. package/docs/_posts/components/Followers/TexCoordDamper2D.md +30 -10
  99. package/docs/_posts/components/Geometry2D/Arc2D.md +39 -14
  100. package/docs/_posts/components/Geometry2D/ArcClose2D.md +43 -19
  101. package/docs/_posts/components/Geometry2D/Circle2D.md +21 -10
  102. package/docs/_posts/components/Geometry2D/Disk2D.md +32 -14
  103. package/docs/_posts/components/Geometry2D/Polyline2D.md +25 -10
  104. package/docs/_posts/components/Geometry2D/Polypoint2D.md +16 -8
  105. package/docs/_posts/components/Geometry2D/Rectangle2D.md +23 -12
  106. package/docs/_posts/components/Geometry2D/TriangleSet2D.md +23 -12
  107. package/docs/_posts/components/Geometry3D/Box.md +26 -13
  108. package/docs/_posts/components/Geometry3D/Cone.md +31 -23
  109. package/docs/_posts/components/Geometry3D/Cylinder.md +32 -28
  110. package/docs/_posts/components/Geometry3D/ElevationGrid.md +75 -31
  111. package/docs/_posts/components/Geometry3D/Extrusion.md +100 -48
  112. package/docs/_posts/components/Geometry3D/IndexedFaceSet.md +95 -43
  113. package/docs/_posts/components/Geometry3D/Sphere.md +25 -13
  114. package/docs/_posts/components/Geospatial/GeoCoordinate.md +30 -14
  115. package/docs/_posts/components/Geospatial/GeoElevationGrid.md +85 -40
  116. package/docs/_posts/components/Geospatial/GeoLOD.md +69 -30
  117. package/docs/_posts/components/Geospatial/GeoLocation.md +66 -28
  118. package/docs/_posts/components/Geospatial/GeoMetadata.md +28 -22
  119. package/docs/_posts/components/Geospatial/GeoOrigin.md +34 -19
  120. package/docs/_posts/components/Geospatial/GeoPositionInterpolator.md +64 -18
  121. package/docs/_posts/components/Geospatial/GeoProximitySensor.md +67 -18
  122. package/docs/_posts/components/Geospatial/GeoTouchSensor.md +66 -21
  123. package/docs/_posts/components/Geospatial/GeoTransform.md +74 -30
  124. package/docs/_posts/components/Geospatial/GeoViewpoint.md +88 -41
  125. package/docs/_posts/components/Grouping/Group.md +34 -18
  126. package/docs/_posts/components/Grouping/StaticGroup.md +39 -18
  127. package/docs/_posts/components/Grouping/Switch.md +41 -22
  128. package/docs/_posts/components/Grouping/Transform.md +47 -30
  129. package/docs/_posts/components/HAnim/HAnimDisplacer.md +48 -37
  130. package/docs/_posts/components/HAnim/HAnimHumanoid.md +245 -55
  131. package/docs/_posts/components/HAnim/HAnimJoint.md +136 -70
  132. package/docs/_posts/components/HAnim/HAnimMotion.md +128 -18
  133. package/docs/_posts/components/HAnim/HAnimSegment.md +92 -52
  134. package/docs/_posts/components/HAnim/HAnimSite.md +95 -52
  135. package/docs/_posts/components/Interpolation/ColorInterpolator.md +41 -11
  136. package/docs/_posts/components/Interpolation/CoordinateInterpolator.md +39 -13
  137. package/docs/_posts/components/Interpolation/CoordinateInterpolator2D.md +43 -14
  138. package/docs/_posts/components/Interpolation/EaseInEaseOut.md +36 -12
  139. package/docs/_posts/components/Interpolation/NormalInterpolator.md +40 -10
  140. package/docs/_posts/components/Interpolation/OrientationInterpolator.md +40 -10
  141. package/docs/_posts/components/Interpolation/PositionInterpolator.md +40 -10
  142. package/docs/_posts/components/Interpolation/PositionInterpolator2D.md +43 -14
  143. package/docs/_posts/components/Interpolation/ScalarInterpolator.md +39 -13
  144. package/docs/_posts/components/Interpolation/SplinePositionInterpolator.md +41 -16
  145. package/docs/_posts/components/Interpolation/SplinePositionInterpolator2D.md +41 -16
  146. package/docs/_posts/components/Interpolation/SplineScalarInterpolator.md +40 -24
  147. package/docs/_posts/components/Interpolation/SquadOrientationInterpolator.md +35 -11
  148. package/docs/_posts/components/KeyDeviceSensor/KeySensor.md +51 -9
  149. package/docs/_posts/components/KeyDeviceSensor/StringSensor.md +31 -9
  150. package/docs/_posts/components/Layering/Layer.md +39 -14
  151. package/docs/_posts/components/Layering/LayerSet.md +21 -15
  152. package/docs/_posts/components/Layering/Viewport.md +34 -18
  153. package/docs/_posts/components/Layout/Layout.md +28 -17
  154. package/docs/_posts/components/Layout/LayoutGroup.md +37 -21
  155. package/docs/_posts/components/Layout/LayoutLayer.md +40 -15
  156. package/docs/_posts/components/Layout/ScreenFontStyle.md +74 -47
  157. package/docs/_posts/components/Layout/ScreenGroup.md +35 -19
  158. package/docs/_posts/components/Lighting/DirectionalLight.md +23 -15
  159. package/docs/_posts/components/Lighting/EnvironmentLight.md +7 -11
  160. package/docs/_posts/components/Lighting/PointLight.md +27 -15
  161. package/docs/_posts/components/Lighting/SpotLight.md +36 -23
  162. package/docs/_posts/components/NURBS/Contour2D.md +17 -9
  163. package/docs/_posts/components/NURBS/ContourPolyline2D.md +10 -6
  164. package/docs/_posts/components/NURBS/CoordinateDouble.md +13 -9
  165. package/docs/_posts/components/NURBS/NurbsCurve.md +16 -12
  166. package/docs/_posts/components/NURBS/NurbsCurve2D.md +15 -11
  167. package/docs/_posts/components/NURBS/NurbsOrientationInterpolator.md +31 -15
  168. package/docs/_posts/components/NURBS/NurbsPatchSurface.md +29 -23
  169. package/docs/_posts/components/NURBS/NurbsPositionInterpolator.md +30 -14
  170. package/docs/_posts/components/NURBS/NurbsSet.md +51 -17
  171. package/docs/_posts/components/NURBS/NurbsSurfaceInterpolator.md +48 -28
  172. package/docs/_posts/components/NURBS/NurbsSweptSurface.md +31 -14
  173. package/docs/_posts/components/NURBS/NurbsSwungSurface.md +25 -14
  174. package/docs/_posts/components/NURBS/NurbsTextureCoordinate.md +26 -22
  175. package/docs/_posts/components/NURBS/NurbsTrimmedSurface.md +36 -26
  176. package/docs/_posts/components/Navigation/Billboard.md +35 -19
  177. package/docs/_posts/components/Navigation/Collision.md +61 -24
  178. package/docs/_posts/components/Navigation/LOD.md +55 -25
  179. package/docs/_posts/components/Navigation/NavigationInfo.md +69 -26
  180. package/docs/_posts/components/Navigation/OrthoViewpoint.md +89 -38
  181. package/docs/_posts/components/Navigation/Viewpoint.md +95 -40
  182. package/docs/_posts/components/Navigation/ViewpointGroup.md +29 -18
  183. package/docs/_posts/components/Networking/Anchor.md +56 -58
  184. package/docs/_posts/components/Networking/Inline.md +44 -31
  185. package/docs/_posts/components/Networking/LoadSensor.md +43 -11
  186. package/docs/_posts/components/ParticleSystems/BoundedPhysicsModel.md +16 -8
  187. package/docs/_posts/components/ParticleSystems/ConeEmitter.md +31 -12
  188. package/docs/_posts/components/ParticleSystems/ExplosionEmitter.md +23 -12
  189. package/docs/_posts/components/ParticleSystems/ForcePhysicsModel.md +15 -8
  190. package/docs/_posts/components/ParticleSystems/ParticleSystem.md +110 -55
  191. package/docs/_posts/components/ParticleSystems/PointEmitter.md +25 -14
  192. package/docs/_posts/components/ParticleSystems/PolylineEmitter.md +28 -16
  193. package/docs/_posts/components/ParticleSystems/SurfaceEmitter.md +25 -14
  194. package/docs/_posts/components/ParticleSystems/VolumeEmitter.md +35 -16
  195. package/docs/_posts/components/ParticleSystems/WindPhysicsModel.md +12 -8
  196. package/docs/_posts/components/Picking/LinePickSensor.md +57 -31
  197. package/docs/_posts/components/Picking/PickableGroup.md +44 -26
  198. package/docs/_posts/components/Picking/PointPickSensor.md +47 -26
  199. package/docs/_posts/components/Picking/PrimitivePickSensor.md +43 -31
  200. package/docs/_posts/components/Picking/VolumePickSensor.md +43 -26
  201. package/docs/_posts/components/PointingDeviceSensor/CylinderSensor.md +46 -21
  202. package/docs/_posts/components/PointingDeviceSensor/PlaneSensor.md +43 -20
  203. package/docs/_posts/components/PointingDeviceSensor/SphereSensor.md +37 -15
  204. package/docs/_posts/components/PointingDeviceSensor/TouchSensor.md +50 -16
  205. package/docs/_posts/components/Rendering/ClipPlane.md +21 -16
  206. package/docs/_posts/components/Rendering/Color.md +14 -14
  207. package/docs/_posts/components/Rendering/ColorRGBA.md +13 -9
  208. package/docs/_posts/components/Rendering/Coordinate.md +11 -7
  209. package/docs/_posts/components/Rendering/IndexedLineSet.md +55 -27
  210. package/docs/_posts/components/Rendering/IndexedTriangleFanSet.md +44 -23
  211. package/docs/_posts/components/Rendering/IndexedTriangleSet.md +45 -24
  212. package/docs/_posts/components/Rendering/IndexedTriangleStripSet.md +45 -20
  213. package/docs/_posts/components/Rendering/LineSet.md +26 -14
  214. package/docs/_posts/components/Rendering/Normal.md +28 -6
  215. package/docs/_posts/components/Rendering/PointSet.md +24 -11
  216. package/docs/_posts/components/Rendering/TriangleFanSet.md +44 -19
  217. package/docs/_posts/components/Rendering/TriangleSet.md +44 -19
  218. package/docs/_posts/components/Rendering/TriangleStripSet.md +45 -20
  219. package/docs/_posts/components/RigidBodyPhysics/BallJoint.md +24 -12
  220. package/docs/_posts/components/RigidBodyPhysics/CollidableOffset.md +40 -17
  221. package/docs/_posts/components/RigidBodyPhysics/CollidableShape.md +37 -19
  222. package/docs/_posts/components/RigidBodyPhysics/CollisionCollection.md +24 -19
  223. package/docs/_posts/components/RigidBodyPhysics/CollisionSensor.md +21 -12
  224. package/docs/_posts/components/RigidBodyPhysics/CollisionSpace.md +36 -17
  225. package/docs/_posts/components/RigidBodyPhysics/Contact.md +20 -16
  226. package/docs/_posts/components/RigidBodyPhysics/DoubleAxisHingeJoint.md +43 -41
  227. package/docs/_posts/components/RigidBodyPhysics/MotorJoint.md +86 -34
  228. package/docs/_posts/components/RigidBodyPhysics/RigidBody.md +36 -26
  229. package/docs/_posts/components/RigidBodyPhysics/RigidBodyCollection.md +36 -20
  230. package/docs/_posts/components/RigidBodyPhysics/SingleAxisHingeJoint.md +33 -23
  231. package/docs/_posts/components/RigidBodyPhysics/SliderJoint.md +31 -19
  232. package/docs/_posts/components/RigidBodyPhysics/UniversalJoint.md +31 -23
  233. package/docs/_posts/components/Scripting/Script.md +43 -27
  234. package/docs/_posts/components/Shaders/ComposedShader.md +30 -17
  235. package/docs/_posts/components/Shaders/FloatVertexAttribute.md +18 -9
  236. package/docs/_posts/components/Shaders/Matrix3VertexAttribute.md +17 -8
  237. package/docs/_posts/components/Shaders/Matrix4VertexAttribute.md +17 -8
  238. package/docs/_posts/components/Shaders/PackagedShader.md +52 -46
  239. package/docs/_posts/components/Shaders/ProgramShader.md +35 -15
  240. package/docs/_posts/components/Shaders/ShaderPart.md +27 -18
  241. package/docs/_posts/components/Shaders/ShaderProgram.md +28 -17
  242. package/docs/_posts/components/Shape/AcousticProperties.md +38 -10
  243. package/docs/_posts/components/Shape/Appearance.md +30 -23
  244. package/docs/_posts/components/Shape/FillProperties.md +19 -12
  245. package/docs/_posts/components/Shape/LineProperties.md +18 -10
  246. package/docs/_posts/components/Shape/Material.md +64 -38
  247. package/docs/_posts/components/Shape/PhysicalMaterial.md +49 -25
  248. package/docs/_posts/components/Shape/PointProperties.md +23 -24
  249. package/docs/_posts/components/Shape/Shape.md +38 -20
  250. package/docs/_posts/components/Shape/TwoSidedMaterial.md +35 -36
  251. package/docs/_posts/components/Shape/UnlitMaterial.md +29 -17
  252. package/docs/_posts/components/Sound/Analyser.md +151 -18
  253. package/docs/_posts/components/Sound/AudioClip.md +82 -32
  254. package/docs/_posts/components/Sound/AudioDestination.md +85 -9
  255. package/docs/_posts/components/Sound/BiquadFilter.md +160 -17
  256. package/docs/_posts/components/Sound/BufferAudioSource.md +184 -28
  257. package/docs/_posts/components/Sound/ChannelMerger.md +70 -8
  258. package/docs/_posts/components/Sound/ChannelSelector.md +73 -9
  259. package/docs/_posts/components/Sound/ChannelSplitter.md +77 -9
  260. package/docs/_posts/components/Sound/Convolver.md +138 -14
  261. package/docs/_posts/components/Sound/Delay.md +134 -15
  262. package/docs/_posts/components/Sound/DynamicsCompressor.md +146 -19
  263. package/docs/_posts/components/Sound/Gain.md +128 -13
  264. package/docs/_posts/components/Sound/ListenerPointSource.md +121 -12
  265. package/docs/_posts/components/Sound/MicrophoneSource.md +101 -10
  266. package/docs/_posts/components/Sound/OscillatorSource.md +107 -12
  267. package/docs/_posts/components/Sound/PeriodicWave.md +48 -7
  268. package/docs/_posts/components/Sound/Sound.md +61 -22
  269. package/docs/_posts/components/Sound/SpatialSound.md +136 -17
  270. package/docs/_posts/components/Sound/StreamAudioDestination.md +89 -9
  271. package/docs/_posts/components/Sound/StreamAudioSource.md +101 -10
  272. package/docs/_posts/components/Sound/WaveShaper.md +138 -15
  273. package/docs/_posts/components/Text/FontStyle.md +75 -49
  274. package/docs/_posts/components/Text/Text.md +48 -26
  275. package/docs/_posts/components/TextureProjector/TextureProjector.md +63 -12
  276. package/docs/_posts/components/TextureProjector/TextureProjectorParallel.md +64 -12
  277. package/docs/_posts/components/Texturing/ImageTexture.md +28 -20
  278. package/docs/_posts/components/Texturing/MovieTexture.md +87 -40
  279. package/docs/_posts/components/Texturing/MultiTexture.md +47 -19
  280. package/docs/_posts/components/Texturing/MultiTextureCoordinate.md +27 -10
  281. package/docs/_posts/components/Texturing/MultiTextureTransform.md +32 -10
  282. package/docs/_posts/components/Texturing/PixelTexture.md +34 -14
  283. package/docs/_posts/components/Texturing/TextureCoordinate.md +20 -10
  284. package/docs/_posts/components/Texturing/TextureCoordinateGenerator.md +22 -12
  285. package/docs/_posts/components/Texturing/TextureProperties.md +45 -20
  286. package/docs/_posts/components/Texturing/TextureTransform.md +17 -8
  287. package/docs/_posts/components/Texturing3D/ComposedTexture3D.md +21 -13
  288. package/docs/_posts/components/Texturing3D/ImageTexture3D.md +32 -23
  289. package/docs/_posts/components/Texturing3D/ImageTextureAtlas.md +22 -16
  290. package/docs/_posts/components/Texturing3D/PixelTexture3D.md +28 -16
  291. package/docs/_posts/components/Texturing3D/TextureCoordinate3D.md +22 -10
  292. package/docs/_posts/components/Texturing3D/TextureCoordinate4D.md +21 -9
  293. package/docs/_posts/components/Texturing3D/TextureTransform3D.md +17 -8
  294. package/docs/_posts/components/Texturing3D/TextureTransformMatrix3D.md +20 -10
  295. package/docs/_posts/components/Time/TimeSensor.md +70 -27
  296. package/docs/_posts/components/VolumeRendering/BlendedVolumeStyle.md +41 -20
  297. package/docs/_posts/components/VolumeRendering/BoundaryEnhancementVolumeStyle.md +20 -10
  298. package/docs/_posts/components/VolumeRendering/CartoonVolumeStyle.md +24 -21
  299. package/docs/_posts/components/VolumeRendering/ComposedVolumeStyle.md +18 -10
  300. package/docs/_posts/components/VolumeRendering/EdgeEnhancementVolumeStyle.md +22 -14
  301. package/docs/_posts/components/VolumeRendering/IsoSurfaceVolumeData.md +59 -37
  302. package/docs/_posts/components/VolumeRendering/OpacityMapVolumeStyle.md +16 -8
  303. package/docs/_posts/components/VolumeRendering/ProjectionVolumeStyle.md +28 -6
  304. package/docs/_posts/components/VolumeRendering/SegmentedVolumeData.md +63 -30
  305. package/docs/_posts/components/VolumeRendering/ShadedVolumeStyle.md +27 -19
  306. package/docs/_posts/components/VolumeRendering/SilhouetteEnhancementVolumeStyle.md +21 -13
  307. package/docs/_posts/components/VolumeRendering/ToneMappedVolumeStyle.md +25 -16
  308. package/docs/_posts/components/VolumeRendering/VolumeData.md +43 -26
  309. package/docs/_posts/components/X_ITE/BlendMode.md +16 -9
  310. package/docs/_posts/getting-started.md +1 -0
  311. package/docs/_posts/laboratory/x3d-file-converter.md +1 -1
  312. package/docs/_tabs/playground.html +3 -1
  313. package/docs/assets/css/style.scss +4 -4
  314. package/package.json +1 -1
  315. package/src/x_ite/Base/X3DBaseNode.js +1 -1
  316. package/src/x_ite/Base/X3DInfoArray.js +2 -2
  317. package/src/x_ite/Browser/Core/X3DCoreContext.js +10 -3
  318. package/src/x_ite/Browser/DOMIntegration.js +13 -8
  319. package/src/x_ite/Browser/VERSION.js +1 -1
  320. package/src/x_ite/Components/Annotation/GroupAnnotation.js +1 -1
  321. package/src/x_ite/Components/CubeMapTexturing/ComposedCubeMapTexture.js +3 -3
  322. package/src/x_ite/Components/DIS/DISEntityManager.js +1 -1
  323. package/src/x_ite/Components/Geospatial/GeoLocation.js +1 -1
  324. package/src/x_ite/Components/Geospatial/GeoViewpoint.js +18 -6
  325. package/src/x_ite/Components/Grouping/Switch.js +1 -1
  326. package/src/x_ite/Components/HAnim/HAnimMotion.js +1 -1
  327. package/src/x_ite/Components/Layering/X3DLayerNode.js +1 -1
  328. package/src/x_ite/Components/Lighting/DirectionalLight.js +1 -1
  329. package/src/x_ite/Components/NURBS/NurbsPatchSurface.js +1 -1
  330. package/src/x_ite/Components/NURBS/NurbsTrimmedSurface.js +1 -1
  331. package/src/x_ite/Components/Navigation/Collision.js +1 -1
  332. package/src/x_ite/Components/Navigation/LOD.js +1 -1
  333. package/src/x_ite/Components/Navigation/Viewpoint.js +1 -1
  334. package/src/x_ite/Components/Navigation/X3DViewpointNode.js +1 -1
  335. package/src/x_ite/Components/Networking/LoadSensor.js +1 -1
  336. package/src/x_ite/Components/ParticleSystems/ConeEmitter.js +9 -9
  337. package/src/x_ite/Components/ParticleSystems/ExplosionEmitter.js +7 -7
  338. package/src/x_ite/Components/ParticleSystems/ParticleSystem.js +1 -1
  339. package/src/x_ite/Components/ParticleSystems/PointEmitter.js +8 -8
  340. package/src/x_ite/Components/ParticleSystems/PolylineEmitter.js +9 -9
  341. package/src/x_ite/Components/ParticleSystems/SurfaceEmitter.js +7 -7
  342. package/src/x_ite/Components/ParticleSystems/VolumeEmitter.js +12 -10
  343. package/src/x_ite/Components/RigidBodyPhysics/Contact.js +1 -1
  344. package/src/x_ite/Components/RigidBodyPhysics/MotorJoint.js +6 -6
  345. package/src/x_ite/Components/RigidBodyPhysics/SingleAxisHingeJoint.js +0 -1
  346. package/src/x_ite/Components/RigidBodyPhysics/UniversalJoint.js +4 -4
  347. package/src/x_ite/Components/Shape/AcousticProperties.js +1 -1
  348. package/src/x_ite/Components/Shape/Appearance.js +1 -1
  349. package/src/x_ite/Components/Shape/FillProperties.js +1 -1
  350. package/src/x_ite/Components/Shape/Material.js +1 -1
  351. package/src/x_ite/Components/Shape/PhysicalMaterial.js +1 -1
  352. package/src/x_ite/Components/Shape/TwoSidedMaterial.js +1 -1
  353. package/src/x_ite/Components/Sound/Analyser.js +2 -2
  354. package/src/x_ite/Components/Sound/AudioDestination.js +2 -2
  355. package/src/x_ite/Components/Sound/BiquadFilter.js +3 -3
  356. package/src/x_ite/Components/Sound/BufferAudioSource.js +2 -2
  357. package/src/x_ite/Components/Sound/ChannelMerger.js +2 -2
  358. package/src/x_ite/Components/Sound/ChannelSelector.js +2 -2
  359. package/src/x_ite/Components/Sound/ChannelSplitter.js +2 -2
  360. package/src/x_ite/Components/Sound/Convolver.js +2 -2
  361. package/src/x_ite/Components/Sound/Delay.js +2 -2
  362. package/src/x_ite/Components/Sound/DynamicsCompressor.js +2 -2
  363. package/src/x_ite/Components/Sound/Gain.js +2 -2
  364. package/src/x_ite/Components/Sound/PeriodicWave.js +1 -1
  365. package/src/x_ite/Components/Sound/StreamAudioDestination.js +2 -2
  366. package/src/x_ite/Components/Sound/WaveShaper.js +3 -3
  367. package/src/x_ite/Components/TextureProjector/TextureProjector.js +4 -4
  368. package/src/x_ite/Components/TextureProjector/TextureProjectorParallel.js +5 -5
  369. package/src/x_ite/Components/Texturing/PixelTexture.js +1 -1
  370. package/src/x_ite/Components/Texturing/TextureProperties.js +1 -1
  371. package/src/x_ite/Components/VolumeRendering/IsoSurfaceVolumeData.js +1 -1
  372. package/src/x_ite/Components/VolumeRendering/SegmentedVolumeData.js +1 -1
  373. package/src/x_ite/Components/VolumeRendering/VolumeData.js +1 -1
  374. package/src/x_ite/Configuration/SupportedComponents.js +2 -2
  375. package/src/x_ite/Fields/ArrayFields.js +2 -2
  376. package/src/x_ite/Fields/SFColor.js +1 -1
  377. package/src/x_ite/Fields/SFMatrixPrototypeTemplate.js +1 -1
  378. package/src/x_ite/Fields/SFRotation.js +3 -3
  379. package/src/x_ite/Fields/SFVecPrototypeTemplate.js +1 -1
  380. package/src/x_ite/Parser/GoldenGate.js +16 -5
  381. package/src/x_ite/Parser/PLYAParser.js +615 -0
  382. package/src/x_ite/Parser/PLYBParser.js +222 -0
  383. package/src/x_ite/Parser/STLAParser.js +0 -1
  384. /package/build/{bin → docs}/components.js +0 -0
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: AudioClip
3
- date: 2022-01-07
3
+ date: 2023-01-07
4
4
  nav: components-Sound
5
5
  categories: [components, Sound]
6
6
  tags: [AudioClip, Sound]
@@ -15,7 +15,7 @@ tags: [AudioClip, Sound]
15
15
 
16
16
  AudioClip provides audio data used by parent Sound nodes.
17
17
 
18
- The AudioClip node belongs to the **Sound** component and its default container field is *source.* It is available since X3D version 2.0 or later.
18
+ The AudioClip node belongs to the **Sound** component and its default container field is *source.* It is available from X3D version 2.0 or higher.
19
19
 
20
20
  ## Hierarchy
21
21
 
@@ -33,23 +33,31 @@ The AudioClip node belongs to the **Sound** component and its default container
33
33
 
34
34
  ### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
35
35
 
36
- Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
36
+ Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
37
+
38
+ #### Hint
39
+
40
+ - [X3D Architecture 7.2.4 Metadata](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata){:target="_blank"}
37
41
 
38
42
  ### SFString [in, out] **description** ""
39
43
 
40
- Author-provided text tooltip that tells users the expected action of this node.
44
+ Author-provided prose that describes intended purpose of the url asset.
41
45
 
42
46
  #### Hint
43
47
 
44
- - Many XML tools substitute XML character references automatically if needed (such as &amp;#38; for &amp; ampersand, or &amp;#34; for " quotation mark).
48
+ - Many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &amp;#38; for &amp; ampersand character, or &amp;#34; for " quotation-mark character).
49
+
50
+ ### SFBool [in, out] **enabled** TRUE
51
+
52
+ Enables/disables node operation.
45
53
 
46
54
  ### SFBool [in, out] **load** TRUE
47
55
 
48
- *load*=true means load immediately, load=false means defer loading or else unload a previously loaded asset.
56
+ *load*=true means *load* immediately, *load*=false means defer loading or else unload a previously loaded scene.
49
57
 
50
58
  #### Hints
51
59
 
52
- - Allows author to design when ImageTextureAtlas loading occurs via user interaction, event chains or scripting.
60
+ - Allows author to design when Inline loading occurs via user interaction, event chains or scripting.
53
61
  - Use a separate LoadSensor node to detect when loading is complete.
54
62
 
55
63
  ### MFString [in, out] **url** [ ] <small>[URI]</small>
@@ -58,15 +66,14 @@ Location and filename of sound file or stream. Support for .wav format is requir
58
66
 
59
67
  #### Hints
60
68
 
61
- - MFString arrays can have multiple values, so separate each individual string by quote marks. "https://www.web3d.org" "https://www.web3d.org/about" "etc." XML encoding for quotation mark " is &amp;quot; (which is called a character entity). Can replace embedded blank(s) in url queries with %20 for each blank character.
69
+ - MFString arrays can have multiple values, so separate each individual string by quote marks. "https://www.web3d.org" "https://www.web3d.org/about" "etc."
70
+ - Alternative XML encoding for quotation mark " is &amp;quot; (which is an example of a character entity).
71
+ - Can replace embedded blank(s) in *url* queries with %20 for each blank character.
72
+ - [X3D Scene Authoring Hints, urls](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls){:target="_blank"}
62
73
 
63
74
  #### Warning
64
75
 
65
- - Strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https and other operating systems are not.
66
-
67
- #### See Also
68
-
69
- - [X3D Scene Authoring Hints, urls](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls){:target="_blank"}
76
+ - Strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https *url* addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
70
77
 
71
78
  ### SFTime [in, out] **autoRefresh** 0 <small>[0,∞)</small>
72
79
 
@@ -93,67 +100,110 @@ Location and filename of sound file or stream. Support for .wav format is requir
93
100
 
94
101
  - Automatically reloading content has security considerations and needs to be considered carefully.
95
102
 
103
+ ### SFFloat [in, out] **gain** 1 <small>(-∞,∞)</small>
104
+
105
+ The *gain* field is a factor that represents the amount of linear amplification to apply to the output of the node.
106
+
107
+ #### Hint
108
+
109
+ - Negative *gain* factors negate the input signal.
110
+
111
+ #### Warning
112
+
113
+ - Decibel values shall not be used.
114
+
96
115
  ### SFFloat [in, out] **pitch** 1 <small>(0,∞)</small>
97
116
 
98
- Multiplier for the rate at which sampled sound is played. Changing pitch also changes playback speed.
117
+ Multiplier for the rate at which sampled sound is played. Changing *pitch* also changes playback speed.
118
+
119
+ #### Hint
120
+
121
+ - Changing the *pitch* field does not trigger a duration_changed event. Playback interval may vary but duration of the original media data remains unmodified.
99
122
 
100
123
  ### SFBool [in, out] **loop** FALSE
101
124
 
102
- Repeat indefinitely when loop=true, repeat only once when loop=false.
125
+ Repeat indefinitely when *loop*=true, repeat only once when *loop*=false.
103
126
 
104
- ### SFTime [in, out] **startTime** <small>(-∞,∞)</small>
127
+ ### SFTime [in, out] **startTime** 0 <small>(-∞,∞)</small>
105
128
 
106
129
  Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
107
130
 
108
131
  #### Hint
109
132
 
110
- - Usually receives a ROUTEd time value.
133
+ - ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
111
134
 
112
- ### SFTime [in, out] **resumeTime** <small>(-∞,∞)</small>
135
+ ### SFTime [in, out] **resumeTime** 0 <small>(-∞,∞)</small>
113
136
 
114
- When resumeTime becomes\<= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
137
+ When *resumeTime* becomes \<= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
115
138
 
116
139
  #### Hint
117
140
 
118
- - Usually receives a ROUTEd time value.
141
+ - ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
119
142
 
120
- ### SFTime [in, out] **pauseTime** <small>(-∞,∞)</small>
143
+ ### SFTime [in, out] **pauseTime** 0 <small>(-∞,∞)</small>
121
144
 
122
- When time now \>= pauseTime, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
145
+ When time now \>= *pauseTime*, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
123
146
 
124
147
  #### Hint
125
148
 
126
- - Usually receives a ROUTEd time value.
149
+ - ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
127
150
 
128
- ### SFTime [in, out] **stopTime** <small>(-∞,∞)</small>
151
+ ### SFTime [in, out] **stopTime** 0 <small>(-∞,∞)</small>
129
152
 
130
153
  Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
131
154
 
132
155
  #### Hint
133
156
 
134
- - Usually receives a ROUTEd time value.
157
+ - ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
135
158
 
136
159
  #### Warnings
137
160
 
138
- - An active TimeSensor node ignores set_cycleInterval and set_startTime events. An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
161
+ - An active TimeSensor node ignores set_cycleInterval and set_startTime events.
162
+ - An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
139
163
 
140
164
  ### SFBool [out] **isPaused**
141
165
 
142
166
  *isPaused* true/false events are sent when AudioClip is paused/resumed.
143
167
 
168
+ #### Warning
169
+
170
+ - It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
171
+
144
172
  ### SFBool [out] **isActive**
145
173
 
146
174
  *isActive* true/false events are sent when playback starts/stops.
147
175
 
176
+ #### Warning
177
+
178
+ - It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
179
+
148
180
  ### SFTime [out] **elapsedTime**
149
181
 
150
182
  Current elapsed time since AudioClip activated/running, cumulative in seconds, and not counting any paused time.
151
183
 
184
+ #### Hint
185
+
186
+ - *elapsedTime* is a nonnegative SFTime duration interval, not an absolute clock time.
187
+
188
+ #### Warning
189
+
190
+ - It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
191
+
152
192
  ### SFTime [out] **duration_changed**
153
193
 
154
- *duration_changed* is length of time in seconds for one cycle of audio.
194
+ *duration_changed* is length of time in seconds for one cycle of media stream.
195
+
196
+ #### Hints
197
+
198
+ - *duration_changed* is an SFTime duration interval, normally nonnegative, and not an absolute clock time.
199
+ - Changing the pitch field does not trigger a *duration_changed* event. Playback interval may vary but duration of the original media data remains unmodified.
155
200
 
156
- ## Description
201
+ #### Warnings
202
+
203
+ - Duration value of -1 implies that media data has not yet loaded or is unavailable for some reason.
204
+ - It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
205
+
206
+ ## Advisories
157
207
 
158
208
  ### Hints
159
209
 
@@ -161,13 +211,13 @@ Current elapsed time since AudioClip activated/running, cumulative in seconds, a
161
211
  - Utilize DEF/USE references for multiple copies of a single AudioClip sound file in order to avoid multiple-download delays, reduce memory requirements, and maintain synchronization.
162
212
  - Authors can provide multiple audio formats for the same audio track, with each source address listed separately in the url field.
163
213
  - Player support for .wav format is required, .midi format is recommended, other formats are optional.
164
- - The underlying `<audio/>` element can be accessed via audioClip.getValue().getElement().
214
+ - [X3D Scene Authoring Hints:Audio](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Audio){:target="_blank"}
215
+ - [When parent node is LoadSensor, apply `containerField='children'` (X3Dv4) or `containerField='watchList'` (X3Dv3).](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges){:target="_blank"}
165
216
 
166
217
  ## Example
167
218
 
168
219
  <x3d-canvas src="https://create3000.github.io/media/examples/Sound/AudioClip/AudioClip.x3d" update="auto"></x3d-canvas>
169
220
 
170
- ## External Links
221
+ ## See Also
171
222
 
172
- - [X3D Specification of AudioClip](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#AudioClip){:target="_blank"}
173
- - [X3D Scene Authoring Hints:Audio](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Audio){:target="_blank"}
223
+ - [X3D Specification of AudioClip node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#AudioClip){:target="_blank"}
@@ -13,40 +13,116 @@ tags: [AudioDestination, Sound]
13
13
 
14
14
  ## Overview
15
15
 
16
- AudioDestination ...
16
+ AudioDestination node represents the final audio destination and is what user ultimately hears, typically from the speakers of user device. An AudioDestinationNode representing the audio hardware end-point (the normal case) can potentially output more than 2 channels of audio if the audio hardware is multi-channel.
17
17
 
18
- The AudioDestination node belongs to the **Sound** component and its default container field is *children.* It is available since X3D version 4.0 or later.
18
+ The AudioDestination node belongs to the **Sound** component and its default container field is *children.* It is available from X3D version 4.0 or higher.
19
19
 
20
20
  ## Hierarchy
21
21
 
22
22
  ```
23
23
  + X3DNode
24
+ + X3DChildNode
25
+ + X3DSoundNode
26
+ + X3DSoundDestinationNode
27
+ + AudioDestination
24
28
  ```
25
29
 
26
30
  ## Fields
27
31
 
28
32
  ### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
29
33
 
34
+ Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
35
+
36
+ #### Hint
37
+
38
+ - [X3D Architecture 7.2.4 Metadata](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata){:target="_blank"}
39
+
30
40
  ### SFString [in, out] **description** ""
31
41
 
42
+ Author-provided prose that describes intended purpose of the url asset.
43
+
44
+ #### Hint
45
+
46
+ - Many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &amp;#38; for &amp; ampersand character, or &amp;#34; for " quotation-mark character).
47
+
32
48
  ### SFBool [in, out] **enabled** TRUE
33
49
 
34
- ### SFFloat [in, out] **gain** <small></small>
50
+ Enables/disables node operation.
51
+
52
+ ### SFFloat [in, out] **gain** 1 <small>(-∞,∞)</small>
53
+
54
+ The *gain* field is a factor that represents the amount of linear amplification to apply to the output of the node.
55
+
56
+ #### Hint
35
57
 
36
- ### SFInt32 [in, out] **maxChannelCount** <small></small>
58
+ - Negative *gain* factors negate the input signal.
59
+
60
+ #### Warning
61
+
62
+ - Decibel values shall not be used.
63
+
64
+ ### SFInt32 [in, out] **maxChannelCount** 2 <small>[0,∞)</small>
65
+
66
+ [*maxChannelCount*.
67
+
68
+ #### Hint
69
+
70
+ - [W3C Web Audio API](https://www.w3.org/TR/webaudio/#dom-audionode-channelcount){:target="_blank"}
37
71
 
38
72
  ### SFInt32 [out] **channelCount**
39
73
 
40
- ### SFString [in, out] **channelCountMode** <small></small>
74
+ *channelCount* reports number of channels provided by input nodes.
75
+
76
+ #### Hint
77
+
78
+ - [W3C Web Audio API](https://www.w3.org/TR/webaudio/#dom-audionode-channelcount){:target="_blank"}
79
+
80
+ ### SFString [in, out] **channelCountMode** "MAX" <small>["MAX", "CLAMPED-MAX", "EXPLICIT"]</small>
41
81
 
42
- ### SFString [in, out] **channelInterpretation** <small></small>
82
+ *channelCountMode* determines how individual channels are counted when up-mixing and down-mixing connections to any inputs.
83
+
84
+ #### Hint
85
+
86
+ - [W3C Web Audio API](https://www.w3.org/TR/webaudio/#dom-audionode-channelcountmode){:target="_blank"}
87
+
88
+ ### SFString [in, out] **channelInterpretation** "SPEAKERS" <small>["SPEAKERS", "DISCRETE"]</small>
89
+
90
+ *channelInterpretation* determines how individual channels are treated when up-mixing and down-mixing connections to any inputs.
91
+
92
+ #### Hint
93
+
94
+ - [W3C Web Audio API](https://www.w3.org/TR/webaudio/#dom-audionode-channelinterpretation){:target="_blank"}
43
95
 
44
96
  ### SFString [out] **mediaDeviceID**
45
97
 
98
+ *mediaDeviceID* field provides ID parameter functionality. (TODO experimental)
99
+
46
100
  ### SFBool [out] **isActive**
47
101
 
48
- ### MFNode [in, out] **children** <small></small>
102
+ *isActive* true/false events are sent when playback starts/stops.
103
+
104
+ #### Warning
105
+
106
+ - It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
107
+
108
+ ### MFNode [in, out] **children** [ ] <small>[X3DSoundChannelNode,X3DSoundProcessingNode,X3DSoundSourceNode]</small>
109
+
110
+ The *children* field specifies audio-graph sound sources providing input signals for this node. If multiple input signals are provided by the inputs *children* field, all channels are mixed together and merged prior to presentation.
111
+
112
+ #### Hint
113
+
114
+ - Can be original (DEF) or referenced (USE) nodes.
115
+
116
+ #### Warning
117
+
118
+ - Contained AudioClip or MovieTexture nodes must have `containerField='children'` to override otherwise-incorrect defaults.
119
+
120
+ ## Advisories
121
+
122
+ ### Hint
123
+
124
+ - [W3C Web Audio API](https://www.w3.org/TR/webaudio/#AudioDestinationNode){:target="_blank"}
49
125
 
50
- ## External Links
126
+ ## See Also
51
127
 
52
- - [X3D Specification of AudioDestination](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#AudioDestination){:target="_blank"}
128
+ - [X3D Specification of AudioDestination node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#AudioDestination){:target="_blank"}
@@ -13,58 +13,201 @@ tags: [BiquadFilter, Sound]
13
13
 
14
14
  ## Overview
15
15
 
16
- BiquadFilter ...
16
+ BiquadFilter node is an AudioNode processor implementing common low-order filters. Low-order filters are the building blocks of basic tone controls (bass, mid, treble), graphic equalizers, and more advanced filters. Multiple BiquadFilter node filters can be combined to form more complex filters. The filter parameters such as frequency can be changed over time for filter sweeps, etc.
17
17
 
18
- The BiquadFilter node belongs to the **Sound** component and its default container field is *children.* It is available since X3D version 4.0 or later.
18
+ The BiquadFilter node belongs to the **Sound** component and its default container field is *children.* It is available from X3D version 4.0 or higher.
19
19
 
20
20
  ## Hierarchy
21
21
 
22
22
  ```
23
23
  + X3DNode
24
+ + X3DChildNode
25
+ + X3DTimeDependentNode
26
+ + X3DSoundProcessingNode
27
+ + BiquadFilter
24
28
  ```
25
29
 
26
30
  ## Fields
27
31
 
28
32
  ### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
29
33
 
34
+ Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
35
+
36
+ #### Hint
37
+
38
+ - [X3D Architecture 7.2.4 Metadata](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata){:target="_blank"}
39
+
30
40
  ### SFString [in, out] **description** ""
31
41
 
42
+ Author-provided prose that describes intended purpose of the url asset.
43
+
44
+ #### Hint
45
+
46
+ - Many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &amp;#38; for &amp; ampersand character, or &amp;#34; for " quotation-mark character).
47
+
32
48
  ### SFBool [in, out] **enabled** TRUE
33
49
 
34
- ### SFFloat [in, out] **detune** <small></small>
50
+ Enables/disables node operation.
51
+
52
+ ### SFFloat [in, out] **detune** 0 <small>[0,∞)</small>
53
+
54
+ The *detune* field forms a compound field together with playbackRate that together determine a computedPlaybackRate value.
55
+
56
+ #### Hint
57
+
58
+ - ComputedPlaybackRate(t) = playbackRate(t) * pow(2, *detune*(t) / 1200)
59
+
60
+ ### SFFloat [in, out] **frequency** 350 <small>[0,∞)</small>
61
+
62
+ *frequency* at which the BiquadFilterNode operates, in Hz.
63
+
64
+ #### Hint
65
+
66
+ - [Wikipedia Hertz](https://en.wikipedia.org/wiki/Hertz){:target="_blank"}
67
+
68
+ ### SFFloat [in, out] **gain** 1 <small>(-∞,∞)</small>
69
+
70
+ The *gain* field is a factor that represents the amount of linear amplification to apply to the output of the node.
71
+
72
+ #### Hint
73
+
74
+ - Negative *gain* factors negate the input signal.
35
75
 
36
- ### SFFloat [in, out] **frequency** <small></small>
76
+ #### Warning
37
77
 
38
- ### SFFloat [in, out] **gain** <small></small>
78
+ - Decibel values shall not be used.
39
79
 
40
- ### SFFloat [in, out] **qualityFactor** <small></small>
80
+ ### SFFloat [in, out] **qualityFactor** 1 <small>[0,∞)</small>
41
81
 
42
- ### SFTime [in, out] **tailTime** <small></small>
82
+ *qualityFactor* is Quality Factor (Q) of the respective filter algorithm.
43
83
 
44
- ### SFString [in, out] **type** <small></small>
84
+ #### Hint
85
+
86
+ - [Wikipedia Q factor](https://en.wikipedia.org/wiki/Q_factor){:target="_blank"}
87
+
88
+ ### SFTime [in, out] **tailTime** 0 <small>[0,∞)</small>
89
+
90
+ *tailTime* is duration of time that a node continues to provide output signal after the input signal becomes silent.
91
+
92
+ ### SFString [in, out] **type** "LOWPASS" <small>["LOWPASS", "HIGHPASS", "BANDPASS", "LOWSHELF", "HIGHSHELF", "PEAKING", "NOTCH", "ALLPASS"]</small>
93
+
94
+ *type* selects which BiquadFilter algorithm is used.
95
+
96
+ #### Hint
97
+
98
+ - [W3C Web Audio API](https://www.w3.org/TR/webaudio/#enumdef-biquadfiltertype){:target="_blank"}
45
99
 
46
100
  ### SFInt32 [out] **channelCount**
47
101
 
48
- ### SFString [in, out] **channelCountMode** <small></small>
102
+ *channelCount* reports number of channels provided by input nodes.
103
+
104
+ #### Hint
105
+
106
+ - [W3C Web Audio API](https://www.w3.org/TR/webaudio/#dom-audionode-channelcount){:target="_blank"}
107
+
108
+ ### SFString [in, out] **channelCountMode** "MAX" <small>["MAX", "CLAMPED-MAX", "EXPLICIT"]</small>
109
+
110
+ *channelCountMode* determines how individual channels are counted when up-mixing and down-mixing connections to any inputs.
111
+
112
+ #### Hint
113
+
114
+ - [W3C Web Audio API](https://www.w3.org/TR/webaudio/#dom-audionode-channelcountmode){:target="_blank"}
115
+
116
+ ### SFString [in, out] **channelInterpretation** "SPEAKERS" <small>["SPEAKERS", "DISCRETE"]</small>
117
+
118
+ *channelInterpretation* determines how individual channels are treated when up-mixing and down-mixing connections to any inputs.
119
+
120
+ #### Hint
121
+
122
+ - [W3C Web Audio API](https://www.w3.org/TR/webaudio/#dom-audionode-channelinterpretation){:target="_blank"}
49
123
 
50
- ### SFString [in, out] **channelInterpretation** <small></small>
124
+ ### SFTime [in, out] **startTime** 0 <small>(-∞,∞)</small>
51
125
 
52
- ### SFTime [in, out] **startTime** <small>(-∞,∞)</small>
126
+ Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
53
127
 
54
- ### SFTime [in, out] **resumeTime** <small>(-∞,∞)</small>
128
+ #### Hint
55
129
 
56
- ### SFTime [in, out] **pauseTime** <small>(-∞,∞)</small>
130
+ - ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
57
131
 
58
- ### SFTime [in, out] **stopTime** <small>(-∞,∞)</small>
132
+ ### SFTime [in, out] **resumeTime** 0 <small>(-∞,∞)</small>
133
+
134
+ When *resumeTime* becomes \<= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
135
+
136
+ #### Hint
137
+
138
+ - ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
139
+
140
+ ### SFTime [in, out] **pauseTime** 0 <small>(-∞,∞)</small>
141
+
142
+ When time now \>= *pauseTime*, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
143
+
144
+ #### Hint
145
+
146
+ - ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
147
+
148
+ ### SFTime [in, out] **stopTime** 0 <small>(-∞,∞)</small>
149
+
150
+ Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
151
+
152
+ #### Hint
153
+
154
+ - ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
155
+
156
+ #### Warnings
157
+
158
+ - An active TimeSensor node ignores set_cycleInterval and set_startTime events.
159
+ - An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
59
160
 
60
161
  ### SFBool [out] **isPaused**
61
162
 
163
+ *isPaused* true/false events are sent when AudioClip is paused/resumed.
164
+
165
+ #### Warning
166
+
167
+ - It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
168
+
62
169
  ### SFBool [out] **isActive**
63
170
 
171
+ *isActive* true/false events are sent when playback starts/stops.
172
+
173
+ #### Warning
174
+
175
+ - It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
176
+
64
177
  ### SFTime [out] **elapsedTime**
65
178
 
66
- ### MFNode [in, out] **children** <small></small>
179
+ Current elapsed time since AudioClip activated/running, cumulative in seconds, and not counting any paused time.
180
+
181
+ #### Hint
182
+
183
+ - *elapsedTime* is a nonnegative SFTime duration interval, not an absolute clock time.
184
+
185
+ #### Warning
186
+
187
+ - It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
188
+
189
+ ### MFNode [in, out] **children** [ ] <small>[X3DSoundChannelNode,X3DSoundProcessingNode,X3DSoundSourceNode]</small>
190
+
191
+ The *children* field specifies audio-graph sound sources providing input signals for this node. If multiple input signals are provided by the inputs *children* field, all channels are mixed together and merged prior to presentation.
192
+
193
+ #### Hint
194
+
195
+ - Can be original (DEF) or referenced (USE) nodes.
196
+
197
+ #### Warning
198
+
199
+ - Contained AudioClip or MovieTexture nodes must have `containerField='children'` to override otherwise-incorrect defaults.
200
+
201
+ ## Advisories
202
+
203
+ ### Hint
204
+
205
+ - [W3C Web Audio API](https://www.w3.org/TR/webaudio/#biquadfilternode){:target="_blank"}
206
+
207
+ ### Warning
208
+
209
+ - Contained AudioClip or MovieTexture nodes must have `containerField='children'` to override otherwise-incorrect defaults.
67
210
 
68
- ## External Links
211
+ ## See Also
69
212
 
70
- - [X3D Specification of BiquadFilter](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#BiquadFilter){:target="_blank"}
213
+ - [X3D Specification of BiquadFilter node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#BiquadFilter){:target="_blank"}