index.d.ts 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  1. declare module 'babylonjs/assetsManager' {
  2. enum AssetTaskState {
  3. INIT = 0,
  4. RUNNING = 1,
  5. DONE = 2,
  6. ERROR = 3,
  7. }
  8. abstract class AbstractAssetTask {
  9. name: string;
  10. onSuccess: (task: any) => void;
  11. onError: (task: any, message?: string, exception?: any) => void;
  12. constructor(name: string);
  13. isCompleted: boolean;
  14. taskState: AssetTaskState;
  15. errorObject: {
  16. message?: string;
  17. exception?: any;
  18. };
  19. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  20. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  21. private onErrorCallback(onError, message?, exception?);
  22. private onDoneCallback(onSuccess, onError);
  23. }
  24. interface IAssetsProgressEvent {
  25. remainingCount: number;
  26. totalCount: number;
  27. task: AbstractAssetTask;
  28. }
  29. class AssetsProgressEvent implements IAssetsProgressEvent {
  30. remainingCount: number;
  31. totalCount: number;
  32. task: AbstractAssetTask;
  33. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  34. }
  35. class MeshAssetTask extends AbstractAssetTask {
  36. name: string;
  37. meshesNames: any;
  38. rootUrl: string;
  39. sceneFilename: string;
  40. loadedMeshes: Array<AbstractMesh>;
  41. loadedParticleSystems: Array<ParticleSystem>;
  42. loadedSkeletons: Array<Skeleton>;
  43. onSuccess: (task: MeshAssetTask) => void;
  44. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  45. constructor(name: string, meshesNames: any, rootUrl: string, sceneFilename: string);
  46. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  47. }
  48. class TextFileAssetTask extends AbstractAssetTask {
  49. name: string;
  50. url: string;
  51. text: string;
  52. onSuccess: (task: TextFileAssetTask) => void;
  53. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  54. constructor(name: string, url: string);
  55. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  56. }
  57. class BinaryFileAssetTask extends AbstractAssetTask {
  58. name: string;
  59. url: string;
  60. data: ArrayBuffer;
  61. onSuccess: (task: BinaryFileAssetTask) => void;
  62. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  63. constructor(name: string, url: string);
  64. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  65. }
  66. class ImageAssetTask extends AbstractAssetTask {
  67. name: string;
  68. url: string;
  69. image: HTMLImageElement;
  70. onSuccess: (task: ImageAssetTask) => void;
  71. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  72. constructor(name: string, url: string);
  73. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  74. }
  75. interface ITextureAssetTask<TEX extends BaseTexture> {
  76. texture: TEX;
  77. }
  78. class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  79. name: string;
  80. url: string;
  81. noMipmap: boolean | undefined;
  82. invertY: boolean | undefined;
  83. samplingMode: number;
  84. texture: Texture;
  85. onSuccess: (task: TextureAssetTask) => void;
  86. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  87. constructor(name: string, url: string, noMipmap?: boolean | undefined, invertY?: boolean | undefined, samplingMode?: number);
  88. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  89. }
  90. class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  91. name: string;
  92. url: string;
  93. extensions: string[] | undefined;
  94. noMipmap: boolean | undefined;
  95. files: string[] | undefined;
  96. texture: CubeTexture;
  97. onSuccess: (task: CubeTextureAssetTask) => void;
  98. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  99. constructor(name: string, url: string, extensions?: string[] | undefined, noMipmap?: boolean | undefined, files?: string[] | undefined);
  100. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  101. }
  102. class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  103. name: string;
  104. url: string;
  105. size: number | undefined;
  106. noMipmap: boolean;
  107. generateHarmonics: boolean;
  108. useInGammaSpace: boolean;
  109. usePMREMGenerator: boolean;
  110. texture: HDRCubeTexture;
  111. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  112. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  113. constructor(name: string, url: string, size?: number | undefined, noMipmap?: boolean, generateHarmonics?: boolean, useInGammaSpace?: boolean, usePMREMGenerator?: boolean);
  114. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  115. }
  116. class AssetsManager {
  117. private _scene;
  118. private _isLoading;
  119. protected tasks: AbstractAssetTask[];
  120. protected waitingTasksCount: number;
  121. onFinish: (tasks: AbstractAssetTask[]) => void;
  122. onTaskSuccess: (task: AbstractAssetTask) => void;
  123. onTaskError: (task: AbstractAssetTask) => void;
  124. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  125. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  126. onTaskErrorObservable: Observable<AbstractAssetTask>;
  127. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  128. onProgressObservable: Observable<IAssetsProgressEvent>;
  129. useDefaultLoadingScreen: boolean;
  130. constructor(scene: Scene);
  131. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  132. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  133. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  134. addImageTask(taskName: string, url: string): ImageAssetTask;
  135. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  136. addCubeTextureTask(name: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  137. addHDRCubeTextureTask(name: string, url: string, size?: number, noMipmap?: boolean, generateHarmonics?: boolean, useInGammaSpace?: boolean, usePMREMGenerator?: boolean): HDRCubeTextureAssetTask;
  138. private _decreaseWaitingTasksCount(task);
  139. private _runTask(task);
  140. reset(): AssetsManager;
  141. load(): AssetsManager;
  142. }
  143. }
  144. 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';
  145. import {EngineInstrumentation,SceneInstrumentation,_TimeToken} from 'babylonjs/instrumentation';
  146. import {Particle,IParticleSystem,ParticleSystem,BoxParticleEmitter,ConeParticleEmitter,SphereParticleEmitter,SphereDirectedParticleEmitter,IParticleEmitterType} from 'babylonjs/particles';
  147. import {GPUParticleSystem} from 'babylonjs/gpuParticles';
  148. import {FramingBehavior,BouncingBehavior,AutoRotationBehavior} from 'babylonjs/cameraBehaviors';
  149. import {NullEngineOptions,NullEngine} from 'babylonjs/nullEngine';
  150. import {TextureTools} from 'babylonjs/textureTools';
  151. import {SolidParticle,ModelShape,DepthSortedParticle,SolidParticleSystem} from 'babylonjs/solidParticles';
  152. import {Collider,CollisionWorker,ICollisionCoordinator,SerializedMesh,SerializedSubMesh,SerializedGeometry,BabylonMessage,SerializedColliderToWorker,WorkerTaskType,WorkerReply,CollisionReplyPayload,InitPayload,CollidePayload,UpdatePayload,WorkerReplyType,CollisionCoordinatorWorker,CollisionCoordinatorLegacy} from 'babylonjs/collisions';
  153. import {IntersectionInfo,PickingInfo,Ray} from 'babylonjs/picking';
  154. import {SpriteManager,Sprite} from 'babylonjs/sprites';
  155. 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';
  156. import {Condition,ValueCondition,PredicateCondition,StateCondition,Action,ActionEvent,ActionManager,InterpolateValueAction,SwitchBooleanAction,SetStateAction,SetValueAction,IncrementValueAction,PlayAnimationAction,StopAnimationAction,DoNothingAction,CombineAction,ExecuteCodeAction,SetParentAction,PlaySoundAction,StopSoundAction} from 'babylonjs/actions';
  157. import {GroundMesh,InstancedMesh,LinesMesh} from 'babylonjs/additionalMeshes';
  158. import {ShaderMaterial} from 'babylonjs/shaderMaterial';
  159. import {MeshBuilder} from 'babylonjs/meshBuilder';
  160. import {PBRBaseMaterial,PBRBaseSimpleMaterial,PBRMaterial,PBRMetallicRoughnessMaterial,PBRSpecularGlossinessMaterial} from 'babylonjs/pbrMaterial';
  161. import {CameraInputTypes,ICameraInput,CameraInputsMap,CameraInputsManager,TargetCamera} from 'babylonjs/targetCamera';
  162. import {ArcRotateCameraKeyboardMoveInput,ArcRotateCameraMouseWheelInput,ArcRotateCameraPointersInput,ArcRotateCameraInputsManager,ArcRotateCamera} from 'babylonjs/arcRotateCamera';
  163. import {FreeCameraMouseInput,FreeCameraKeyboardMoveInput,FreeCameraInputsManager,FreeCamera} from 'babylonjs/freeCamera';
  164. import {HemisphericLight} from 'babylonjs/hemisphericLight';
  165. import {IShadowLight,ShadowLight,PointLight} from 'babylonjs/pointLight';
  166. import {DirectionalLight} from 'babylonjs/directionalLight';
  167. import {SpotLight} from 'babylonjs/spotLight';
  168. import {CubeTexture,RenderTargetTexture,IMultiRenderTargetOptions,MultiRenderTarget,MirrorTexture,RefractionTexture,DynamicTexture,VideoTexture,RawTexture} from 'babylonjs/additionalTextures';
  169. import {AudioEngine,Sound,SoundTrack,Analyser} from 'babylonjs/audio';
  170. import {ILoadingScreen,DefaultLoadingScreen,SceneLoaderProgressEvent,ISceneLoaderPluginExtensions,ISceneLoaderPluginFactory,ISceneLoaderPlugin,ISceneLoaderPluginAsync,SceneLoader,FilesInput} from 'babylonjs/loader';
  171. import {IShadowGenerator,ShadowGenerator} from 'babylonjs/shadows';
  172. import {StringDictionary} from 'babylonjs/stringDictionary';
  173. import {Tags,AndOrNotEvaluator} from 'babylonjs/userData';
  174. import {FresnelParameters} from 'babylonjs/fresnel';
  175. import {MultiMaterial} from 'babylonjs/multiMaterial';
  176. import {Database} from 'babylonjs/offline';
  177. import {FreeCameraTouchInput,TouchCamera} from 'babylonjs/touchCamera';
  178. import {ProceduralTexture,CustomProceduralTexture} from 'babylonjs/procedural';
  179. import {FreeCameraGamepadInput,ArcRotateCameraGamepadInput,GamepadManager,StickValues,GamepadButtonChanges,Gamepad,GenericPad,Xbox360Button,Xbox360Dpad,Xbox360Pad,PoseEnabledControllerType,MutableGamepadButton,ExtendedGamepadButton,PoseEnabledControllerHelper,PoseEnabledController,WebVRController,OculusTouchController,ViveController,GenericController,WindowsMotionController} from 'babylonjs/gamepad';
  180. import {FollowCamera,ArcFollowCamera,UniversalCamera,GamepadCamera} from 'babylonjs/additionalCameras';
  181. import {DepthRenderer} from 'babylonjs/depthRenderer';
  182. import {GeometryBufferRenderer} from 'babylonjs/geometryBufferRenderer';
  183. import {PostProcessOptions,PostProcess,PassPostProcess} from 'babylonjs/postProcesses';
  184. import {BlurPostProcess} from 'babylonjs/additionalPostProcess_blur';
  185. import {FxaaPostProcess} from 'babylonjs/additionalPostProcess_fxaa';
  186. import {HighlightsPostProcess} from 'babylonjs/additionalPostProcess_highlights';
  187. import {RefractionPostProcess,BlackAndWhitePostProcess,ConvolutionPostProcess,FilterPostProcess,VolumetricLightScatteringPostProcess,ColorCorrectionPostProcess,TonemappingOperator,TonemapPostProcess,DisplayPassPostProcess,ImageProcessingPostProcess} from 'babylonjs/additionalPostProcesses';
  188. import {PostProcessRenderPipelineManager,PostProcessRenderPass,PostProcessRenderEffect,PostProcessRenderPipeline} from 'babylonjs/renderingPipeline';
  189. import {SSAORenderingPipeline,SSAO2RenderingPipeline,LensRenderingPipeline,StandardRenderingPipeline} from 'babylonjs/additionalRenderingPipeline';
  190. import {DefaultRenderingPipeline} from 'babylonjs/defaultRenderingPipeline';
  191. import {Bone,BoneIKController,BoneLookController,Skeleton} from 'babylonjs/bones';
  192. import {SphericalPolynomial,SphericalHarmonics,CubeMapToSphericalPolynomialTools,CubeMapInfo,PanoramaToCubeMapTools,HDRInfo,HDRTools,HDRCubeTexture} from 'babylonjs/hdr';
  193. import {CSG} from 'babylonjs/csg';
  194. import {Polygon,PolygonMeshBuilder} from 'babylonjs/polygonMesh';
  195. import {LensFlare,LensFlareSystem} from 'babylonjs/lensFlares';
  196. 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';
  197. import {TGATools,DDSInfo,DDSTools,KhronosTextureContainer} from 'babylonjs/textureFormats';
  198. import {Debug,RayHelper,DebugLayer,BoundingBoxRenderer} from 'babylonjs/debug';
  199. import {MorphTarget,MorphTargetManager} from 'babylonjs/morphTargets';
  200. import {IOctreeContainer,Octree,OctreeBlock} from 'babylonjs/octrees';
  201. import {SIMDHelper} from 'babylonjs/simd';
  202. 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';
  203. import {JoystickAxis,VirtualJoystick,VirtualJoysticksCamera,FreeCameraVirtualJoystickInput} from 'babylonjs/virtualJoystick';
  204. 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';
  205. import {OutlineRenderer,EdgesRenderer,IHighlightLayerOptions,HighlightLayer} from 'babylonjs/highlights';
  206. import {SceneSerializer} from 'babylonjs/serialization';
  207. import {ReflectionProbe} from 'babylonjs/probes';
  208. import {BackgroundMaterial} from 'babylonjs/backgroundMaterial';
  209. import {Layer} from 'babylonjs/layer';
  210. import {IEnvironmentHelperOptions,EnvironmentHelper} from 'babylonjs/environmentHelper';