index.d.ts 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. declare module 'babylonjs/audio' {
  2. class AudioEngine {
  3. private _audioContext;
  4. private _audioContextInitialized;
  5. canUseWebAudio: boolean;
  6. masterGain: GainNode;
  7. private _connectedAnalyser;
  8. WarnedWebAudioUnsupported: boolean;
  9. unlocked: boolean;
  10. onAudioUnlocked: () => any;
  11. isMP3supported: boolean;
  12. isOGGsupported: boolean;
  13. readonly audioContext: Nullable<AudioContext>;
  14. constructor();
  15. private _unlockiOSaudio();
  16. private _initializeAudioContext();
  17. dispose(): void;
  18. getGlobalVolume(): number;
  19. setGlobalVolume(newVolume: number): void;
  20. connectToAnalyser(analyser: Analyser): void;
  21. }
  22. }
  23. declare module 'babylonjs/audio' {
  24. class Sound {
  25. name: string;
  26. autoplay: boolean;
  27. loop: boolean;
  28. useCustomAttenuation: boolean;
  29. soundTrackId: number;
  30. spatialSound: boolean;
  31. refDistance: number;
  32. rolloffFactor: number;
  33. maxDistance: number;
  34. distanceModel: string;
  35. private _panningModel;
  36. onended: () => any;
  37. private _playbackRate;
  38. private _streaming;
  39. private _startTime;
  40. private _startOffset;
  41. private _position;
  42. private _localDirection;
  43. private _volume;
  44. private _isReadyToPlay;
  45. isPlaying: boolean;
  46. isPaused: boolean;
  47. private _isDirectional;
  48. private _readyToPlayCallback;
  49. private _audioBuffer;
  50. private _soundSource;
  51. private _streamingSource;
  52. private _soundPanner;
  53. private _soundGain;
  54. private _inputAudioNode;
  55. private _ouputAudioNode;
  56. private _coneInnerAngle;
  57. private _coneOuterAngle;
  58. private _coneOuterGain;
  59. private _scene;
  60. private _connectedMesh;
  61. private _customAttenuationFunction;
  62. private _registerFunc;
  63. private _isOutputConnected;
  64. private _htmlAudioElement;
  65. private _urlType;
  66. /**
  67. * Create a sound and attach it to a scene
  68. * @param name Name of your sound
  69. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer
  70. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  71. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  72. */
  73. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: any);
  74. dispose(): void;
  75. isReady(): boolean;
  76. private _soundLoaded(audioData);
  77. setAudioBuffer(audioBuffer: AudioBuffer): void;
  78. updateOptions(options: any): void;
  79. private _createSpatialParameters();
  80. private _updateSpatialParameters();
  81. switchPanningModelToHRTF(): void;
  82. switchPanningModelToEqualPower(): void;
  83. private _switchPanningModel();
  84. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  85. /**
  86. * Transform this sound into a directional source
  87. * @param coneInnerAngle Size of the inner cone in degree
  88. * @param coneOuterAngle Size of the outer cone in degree
  89. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  90. */
  91. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  92. setPosition(newPosition: Vector3): void;
  93. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  94. private _updateDirection();
  95. updateDistanceFromListener(): void;
  96. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  97. /**
  98. * Play the sound
  99. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  100. * @param offset (optional) Start the sound setting it at a specific time
  101. */
  102. play(time?: number, offset?: number): void;
  103. private _onended();
  104. /**
  105. * Stop the sound
  106. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  107. */
  108. stop(time?: number): void;
  109. pause(): void;
  110. setVolume(newVolume: number, time?: number): void;
  111. setPlaybackRate(newPlaybackRate: number): void;
  112. getVolume(): number;
  113. attachToMesh(meshToConnectTo: AbstractMesh): void;
  114. detachFromMesh(): void;
  115. private _onRegisterAfterWorldMatrixUpdate(node);
  116. clone(): Nullable<Sound>;
  117. getAudioBuffer(): AudioBuffer | null;
  118. serialize(): any;
  119. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  120. }
  121. }
  122. declare module 'babylonjs/audio' {
  123. class SoundTrack {
  124. private _outputAudioNode;
  125. private _scene;
  126. id: number;
  127. soundCollection: Array<Sound>;
  128. private _isMainTrack;
  129. private _connectedAnalyser;
  130. private _options;
  131. private _isInitialized;
  132. constructor(scene: Scene, options?: any);
  133. private _initializeSoundTrackAudioGraph();
  134. dispose(): void;
  135. AddSound(sound: Sound): void;
  136. RemoveSound(sound: Sound): void;
  137. setVolume(newVolume: number): void;
  138. switchPanningModelToHRTF(): void;
  139. switchPanningModelToEqualPower(): void;
  140. connectToAnalyser(analyser: Analyser): void;
  141. }
  142. }
  143. declare module 'babylonjs/audio' {
  144. class Analyser {
  145. SMOOTHING: number;
  146. FFT_SIZE: number;
  147. BARGRAPHAMPLITUDE: number;
  148. DEBUGCANVASPOS: {
  149. x: number;
  150. y: number;
  151. };
  152. DEBUGCANVASSIZE: {
  153. width: number;
  154. height: number;
  155. };
  156. private _byteFreqs;
  157. private _byteTime;
  158. private _floatFreqs;
  159. private _webAudioAnalyser;
  160. private _debugCanvas;
  161. private _debugCanvasContext;
  162. private _scene;
  163. private _registerFunc;
  164. private _audioEngine;
  165. constructor(scene: Scene);
  166. getFrequencyBinCount(): number;
  167. getByteFrequencyData(): Uint8Array;
  168. getByteTimeDomainData(): Uint8Array;
  169. getFloatFrequencyData(): Uint8Array;
  170. drawDebugCanvas(): void;
  171. stopDebugCanvas(): void;
  172. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  173. dispose(): void;
  174. }
  175. }
  176. import {EffectFallbacks,EffectCreationOptions,Effect,Nullable,float,double,int,FloatArray,IndicesArray,KeyboardEventTypes,KeyboardInfo,KeyboardInfoPre,PointerEventTypes,PointerInfoBase,PointerInfoPre,PointerInfo,ToGammaSpace,ToLinearSpace,Epsilon,Color3,Color4,Vector2,Vector3,Vector4,ISize,Size,Quaternion,Matrix,Plane,Viewport,Frustum,Space,Axis,BezierCurve,Orientation,Angle,Arc2,Path2,Path3D,Curve3,PositionNormalVertex,PositionNormalTextureVertex,Tmp,Scalar,expandToProperty,serialize,serializeAsTexture,serializeAsColor3,serializeAsFresnelParameters,serializeAsVector2,serializeAsVector3,serializeAsMeshReference,serializeAsColorCurves,serializeAsColor4,serializeAsImageProcessingConfiguration,serializeAsQuaternion,SerializationHelper,EventState,Observer,MultiObserver,Observable,SmartArray,SmartArrayNoDuplicate,IAnimatable,LoadFileError,RetryStrategy,IFileRequest,Tools,PerfCounter,className,AsyncLoop,_AlphaState,_DepthCullingState,_StencilState,InstancingAttributeInfo,RenderTargetCreationOptions,EngineCapabilities,EngineOptions,IDisplayChangedEventArgs,Engine,Node,BoundingSphere,BoundingBox,ICullable,BoundingInfo,TransformNode,AbstractMesh,Light,Camera,RenderingManager,RenderingGroup,IDisposable,IActiveMeshCandidateProvider,RenderingGroupInfo,Scene,Buffer,VertexBuffer,InternalTexture,BaseTexture,Texture,_InstancesBatch,Mesh,BaseSubMesh,SubMesh,MaterialDefines,Material,UniformBuffer,IGetSetVerticesData,VertexData,Geometry,_PrimitiveGeometry,RibbonGeometry,BoxGeometry,SphereGeometry,DiscGeometry,CylinderGeometry,TorusGeometry,GroundGeometry,TiledGroundGeometry,PlaneGeometry,TorusKnotGeometry,PostProcessManager,PerformanceMonitor,RollingAverage,IImageProcessingConfigurationDefines,ImageProcessingConfiguration,ColorGradingTexture,ColorCurves,Behavior,MaterialHelper,PushMaterial,StandardMaterialDefines,StandardMaterial} from 'babylonjs/core';
  177. import {EngineInstrumentation,SceneInstrumentation,_TimeToken} from 'babylonjs/instrumentation';
  178. import {Particle,IParticleSystem,ParticleSystem,BoxParticleEmitter,ConeParticleEmitter,SphereParticleEmitter,SphereDirectedParticleEmitter,IParticleEmitterType} from 'babylonjs/particles';
  179. import {GPUParticleSystem} from 'babylonjs/gpuParticles';
  180. import {FramingBehavior,BouncingBehavior,AutoRotationBehavior} from 'babylonjs/cameraBehaviors';
  181. import {NullEngineOptions,NullEngine} from 'babylonjs/nullEngine';
  182. import {TextureTools} from 'babylonjs/textureTools';
  183. import {SolidParticle,ModelShape,DepthSortedParticle,SolidParticleSystem} from 'babylonjs/solidParticles';
  184. import {Collider,CollisionWorker,ICollisionCoordinator,SerializedMesh,SerializedSubMesh,SerializedGeometry,BabylonMessage,SerializedColliderToWorker,WorkerTaskType,WorkerReply,CollisionReplyPayload,InitPayload,CollidePayload,UpdatePayload,WorkerReplyType,CollisionCoordinatorWorker,CollisionCoordinatorLegacy} from 'babylonjs/collisions';
  185. import {IntersectionInfo,PickingInfo,Ray} from 'babylonjs/picking';
  186. import {SpriteManager,Sprite} from 'babylonjs/sprites';
  187. import {AnimationRange,AnimationEvent,PathCursor,Animation,TargetedAnimation,AnimationGroup,RuntimeAnimation,Animatable,IEasingFunction,EasingFunction,CircleEase,BackEase,BounceEase,CubicEase,ElasticEase,ExponentialEase,PowerEase,QuadraticEase,QuarticEase,QuinticEase,SineEase,BezierCurveEase} from 'babylonjs/animations';
  188. import {Condition,ValueCondition,PredicateCondition,StateCondition,Action,ActionEvent,ActionManager,InterpolateValueAction,SwitchBooleanAction,SetStateAction,SetValueAction,IncrementValueAction,PlayAnimationAction,StopAnimationAction,DoNothingAction,CombineAction,ExecuteCodeAction,SetParentAction,PlaySoundAction,StopSoundAction} from 'babylonjs/actions';
  189. import {GroundMesh,InstancedMesh,LinesMesh} from 'babylonjs/additionalMeshes';
  190. import {ShaderMaterial} from 'babylonjs/shaderMaterial';
  191. import {MeshBuilder} from 'babylonjs/meshBuilder';
  192. import {PBRBaseMaterial,PBRBaseSimpleMaterial,PBRMaterial,PBRMetallicRoughnessMaterial,PBRSpecularGlossinessMaterial} from 'babylonjs/pbrMaterial';
  193. import {CameraInputTypes,ICameraInput,CameraInputsMap,CameraInputsManager,TargetCamera} from 'babylonjs/targetCamera';
  194. import {ArcRotateCameraKeyboardMoveInput,ArcRotateCameraMouseWheelInput,ArcRotateCameraPointersInput,ArcRotateCameraInputsManager,ArcRotateCamera} from 'babylonjs/arcRotateCamera';
  195. import {FreeCameraMouseInput,FreeCameraKeyboardMoveInput,FreeCameraInputsManager,FreeCamera} from 'babylonjs/freeCamera';
  196. import {HemisphericLight} from 'babylonjs/hemisphericLight';
  197. import {IShadowLight,ShadowLight,PointLight} from 'babylonjs/pointLight';
  198. import {DirectionalLight} from 'babylonjs/directionalLight';
  199. import {SpotLight} from 'babylonjs/spotLight';
  200. import {CubeTexture,RenderTargetTexture,IMultiRenderTargetOptions,MultiRenderTarget,MirrorTexture,RefractionTexture,DynamicTexture,VideoTexture,RawTexture} from 'babylonjs/additionalTextures';
  201. import {ILoadingScreen,DefaultLoadingScreen,SceneLoaderProgressEvent,ISceneLoaderPluginExtensions,ISceneLoaderPluginFactory,ISceneLoaderPlugin,ISceneLoaderPluginAsync,SceneLoader,FilesInput} from 'babylonjs/loader';
  202. import {IShadowGenerator,ShadowGenerator} from 'babylonjs/shadows';
  203. import {StringDictionary} from 'babylonjs/stringDictionary';
  204. import {Tags,AndOrNotEvaluator} from 'babylonjs/userData';
  205. import {FresnelParameters} from 'babylonjs/fresnel';
  206. import {MultiMaterial} from 'babylonjs/multiMaterial';
  207. import {Database} from 'babylonjs/offline';
  208. import {FreeCameraTouchInput,TouchCamera} from 'babylonjs/touchCamera';
  209. import {ProceduralTexture,CustomProceduralTexture} from 'babylonjs/procedural';
  210. import {FreeCameraGamepadInput,ArcRotateCameraGamepadInput,GamepadManager,StickValues,GamepadButtonChanges,Gamepad,GenericPad,Xbox360Button,Xbox360Dpad,Xbox360Pad,PoseEnabledControllerType,MutableGamepadButton,ExtendedGamepadButton,PoseEnabledControllerHelper,PoseEnabledController,WebVRController,OculusTouchController,ViveController,GenericController,WindowsMotionController} from 'babylonjs/gamepad';
  211. import {FollowCamera,ArcFollowCamera,UniversalCamera,GamepadCamera} from 'babylonjs/additionalCameras';
  212. import {DepthRenderer} from 'babylonjs/depthRenderer';
  213. import {GeometryBufferRenderer} from 'babylonjs/geometryBufferRenderer';
  214. import {PostProcessOptions,PostProcess,PassPostProcess} from 'babylonjs/postProcesses';
  215. import {BlurPostProcess} from 'babylonjs/additionalPostProcess_blur';
  216. import {FxaaPostProcess} from 'babylonjs/additionalPostProcess_fxaa';
  217. import {HighlightsPostProcess} from 'babylonjs/additionalPostProcess_highlights';
  218. import {RefractionPostProcess,BlackAndWhitePostProcess,ConvolutionPostProcess,FilterPostProcess,VolumetricLightScatteringPostProcess,ColorCorrectionPostProcess,TonemappingOperator,TonemapPostProcess,DisplayPassPostProcess,ImageProcessingPostProcess} from 'babylonjs/additionalPostProcesses';
  219. import {PostProcessRenderPipelineManager,PostProcessRenderPass,PostProcessRenderEffect,PostProcessRenderPipeline} from 'babylonjs/renderingPipeline';
  220. import {SSAORenderingPipeline,SSAO2RenderingPipeline,LensRenderingPipeline,StandardRenderingPipeline} from 'babylonjs/additionalRenderingPipeline';
  221. import {DefaultRenderingPipeline} from 'babylonjs/defaultRenderingPipeline';
  222. import {Bone,BoneIKController,BoneLookController,Skeleton} from 'babylonjs/bones';
  223. import {SphericalPolynomial,SphericalHarmonics,CubeMapToSphericalPolynomialTools,CubeMapInfo,PanoramaToCubeMapTools,HDRInfo,HDRTools,HDRCubeTexture} from 'babylonjs/hdr';
  224. import {CSG} from 'babylonjs/csg';
  225. import {Polygon,PolygonMeshBuilder} from 'babylonjs/polygonMesh';
  226. import {LensFlare,LensFlareSystem} from 'babylonjs/lensFlares';
  227. import {PhysicsJointData,PhysicsJoint,DistanceJoint,MotorEnabledJoint,HingeJoint,Hinge2Joint,IMotorEnabledJoint,DistanceJointData,SpringJointData,PhysicsImpostorParameters,IPhysicsEnabledObject,PhysicsImpostor,PhysicsImpostorJoint,PhysicsEngine,IPhysicsEnginePlugin,PhysicsHelper,PhysicsRadialExplosionEvent,PhysicsGravitationalFieldEvent,PhysicsUpdraftEvent,PhysicsVortexEvent,PhysicsRadialImpulseFalloff,PhysicsUpdraftMode,PhysicsForceAndContactPoint,PhysicsRadialExplosionEventData,PhysicsGravitationalFieldEventData,PhysicsUpdraftEventData,PhysicsVortexEventData,CannonJSPlugin,OimoJSPlugin} from 'babylonjs/physics';
  228. import {TGATools,DDSInfo,DDSTools,KhronosTextureContainer} from 'babylonjs/textureFormats';
  229. import {Debug,RayHelper,DebugLayer,BoundingBoxRenderer} from 'babylonjs/debug';
  230. import {MorphTarget,MorphTargetManager} from 'babylonjs/morphTargets';
  231. import {IOctreeContainer,Octree,OctreeBlock} from 'babylonjs/octrees';
  232. import {SIMDHelper} from 'babylonjs/simd';
  233. import {VRDistortionCorrectionPostProcess,AnaglyphPostProcess,StereoscopicInterlacePostProcess,FreeCameraDeviceOrientationInput,ArcRotateCameraVRDeviceOrientationInput,VRCameraMetrics,DevicePose,PoseControlled,WebVROptions,WebVRFreeCamera,DeviceOrientationCamera,VRDeviceOrientationFreeCamera,VRDeviceOrientationGamepadCamera,VRDeviceOrientationArcRotateCamera,AnaglyphFreeCamera,AnaglyphArcRotateCamera,AnaglyphGamepadCamera,AnaglyphUniversalCamera,StereoscopicFreeCamera,StereoscopicArcRotateCamera,StereoscopicGamepadCamera,StereoscopicUniversalCamera,VRTeleportationOptions,VRExperienceHelperOptions,VRExperienceHelper} from 'babylonjs/vr';
  234. import {JoystickAxis,VirtualJoystick,VirtualJoysticksCamera,FreeCameraVirtualJoystickInput} from 'babylonjs/virtualJoystick';
  235. import {ISimplifier,ISimplificationSettings,SimplificationSettings,ISimplificationTask,SimplificationQueue,SimplificationType,DecimationTriangle,DecimationVertex,QuadraticMatrix,Reference,QuadraticErrorSimplification,MeshLODLevel,SceneOptimization,TextureOptimization,HardwareScalingOptimization,ShadowsOptimization,PostProcessesOptimization,LensFlaresOptimization,ParticlesOptimization,RenderTargetsOptimization,MergeMeshesOptimization,SceneOptimizerOptions,SceneOptimizer} from 'babylonjs/optimizations';
  236. import {OutlineRenderer,EdgesRenderer,IHighlightLayerOptions,HighlightLayer} from 'babylonjs/highlights';
  237. import {SceneSerializer} from 'babylonjs/serialization';
  238. import {AssetTaskState,AbstractAssetTask,IAssetsProgressEvent,AssetsProgressEvent,MeshAssetTask,TextFileAssetTask,BinaryFileAssetTask,ImageAssetTask,ITextureAssetTask,TextureAssetTask,CubeTextureAssetTask,HDRCubeTextureAssetTask,AssetsManager} from 'babylonjs/assetsManager';
  239. import {ReflectionProbe} from 'babylonjs/probes';
  240. import {BackgroundMaterial} from 'babylonjs/backgroundMaterial';
  241. import {Layer} from 'babylonjs/layer';
  242. import {IEnvironmentHelperOptions,EnvironmentHelper} from 'babylonjs/environmentHelper';