index.d.ts 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  1. declare module 'babylonjs/optimizations' {
  2. /**
  3. * A simplifier interface for future simplification implementations.
  4. */
  5. interface ISimplifier {
  6. /**
  7. * Simplification of a given mesh according to the given settings.
  8. * Since this requires computation, it is assumed that the function runs async.
  9. * @param settings The settings of the simplification, including quality and distance
  10. * @param successCallback A callback that will be called after the mesh was simplified.
  11. * @param errorCallback in case of an error, this callback will be called. optional.
  12. */
  13. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  14. }
  15. /**
  16. * Expected simplification settings.
  17. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%);
  18. */
  19. interface ISimplificationSettings {
  20. quality: number;
  21. distance: number;
  22. optimizeMesh?: boolean;
  23. }
  24. class SimplificationSettings implements ISimplificationSettings {
  25. quality: number;
  26. distance: number;
  27. optimizeMesh: boolean | undefined;
  28. constructor(quality: number, distance: number, optimizeMesh?: boolean | undefined);
  29. }
  30. interface ISimplificationTask {
  31. settings: Array<ISimplificationSettings>;
  32. simplificationType: SimplificationType;
  33. mesh: Mesh;
  34. successCallback?: () => void;
  35. parallelProcessing: boolean;
  36. }
  37. class SimplificationQueue {
  38. private _simplificationArray;
  39. running: boolean;
  40. constructor();
  41. addTask(task: ISimplificationTask): void;
  42. executeNext(): void;
  43. runSimplification(task: ISimplificationTask): void;
  44. private getSimplifier(task);
  45. }
  46. /**
  47. * The implemented types of simplification.
  48. * At the moment only Quadratic Error Decimation is implemented.
  49. */
  50. enum SimplificationType {
  51. QUADRATIC = 0,
  52. }
  53. class DecimationTriangle {
  54. vertices: Array<DecimationVertex>;
  55. normal: Vector3;
  56. error: Array<number>;
  57. deleted: boolean;
  58. isDirty: boolean;
  59. borderFactor: number;
  60. deletePending: boolean;
  61. originalOffset: number;
  62. constructor(vertices: Array<DecimationVertex>);
  63. }
  64. class DecimationVertex {
  65. position: Vector3;
  66. id: number;
  67. q: QuadraticMatrix;
  68. isBorder: boolean;
  69. triangleStart: number;
  70. triangleCount: number;
  71. originalOffsets: Array<number>;
  72. constructor(position: Vector3, id: number);
  73. updatePosition(newPosition: Vector3): void;
  74. }
  75. class QuadraticMatrix {
  76. data: Array<number>;
  77. constructor(data?: Array<number>);
  78. det(a11: number, a12: number, a13: number, a21: number, a22: number, a23: number, a31: number, a32: number, a33: number): number;
  79. addInPlace(matrix: QuadraticMatrix): void;
  80. addArrayInPlace(data: Array<number>): void;
  81. add(matrix: QuadraticMatrix): QuadraticMatrix;
  82. static FromData(a: number, b: number, c: number, d: number): QuadraticMatrix;
  83. static DataFromNumbers(a: number, b: number, c: number, d: number): number[];
  84. }
  85. class Reference {
  86. vertexId: number;
  87. triangleId: number;
  88. constructor(vertexId: number, triangleId: number);
  89. }
  90. /**
  91. * An implementation of the Quadratic Error simplification algorithm.
  92. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  93. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  94. * @author RaananW
  95. */
  96. class QuadraticErrorSimplification implements ISimplifier {
  97. private _mesh;
  98. private triangles;
  99. private vertices;
  100. private references;
  101. private _reconstructedMesh;
  102. syncIterations: number;
  103. aggressiveness: number;
  104. decimationIterations: number;
  105. boundingBoxEpsilon: number;
  106. constructor(_mesh: Mesh);
  107. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  108. private runDecimation(settings, submeshIndex, successCallback);
  109. private initWithMesh(submeshIndex, callback, optimizeMesh?);
  110. private init(callback);
  111. private reconstructMesh(submeshIndex);
  112. private initDecimatedMesh();
  113. private isFlipped(vertex1, vertex2, point, deletedArray, borderFactor, delTr);
  114. private updateTriangles(origVertex, vertex, deletedArray, deletedTriangles);
  115. private identifyBorder();
  116. private updateMesh(identifyBorders?);
  117. private vertexError(q, point);
  118. private calculateError(vertex1, vertex2, pointResult?, normalResult?, uvResult?, colorResult?);
  119. }
  120. }
  121. declare module 'babylonjs/optimizations' {
  122. class MeshLODLevel {
  123. distance: number;
  124. mesh: Mesh;
  125. constructor(distance: number, mesh: Mesh);
  126. }
  127. }
  128. declare module 'babylonjs/optimizations' {
  129. class SceneOptimization {
  130. priority: number;
  131. apply: (scene: Scene) => boolean;
  132. constructor(priority?: number);
  133. }
  134. class TextureOptimization extends SceneOptimization {
  135. priority: number;
  136. maximumSize: number;
  137. constructor(priority?: number, maximumSize?: number);
  138. apply: (scene: Scene) => boolean;
  139. }
  140. class HardwareScalingOptimization extends SceneOptimization {
  141. priority: number;
  142. maximumScale: number;
  143. private _currentScale;
  144. constructor(priority?: number, maximumScale?: number);
  145. apply: (scene: Scene) => boolean;
  146. }
  147. class ShadowsOptimization extends SceneOptimization {
  148. apply: (scene: Scene) => boolean;
  149. }
  150. class PostProcessesOptimization extends SceneOptimization {
  151. apply: (scene: Scene) => boolean;
  152. }
  153. class LensFlaresOptimization extends SceneOptimization {
  154. apply: (scene: Scene) => boolean;
  155. }
  156. class ParticlesOptimization extends SceneOptimization {
  157. apply: (scene: Scene) => boolean;
  158. }
  159. class RenderTargetsOptimization extends SceneOptimization {
  160. apply: (scene: Scene) => boolean;
  161. }
  162. class MergeMeshesOptimization extends SceneOptimization {
  163. static _UpdateSelectionTree: boolean;
  164. static UpdateSelectionTree: boolean;
  165. private _canBeMerged;
  166. apply: (scene: Scene, updateSelectionTree?: boolean | undefined) => boolean;
  167. }
  168. class SceneOptimizerOptions {
  169. targetFrameRate: number;
  170. trackerDuration: number;
  171. optimizations: SceneOptimization[];
  172. constructor(targetFrameRate?: number, trackerDuration?: number);
  173. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  174. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  175. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  176. }
  177. class SceneOptimizer {
  178. static _CheckCurrentState(scene: Scene, options: SceneOptimizerOptions, currentPriorityLevel: number, onSuccess?: () => void, onFailure?: () => void): void;
  179. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): void;
  180. }
  181. }
  182. 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';
  183. import {EngineInstrumentation,SceneInstrumentation,_TimeToken} from 'babylonjs/instrumentation';
  184. import {Particle,IParticleSystem,ParticleSystem,BoxParticleEmitter,ConeParticleEmitter,SphereParticleEmitter,SphereDirectedParticleEmitter,IParticleEmitterType} from 'babylonjs/particles';
  185. import {GPUParticleSystem} from 'babylonjs/gpuParticles';
  186. import {FramingBehavior,BouncingBehavior,AutoRotationBehavior} from 'babylonjs/cameraBehaviors';
  187. import {NullEngineOptions,NullEngine} from 'babylonjs/nullEngine';
  188. import {TextureTools} from 'babylonjs/textureTools';
  189. import {SolidParticle,ModelShape,DepthSortedParticle,SolidParticleSystem} from 'babylonjs/solidParticles';
  190. import {Collider,CollisionWorker,ICollisionCoordinator,SerializedMesh,SerializedSubMesh,SerializedGeometry,BabylonMessage,SerializedColliderToWorker,WorkerTaskType,WorkerReply,CollisionReplyPayload,InitPayload,CollidePayload,UpdatePayload,WorkerReplyType,CollisionCoordinatorWorker,CollisionCoordinatorLegacy} from 'babylonjs/collisions';
  191. import {IntersectionInfo,PickingInfo,Ray} from 'babylonjs/picking';
  192. import {SpriteManager,Sprite} from 'babylonjs/sprites';
  193. 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';
  194. import {Condition,ValueCondition,PredicateCondition,StateCondition,Action,ActionEvent,ActionManager,InterpolateValueAction,SwitchBooleanAction,SetStateAction,SetValueAction,IncrementValueAction,PlayAnimationAction,StopAnimationAction,DoNothingAction,CombineAction,ExecuteCodeAction,SetParentAction,PlaySoundAction,StopSoundAction} from 'babylonjs/actions';
  195. import {GroundMesh,InstancedMesh,LinesMesh} from 'babylonjs/additionalMeshes';
  196. import {ShaderMaterial} from 'babylonjs/shaderMaterial';
  197. import {MeshBuilder} from 'babylonjs/meshBuilder';
  198. import {PBRBaseMaterial,PBRBaseSimpleMaterial,PBRMaterial,PBRMetallicRoughnessMaterial,PBRSpecularGlossinessMaterial} from 'babylonjs/pbrMaterial';
  199. import {CameraInputTypes,ICameraInput,CameraInputsMap,CameraInputsManager,TargetCamera} from 'babylonjs/targetCamera';
  200. import {ArcRotateCameraKeyboardMoveInput,ArcRotateCameraMouseWheelInput,ArcRotateCameraPointersInput,ArcRotateCameraInputsManager,ArcRotateCamera} from 'babylonjs/arcRotateCamera';
  201. import {FreeCameraMouseInput,FreeCameraKeyboardMoveInput,FreeCameraInputsManager,FreeCamera} from 'babylonjs/freeCamera';
  202. import {HemisphericLight} from 'babylonjs/hemisphericLight';
  203. import {IShadowLight,ShadowLight,PointLight} from 'babylonjs/pointLight';
  204. import {DirectionalLight} from 'babylonjs/directionalLight';
  205. import {SpotLight} from 'babylonjs/spotLight';
  206. import {CubeTexture,RenderTargetTexture,IMultiRenderTargetOptions,MultiRenderTarget,MirrorTexture,RefractionTexture,DynamicTexture,VideoTexture,RawTexture} from 'babylonjs/additionalTextures';
  207. import {AudioEngine,Sound,SoundTrack,Analyser} from 'babylonjs/audio';
  208. import {ILoadingScreen,DefaultLoadingScreen,SceneLoaderProgressEvent,ISceneLoaderPluginExtensions,ISceneLoaderPluginFactory,ISceneLoaderPlugin,ISceneLoaderPluginAsync,SceneLoader,FilesInput} from 'babylonjs/loader';
  209. import {IShadowGenerator,ShadowGenerator} from 'babylonjs/shadows';
  210. import {StringDictionary} from 'babylonjs/stringDictionary';
  211. import {Tags,AndOrNotEvaluator} from 'babylonjs/userData';
  212. import {FresnelParameters} from 'babylonjs/fresnel';
  213. import {MultiMaterial} from 'babylonjs/multiMaterial';
  214. import {Database} from 'babylonjs/offline';
  215. import {FreeCameraTouchInput,TouchCamera} from 'babylonjs/touchCamera';
  216. import {ProceduralTexture,CustomProceduralTexture} from 'babylonjs/procedural';
  217. import {FreeCameraGamepadInput,ArcRotateCameraGamepadInput,GamepadManager,StickValues,GamepadButtonChanges,Gamepad,GenericPad,Xbox360Button,Xbox360Dpad,Xbox360Pad,PoseEnabledControllerType,MutableGamepadButton,ExtendedGamepadButton,PoseEnabledControllerHelper,PoseEnabledController,WebVRController,OculusTouchController,ViveController,GenericController,WindowsMotionController} from 'babylonjs/gamepad';
  218. import {FollowCamera,ArcFollowCamera,UniversalCamera,GamepadCamera} from 'babylonjs/additionalCameras';
  219. import {DepthRenderer} from 'babylonjs/depthRenderer';
  220. import {GeometryBufferRenderer} from 'babylonjs/geometryBufferRenderer';
  221. import {PostProcessOptions,PostProcess,PassPostProcess} from 'babylonjs/postProcesses';
  222. import {BlurPostProcess} from 'babylonjs/additionalPostProcess_blur';
  223. import {FxaaPostProcess} from 'babylonjs/additionalPostProcess_fxaa';
  224. import {HighlightsPostProcess} from 'babylonjs/additionalPostProcess_highlights';
  225. import {RefractionPostProcess,BlackAndWhitePostProcess,ConvolutionPostProcess,FilterPostProcess,VolumetricLightScatteringPostProcess,ColorCorrectionPostProcess,TonemappingOperator,TonemapPostProcess,DisplayPassPostProcess,ImageProcessingPostProcess} from 'babylonjs/additionalPostProcesses';
  226. import {PostProcessRenderPipelineManager,PostProcessRenderPass,PostProcessRenderEffect,PostProcessRenderPipeline} from 'babylonjs/renderingPipeline';
  227. import {SSAORenderingPipeline,SSAO2RenderingPipeline,LensRenderingPipeline,StandardRenderingPipeline} from 'babylonjs/additionalRenderingPipeline';
  228. import {DefaultRenderingPipeline} from 'babylonjs/defaultRenderingPipeline';
  229. import {Bone,BoneIKController,BoneLookController,Skeleton} from 'babylonjs/bones';
  230. import {SphericalPolynomial,SphericalHarmonics,CubeMapToSphericalPolynomialTools,CubeMapInfo,PanoramaToCubeMapTools,HDRInfo,HDRTools,HDRCubeTexture} from 'babylonjs/hdr';
  231. import {CSG} from 'babylonjs/csg';
  232. import {Polygon,PolygonMeshBuilder} from 'babylonjs/polygonMesh';
  233. import {LensFlare,LensFlareSystem} from 'babylonjs/lensFlares';
  234. 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';
  235. import {TGATools,DDSInfo,DDSTools,KhronosTextureContainer} from 'babylonjs/textureFormats';
  236. import {Debug,RayHelper,DebugLayer,BoundingBoxRenderer} from 'babylonjs/debug';
  237. import {MorphTarget,MorphTargetManager} from 'babylonjs/morphTargets';
  238. import {IOctreeContainer,Octree,OctreeBlock} from 'babylonjs/octrees';
  239. import {SIMDHelper} from 'babylonjs/simd';
  240. 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';
  241. import {JoystickAxis,VirtualJoystick,VirtualJoysticksCamera,FreeCameraVirtualJoystickInput} from 'babylonjs/virtualJoystick';
  242. import {OutlineRenderer,EdgesRenderer,IHighlightLayerOptions,HighlightLayer} from 'babylonjs/highlights';
  243. import {SceneSerializer} from 'babylonjs/serialization';
  244. import {AssetTaskState,AbstractAssetTask,IAssetsProgressEvent,AssetsProgressEvent,MeshAssetTask,TextFileAssetTask,BinaryFileAssetTask,ImageAssetTask,ITextureAssetTask,TextureAssetTask,CubeTextureAssetTask,HDRCubeTextureAssetTask,AssetsManager} from 'babylonjs/assetsManager';
  245. import {ReflectionProbe} from 'babylonjs/probes';
  246. import {BackgroundMaterial} from 'babylonjs/backgroundMaterial';
  247. import {Layer} from 'babylonjs/layer';
  248. import {IEnvironmentHelperOptions,EnvironmentHelper} from 'babylonjs/environmentHelper';