babylon.viewer.module.d.ts 106 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481
  1. /// <reference path="./babylon.d.ts"/>
  2. /// <reference path="./babylon.glTF2Interface.d.ts"/>
  3. /// <reference path="./babylonjs.loaders.d.ts"/>
  4. declare module "babylonjs-loaders"{ export=BABYLON;}
  5. // Generated by dts-bundle v0.7.3
  6. // Dependencies for this module:
  7. // ../../../../../Tools/Gulp/babylonjs
  8. // ../../../../../Tools/Gulp/babylonjs-gltf2interface
  9. // ../../../../../Tools/Gulp/babylonjs-loaders
  10. declare module 'babylonjs-viewer' {
  11. import { mapperManager } from 'babylonjs-viewer/configuration/mappers';
  12. import { viewerGlobals } from 'babylonjs-viewer/configuration/globals';
  13. import { viewerManager } from 'babylonjs-viewer/viewer/viewerManager';
  14. import { DefaultViewer } from 'babylonjs-viewer/viewer/defaultViewer';
  15. import { AbstractViewer } from 'babylonjs-viewer/viewer/viewer';
  16. import { telemetryManager } from 'babylonjs-viewer/managers/telemetryManager';
  17. import { ModelLoader } from 'babylonjs-viewer/loader/modelLoader';
  18. import { ViewerModel, ModelState } from 'babylonjs-viewer/model/viewerModel';
  19. import { AnimationPlayMode, AnimationState } from 'babylonjs-viewer/model/modelAnimation';
  20. import { ILoaderPlugin } from 'babylonjs-viewer/loader/plugins/loaderPlugin';
  21. import { AbstractViewerNavbarButton } from 'babylonjs-viewer/templating/viewerTemplatePlugin';
  22. import { registerCustomOptimizer } from 'babylonjs-viewer/optimizer/custom';
  23. /**
  24. * BabylonJS Viewer
  25. *
  26. * An HTML-Based viewer for 3D models, based on BabylonJS and its extensions.
  27. */
  28. import * as BABYLON from 'babylonjs';
  29. import 'babylonjs-loaders';
  30. import 'pepjs';
  31. import { InitTags } from 'babylonjs-viewer/initializer';
  32. let disableInit: boolean;
  33. /**
  34. * Dispose all viewers currently registered
  35. */
  36. function disposeAll(): void;
  37. const Version: string;
  38. export { BABYLON, Version, InitTags, DefaultViewer, AbstractViewer, viewerGlobals, telemetryManager, disableInit, viewerManager, mapperManager, disposeAll, ModelLoader, ViewerModel, AnimationPlayMode, AnimationState, ModelState, ILoaderPlugin, AbstractViewerNavbarButton, registerCustomOptimizer };
  39. export * from 'babylonjs-viewer/configuration';
  40. }
  41. declare module 'babylonjs-viewer/configuration/mappers' {
  42. import { ViewerConfiguration } from 'babylonjs-viewer/configuration/configuration';
  43. /**
  44. * This is the mapper's interface. Implement this function to create your own mapper and register it at the mapper manager
  45. */
  46. export interface IMapper {
  47. map(rawSource: any): ViewerConfiguration;
  48. }
  49. /**
  50. * The MapperManager manages the different implemented mappers.
  51. * It allows the user to register new mappers as well and use them to parse their own configuration data
  52. */
  53. export class MapperManager {
  54. /**
  55. * The default mapper is the JSON mapper.
  56. */
  57. static DefaultMapper: string;
  58. constructor();
  59. /**
  60. * Get a specific configuration mapper.
  61. *
  62. * @param type the name of the mapper to load
  63. */
  64. getMapper(type: string): IMapper;
  65. /**
  66. * Use this functio to register your own configuration mapper.
  67. * After a mapper is registered, it can be used to parse the specific type fo configuration to the standard ViewerConfiguration.
  68. * @param type the name of the mapper. This will be used to define the configuration type and/or to get the mapper
  69. * @param mapper The implemented mapper
  70. */
  71. registerMapper(type: string, mapper: IMapper): void;
  72. /**
  73. * Dispose the mapper manager and all of its mappers.
  74. */
  75. dispose(): void;
  76. }
  77. /**
  78. * mapperManager is a singleton of the type MapperManager.
  79. * The mapperManager can be disposed directly with calling mapperManager.dispose()
  80. * or indirectly with using BabylonViewer.disposeAll()
  81. */
  82. export let mapperManager: MapperManager;
  83. }
  84. declare module 'babylonjs-viewer/configuration/globals' {
  85. export class ViewerGlobals {
  86. disableInit: boolean;
  87. disableWebGL2Support: boolean;
  88. readonly version: string;
  89. }
  90. export let viewerGlobals: ViewerGlobals;
  91. }
  92. declare module 'babylonjs-viewer/viewer/viewerManager' {
  93. import { Observable } from 'babylonjs';
  94. import { AbstractViewer } from 'babylonjs-viewer/viewer/viewer';
  95. /**
  96. * The viewer manager is the container for all viewers currently registered on this page.
  97. * It is possible to have more than one viewer on a single page.
  98. */
  99. export class ViewerManager {
  100. /**
  101. * A callback that will be triggered when a new viewer was added
  102. */
  103. onViewerAdded: (viewer: AbstractViewer) => void;
  104. /**
  105. * Will notify when a new viewer was added
  106. */
  107. onViewerAddedObservable: Observable<AbstractViewer>;
  108. /**
  109. * Will notify when a viewer was removed (disposed)
  110. */
  111. onViewerRemovedObservable: Observable<string>;
  112. constructor();
  113. /**
  114. * Adding a new viewer to the viewer manager and start tracking it.
  115. * @param viewer the viewer to add
  116. */
  117. addViewer(viewer: AbstractViewer): void;
  118. /**
  119. * remove a viewer from the viewer manager
  120. * @param viewer the viewer to remove
  121. */
  122. removeViewer(viewer: AbstractViewer): void;
  123. /**
  124. * Get a viewer by its baseId (if the container element has an ID, it is the this is. if not, a random id was assigned)
  125. * @param id the id of the HTMl element (or the viewer's, if none provided)
  126. */
  127. getViewerById(id: string): AbstractViewer;
  128. /**
  129. * Get a viewer using a container element
  130. * @param element the HTML element to search viewers associated with
  131. */
  132. getViewerByHTMLElement(element: HTMLElement): AbstractViewer | undefined;
  133. /**
  134. * Get a promise that will fullfil when this viewer was initialized.
  135. * Since viewer initialization and template injection is asynchronous, using the promise will guaranty that
  136. * you will get the viewer after everything was already configured.
  137. * @param id the viewer id to find
  138. */
  139. getViewerPromiseById(id: string): Promise<AbstractViewer>;
  140. /**
  141. * dispose the manager and all of its associated viewers
  142. */
  143. dispose(): void;
  144. }
  145. export let viewerManager: ViewerManager;
  146. }
  147. declare module 'babylonjs-viewer/viewer/defaultViewer' {
  148. import { ViewerConfiguration, IModelConfiguration } from 'babylonjs-viewer/configuration';
  149. import { Template } from 'babylonjs-viewer/templating/templateManager';
  150. import { AbstractViewer } from 'babylonjs-viewer/viewer/viewer';
  151. import { ViewerModel } from 'babylonjs-viewer/model/viewerModel';
  152. import { IViewerTemplatePlugin } from 'babylonjs-viewer/templating/viewerTemplatePlugin';
  153. /**
  154. * The Default viewer is the default implementation of the AbstractViewer.
  155. * It uses the templating system to render a new canvas and controls.
  156. */
  157. export class DefaultViewer extends AbstractViewer {
  158. containerElement: Element;
  159. fullscreenElement?: Element;
  160. /**
  161. * Create a new default viewer
  162. * @param containerElement the element in which the templates will be rendered
  163. * @param initialConfiguration the initial configuration. Defaults to extending the default configuration
  164. */
  165. constructor(containerElement: Element, initialConfiguration?: ViewerConfiguration);
  166. registerTemplatePlugin(plugin: IViewerTemplatePlugin): void;
  167. /**
  168. * This will be executed when the templates initialize.
  169. */
  170. protected _onTemplatesLoaded(): Promise<AbstractViewer>;
  171. protected _initVR(): void;
  172. /**
  173. * Toggle fullscreen of the entire viewer
  174. */
  175. toggleFullscreen: () => void;
  176. /**
  177. * Preparing the container element to present the viewer
  178. */
  179. protected _prepareContainerElement(): void;
  180. /**
  181. * This function will configure the templates and update them after a model was loaded
  182. * It is mainly responsible to changing the title and subtitle etc'.
  183. * @param model the model to be used to configure the templates by
  184. */
  185. protected _configureTemplate(model?: ViewerModel): void;
  186. /**
  187. * This will load a new model to the default viewer
  188. * overriding the AbstractViewer's loadModel.
  189. * The scene will automatically be cleared of the old models, if exist.
  190. * @param model the configuration object (or URL) to load.
  191. */
  192. loadModel(model?: string | File | IModelConfiguration): Promise<ViewerModel>;
  193. /**
  194. * Show the overlay and the defined sub-screen.
  195. * Mainly used for help and errors
  196. * @param subScreen the name of the subScreen. Those can be defined in the configuration object
  197. */
  198. showOverlayScreen(subScreen: string): Promise<string> | Promise<Template>;
  199. /**
  200. * Hide the overlay screen.
  201. */
  202. hideOverlayScreen(): Promise<string> | Promise<Template>;
  203. /**
  204. * show the viewer (in case it was hidden)
  205. *
  206. * @param visibilityFunction an optional function to execute in order to show the container
  207. */
  208. show(visibilityFunction?: ((template: Template) => Promise<Template>)): Promise<Template>;
  209. /**
  210. * hide the viewer (in case it is visible)
  211. *
  212. * @param visibilityFunction an optional function to execute in order to hide the container
  213. */
  214. hide(visibilityFunction?: ((template: Template) => Promise<Template>)): Promise<Template>;
  215. /**
  216. * Show the loading screen.
  217. * The loading screen can be configured using the configuration object
  218. */
  219. showLoadingScreen(): Promise<string> | Promise<Template>;
  220. /**
  221. * Hide the loading screen
  222. */
  223. hideLoadingScreen(): Promise<string> | Promise<Template>;
  224. dispose(): void;
  225. protected _onConfigurationLoaded(configuration: ViewerConfiguration): void;
  226. }
  227. }
  228. declare module 'babylonjs-viewer/viewer/viewer' {
  229. import { Engine, ISceneLoaderPlugin, ISceneLoaderPluginAsync, Observable, Scene, SceneLoaderProgressEvent } from 'babylonjs';
  230. import { IModelConfiguration, IObserversConfiguration, ViewerConfiguration } from 'babylonjs-viewer/configuration';
  231. import { ConfigurationContainer } from 'babylonjs-viewer/configuration/configurationContainer';
  232. import { ConfigurationLoader } from 'babylonjs-viewer/configuration/loader';
  233. import { ModelLoader } from 'babylonjs-viewer/loader/modelLoader';
  234. import { ObservablesManager } from 'babylonjs-viewer/managers/observablesManager';
  235. import { SceneManager } from 'babylonjs-viewer/managers/sceneManager';
  236. import { ViewerModel } from 'babylonjs-viewer/model/viewerModel';
  237. import { TemplateManager } from 'babylonjs-viewer/templating/templateManager';
  238. /**
  239. * The AbstractViewer is the center of Babylon's viewer.
  240. * It is the basic implementation of the default viewer and is responsible of loading and showing the model and the templates
  241. */
  242. export abstract class AbstractViewer {
  243. containerElement: Element;
  244. /**
  245. * The corresponsing template manager of this viewer.
  246. */
  247. templateManager: TemplateManager;
  248. /**
  249. * Babylon Engine corresponding with this viewer
  250. */
  251. engine: Engine;
  252. /**
  253. * The ID of this viewer. it will be generated randomly or use the HTML Element's ID.
  254. */
  255. readonly baseId: string;
  256. /**
  257. * The last loader used to load a model.
  258. * @deprecated
  259. */
  260. lastUsedLoader: ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  261. /**
  262. * The ModelLoader instance connected with this viewer.
  263. */
  264. modelLoader: ModelLoader;
  265. /**
  266. * A flag that controls whether or not the render loop should be executed
  267. */
  268. runRenderLoop: boolean;
  269. /**
  270. * The scene manager connected with this viewer instance
  271. */
  272. sceneManager: SceneManager;
  273. /**
  274. * Will notify when the scene was initialized
  275. */
  276. readonly onSceneInitObservable: Observable<Scene>;
  277. /**
  278. * will notify when the engine was initialized
  279. */
  280. readonly onEngineInitObservable: Observable<Engine>;
  281. /**
  282. * Will notify when a new model was added to the scene.
  283. * Note that added does not neccessarily mean loaded!
  284. */
  285. readonly onModelAddedObservable: Observable<ViewerModel>;
  286. /**
  287. * will notify after every model load
  288. */
  289. readonly onModelLoadedObservable: Observable<ViewerModel>;
  290. /**
  291. * will notify when any model notify of progress
  292. */
  293. readonly onModelLoadProgressObservable: Observable<SceneLoaderProgressEvent>;
  294. /**
  295. * will notify when any model load failed.
  296. */
  297. readonly onModelLoadErrorObservable: Observable<{
  298. message: string;
  299. exception: any;
  300. }>;
  301. /**
  302. * Will notify when a model was removed from the scene;
  303. */
  304. readonly onModelRemovedObservable: Observable<ViewerModel>;
  305. /**
  306. * will notify when a new loader was initialized.
  307. * Used mainly to know when a model starts loading.
  308. */
  309. readonly onLoaderInitObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  310. /**
  311. * Observers registered here will be executed when the entire load process has finished.
  312. */
  313. readonly onInitDoneObservable: Observable<AbstractViewer>;
  314. /**
  315. * Functions added to this observable will be executed on each frame rendered.
  316. */
  317. readonly onFrameRenderedObservable: Observable<AbstractViewer>;
  318. /**
  319. * Observers registered here will be executed when VR more is entered.
  320. */
  321. readonly onEnteringVRObservable: Observable<AbstractViewer>;
  322. /**
  323. * Observers registered here will be executed when VR mode is exited.
  324. */
  325. readonly onExitingVRObservable: Observable<AbstractViewer>;
  326. observablesManager: ObservablesManager;
  327. /**
  328. * The canvas associated with this viewer
  329. */
  330. protected _canvas: HTMLCanvasElement;
  331. /**
  332. * The (single) canvas of this viewer
  333. */
  334. readonly canvas: HTMLCanvasElement;
  335. /**
  336. * is this viewer disposed?
  337. */
  338. protected _isDisposed: boolean;
  339. /**
  340. * registered onBeforeRender functions.
  341. * This functions are also registered at the native scene. The reference can be used to unregister them.
  342. */
  343. protected _registeredOnBeforeRenderFunctions: Array<() => void>;
  344. /**
  345. * The configuration loader of this viewer
  346. */
  347. protected _configurationLoader: ConfigurationLoader;
  348. /**
  349. * Is the viewer already initialized. for internal use.
  350. */
  351. protected _isInit: boolean;
  352. protected _configurationContainer: ConfigurationContainer;
  353. readonly configurationContainer: ConfigurationContainer;
  354. constructor(containerElement: Element, initialConfiguration?: ViewerConfiguration);
  355. /**
  356. * get the baseId of this viewer
  357. */
  358. getBaseId(): string;
  359. /**
  360. * Do we have a canvas to render on, and is it a part of the scene
  361. */
  362. isCanvasInDOM(): boolean;
  363. /**
  364. * Set the viewer's background rendering flag.
  365. */
  366. renderInBackground: boolean;
  367. /**
  368. * Get the configuration object. This is a reference only.
  369. * The configuration can ONLY be updated using the updateConfiguration function.
  370. * changing this object will have no direct effect on the scene.
  371. */
  372. readonly configuration: ViewerConfiguration;
  373. /**
  374. * force resizing the engine.
  375. */
  376. forceResize(): void;
  377. protected _hdToggled: boolean;
  378. toggleHD(): void;
  379. protected _vrToggled: boolean;
  380. protected _vrScale: number;
  381. protected _vrInit: boolean;
  382. toggleVR(): void;
  383. protected _initVR(): void;
  384. /**
  385. * The resize function that will be registered with the window object
  386. */
  387. protected _resize: () => void;
  388. protected _onConfigurationLoaded(configuration: ViewerConfiguration): void;
  389. /**
  390. * Force a single render loop execution.
  391. */
  392. forceRender(): void;
  393. /**
  394. * render loop that will be executed by the engine
  395. */
  396. protected _render: (force?: boolean) => void;
  397. /**
  398. * Takes a screenshot of the scene and returns it as a base64 encoded png.
  399. * @param callback optional callback that will be triggered when screenshot is done.
  400. * @param width Optional screenshot width (default to 512).
  401. * @param height Optional screenshot height (default to 512).
  402. * @returns a promise with the screenshot data
  403. */
  404. takeScreenshot(callback?: (data: string) => void, width?: number, height?: number): Promise<string>;
  405. /**
  406. * Update the current viewer configuration with new values.
  407. * Only provided information will be updated, old configuration values will be kept.
  408. * If this.configuration was manually changed, you can trigger this function with no parameters,
  409. * and the entire configuration will be updated.
  410. * @param newConfiguration the partial configuration to update or a URL to a JSON holding the updated configuration
  411. *
  412. */
  413. updateConfiguration(newConfiguration?: Partial<ViewerConfiguration> | string): void;
  414. /**
  415. * this is used to register native functions using the configuration object.
  416. * This will configure the observers.
  417. * @param observersConfiguration observers configuration
  418. */
  419. protected _configureObservers(observersConfiguration: IObserversConfiguration): void;
  420. /**
  421. * Dispose the entire viewer including the scene and the engine
  422. */
  423. dispose(): void;
  424. /**
  425. * This will prepare the container element for the viewer
  426. */
  427. protected abstract _prepareContainerElement(): any;
  428. /**
  429. * This function will execute when the HTML templates finished initializing.
  430. * It should initialize the engine and continue execution.
  431. *
  432. * @returns {Promise<AbstractViewer>} The viewer object will be returned after the object was loaded.
  433. */
  434. protected _onTemplatesLoaded(): Promise<AbstractViewer>;
  435. /**
  436. * This will force the creation of an engine and a scene.
  437. * It will also load a model if preconfigured.
  438. * But first - it will load the extendible onTemplateLoaded()!
  439. */
  440. protected _onTemplateLoaded(): Promise<AbstractViewer>;
  441. /**
  442. * Initialize the engine. Retruns a promise in case async calls are needed.
  443. *
  444. * @protected
  445. * @returns {Promise<Engine>}
  446. * @memberof Viewer
  447. */
  448. protected _initEngine(): Promise<Engine>;
  449. /**
  450. * Initialize a model loading. The returned object (a ViewerModel object) will be loaded in the background.
  451. * The difference between this and loadModel is that loadModel will fulfill the promise when the model finished loading.
  452. *
  453. * @param modelConfig model configuration to use when loading the model.
  454. * @param clearScene should the scene be cleared before loading this model
  455. * @returns a ViewerModel object that is not yet fully loaded.
  456. */
  457. initModel(modelConfig: string | File | IModelConfiguration, clearScene?: boolean): ViewerModel;
  458. /**
  459. * load a model using the provided configuration.
  460. * This function, as opposed to initModel, will return a promise that resolves when the model is loaded, and rejects with error.
  461. * If you want to attach to the observables of the model, use initModle instead.
  462. *
  463. * @param modelConfig the model configuration or URL to load.
  464. * @param clearScene Should the scene be cleared before loading the model
  465. * @returns a Promise the fulfills when the model finished loading successfully.
  466. */
  467. loadModel(modelConfig: string | File | IModelConfiguration, clearScene?: boolean): Promise<ViewerModel>;
  468. protected _initTelemetryEvents(): void;
  469. /**
  470. * Injects all the spectre shader in the babylon shader store
  471. */
  472. protected _injectCustomShaders(): void;
  473. }
  474. }
  475. declare module 'babylonjs-viewer/managers/telemetryManager' {
  476. import { Engine, Observable } from "babylonjs";
  477. /**
  478. * The data structure of a telemetry event.
  479. */
  480. export interface TelemetryData {
  481. event: string;
  482. session: string;
  483. date: Date;
  484. now: number;
  485. viewerId?: string;
  486. detail: any;
  487. }
  488. /**
  489. * Receives Telemetry events and raises events to the API
  490. */
  491. export class TelemetryManager {
  492. onEventBroadcastedObservable: Observable<TelemetryData>;
  493. /**
  494. * Receives a telemetry event
  495. * @param event The name of the Telemetry event
  496. * @param details An additional value, or an object containing a list of property/value pairs
  497. */
  498. readonly broadcast: (event: string, viewerId?: string | undefined, details?: any) => void;
  499. /**
  500. * Log a Telemetry event for errors raised on the WebGL context.
  501. * @param engine The Babylon engine with the WebGL context.
  502. */
  503. flushWebGLErrors(engine: Engine, viewerId?: string): void;
  504. /**
  505. * Enable or disable telemetry events
  506. * @param enabled Boolan, true if events are enabled
  507. */
  508. enable: boolean;
  509. /**
  510. * Returns the current session ID or creates one if it doesn't exixt
  511. * @return The current session ID
  512. */
  513. readonly session: string;
  514. /**
  515. * Disposes the telemetry manager
  516. */
  517. dispose(): void;
  518. }
  519. export const telemetryManager: TelemetryManager;
  520. }
  521. declare module 'babylonjs-viewer/loader/modelLoader' {
  522. import { ConfigurationContainer } from 'babylonjs-viewer/configuration/configurationContainer';
  523. import { IModelConfiguration } from 'babylonjs-viewer/configuration/interfaces/modelConfiguration';
  524. import { ObservablesManager } from 'babylonjs-viewer/managers/observablesManager';
  525. import { ViewerModel } from 'babylonjs-viewer/model/viewerModel';
  526. import { ILoaderPlugin } from 'babylonjs-viewer/loader/plugins';
  527. /**
  528. * An instance of the class is in charge of loading the model correctly.
  529. * This class will continously be expended with tasks required from the specific loaders Babylon has.
  530. *
  531. * A Model loader is unique per (Abstract)Viewer. It is being generated by the viewer
  532. */
  533. export class ModelLoader {
  534. readonly baseUrl: string;
  535. /**
  536. * Create a new Model loader
  537. * @param _viewer the viewer using this model loader
  538. */
  539. constructor(_observablesManager: ObservablesManager, _configurationContainer?: ConfigurationContainer | undefined);
  540. /**
  541. * Adds a new plugin to the loader process.
  542. *
  543. * @param plugin the plugin name or the plugin itself
  544. */
  545. addPlugin(plugin: ILoaderPlugin | string): void;
  546. /**
  547. * Load a model using predefined configuration
  548. * @param modelConfiguration the modelConfiguration to use to load the model
  549. */
  550. load(modelConfiguration: IModelConfiguration): ViewerModel;
  551. cancelLoad(model: ViewerModel): void;
  552. /**
  553. * dispose the model loader.
  554. * If loaders are registered and are in the middle of loading, they will be disposed and the request(s) will be cancelled.
  555. */
  556. dispose(): void;
  557. }
  558. }
  559. declare module 'babylonjs-viewer/model/viewerModel' {
  560. }
  561. declare module 'babylonjs-viewer/model/modelAnimation' {
  562. import { AnimationGroup, Vector3 } from 'babylonjs';
  563. /**
  564. * Animation play mode enum - is the animation looping or playing once
  565. */
  566. export const enum AnimationPlayMode {
  567. ONCE = 0,
  568. LOOP = 1
  569. }
  570. /**
  571. * An enum representing the current state of an animation object
  572. */
  573. export const enum AnimationState {
  574. INIT = 0,
  575. PLAYING = 1,
  576. PAUSED = 2,
  577. STOPPED = 3,
  578. ENDED = 4
  579. }
  580. /**
  581. * The different type of easing functions available
  582. */
  583. export const enum EasingFunction {
  584. Linear = 0,
  585. CircleEase = 1,
  586. BackEase = 2,
  587. BounceEase = 3,
  588. CubicEase = 4,
  589. ElasticEase = 5,
  590. ExponentialEase = 6,
  591. PowerEase = 7,
  592. QuadraticEase = 8,
  593. QuarticEase = 9,
  594. QuinticEase = 10,
  595. SineEase = 11
  596. }
  597. /**
  598. * Defines a simple animation to be applied to a model (scale).
  599. */
  600. export interface ModelAnimationConfiguration {
  601. /**
  602. * Time of animation, in seconds
  603. */
  604. time: number;
  605. /**
  606. * Scale to apply
  607. */
  608. scaling?: Vector3;
  609. /**
  610. * Easing function to apply
  611. * See SPECTRE.EasingFunction
  612. */
  613. easingFunction?: number;
  614. /**
  615. * An Easing mode to apply to the easing function
  616. * See BABYLON.EasingFunction
  617. */
  618. easingMode?: number;
  619. }
  620. /**
  621. * This interface can be implemented to define new types of ModelAnimation objects.
  622. */
  623. export interface IModelAnimation {
  624. /**
  625. * Current animation state (playing, stopped etc')
  626. */
  627. readonly state: AnimationState;
  628. /**
  629. * the name of the animation
  630. */
  631. readonly name: string;
  632. /**
  633. * Get the max numbers of frame available in the animation group
  634. *
  635. * In correlation to an arry, this would be ".length"
  636. */
  637. readonly frames: number;
  638. /**
  639. * Get the current frame playing right now.
  640. * This can be used to poll the frame currently playing (and, for exmaple, display a progress bar with the data)
  641. *
  642. * In correlation to an array, this would be the current index
  643. */
  644. readonly currentFrame: number;
  645. /**
  646. * Animation's FPS value
  647. */
  648. readonly fps: number;
  649. /**
  650. * Get or set the animation's speed ration (Frame-to-fps)
  651. */
  652. speedRatio: number;
  653. /**
  654. * Gets or sets the aimation's play mode.
  655. */
  656. playMode: AnimationPlayMode;
  657. /**
  658. * Start the animation
  659. */
  660. start(): any;
  661. /**
  662. * Stop the animation.
  663. * This will fail silently if the animation group is already stopped.
  664. */
  665. stop(): any;
  666. /**
  667. * Pause the animation
  668. * This will fail silently if the animation is not currently playing
  669. */
  670. pause(): any;
  671. /**
  672. * Reset this animation
  673. */
  674. reset(): any;
  675. /**
  676. * Restart the animation
  677. */
  678. restart(): any;
  679. /**
  680. * Go to a specific
  681. * @param frameNumber the frame number to go to
  682. */
  683. goToFrame(frameNumber: number): any;
  684. /**
  685. * Dispose this animation
  686. */
  687. dispose(): any;
  688. }
  689. /**
  690. * The GroupModelAnimation is an implementation of the IModelAnimation interface using BABYLON's
  691. * native GroupAnimation class.
  692. */
  693. export class GroupModelAnimation implements IModelAnimation {
  694. /**
  695. * Create a new GroupModelAnimation object using an AnimationGroup object
  696. * @param _animationGroup The aniamtion group to base the class on
  697. */
  698. constructor(_animationGroup: AnimationGroup);
  699. /**
  700. * Get the animation's name
  701. */
  702. readonly name: string;
  703. /**
  704. * Get the current animation's state
  705. */
  706. readonly state: AnimationState;
  707. /**
  708. * Sets the speed ratio to use for all animations
  709. */
  710. speedRatio: number;
  711. /**
  712. * Get the max numbers of frame available in the animation group
  713. *
  714. * In correlation to an arry, this would be ".length"
  715. */
  716. readonly frames: number;
  717. /**
  718. * Get the current frame playing right now.
  719. * This can be used to poll the frame currently playing (and, for exmaple, display a progress bar with the data)
  720. *
  721. * In correlation to an array, this would be the current index
  722. */
  723. readonly currentFrame: number;
  724. /**
  725. * Get the FPS value of this animation
  726. */
  727. readonly fps: number;
  728. /**
  729. * Set the play mode.
  730. * If the animation is played, it will continue playing at least once more, depending on the new play mode set.
  731. * If the animation is not set, the will be initialized and will wait for the user to start playing it.
  732. */
  733. playMode: AnimationPlayMode;
  734. /**
  735. * Reset the animation group
  736. */
  737. reset(): void;
  738. /**
  739. * Restart the animation group
  740. */
  741. restart(): void;
  742. /**
  743. *
  744. * @param frameNumber Go to a specific frame in the animation
  745. */
  746. goToFrame(frameNumber: number): void;
  747. /**
  748. * Start playing the animation.
  749. */
  750. start(): void;
  751. /**
  752. * Pause the animation
  753. */
  754. pause(): void;
  755. /**
  756. * Stop the animation.
  757. * This will fail silently if the animation group is already stopped.
  758. */
  759. stop(): void;
  760. /**
  761. * Dispose this animation object.
  762. */
  763. dispose(): void;
  764. }
  765. }
  766. declare module 'babylonjs-viewer/loader/plugins/loaderPlugin' {
  767. import { ViewerModel } from "babylonjs-viewer/model/viewerModel";
  768. import { IGLTFLoaderExtension, IGLTFLoaderData } from "babylonjs-loaders";
  769. import { AbstractMesh, ISceneLoaderPlugin, ISceneLoaderPluginAsync, SceneLoaderProgressEvent, BaseTexture, Material } from "babylonjs";
  770. /**
  771. * This interface defines the structure of a loader plugin.
  772. * Any of those functions will be called if (!) the loader supports those callbacks.
  773. * Any loader supports onInit, onLoaded, onError and onProgress.
  774. */
  775. export interface ILoaderPlugin {
  776. onInit?: (loader: ISceneLoaderPlugin | ISceneLoaderPluginAsync, model: ViewerModel) => void;
  777. onLoaded?: (model: ViewerModel) => void;
  778. onError?: (message: string, exception?: any) => void;
  779. onProgress?: (progressEvent: SceneLoaderProgressEvent) => void;
  780. onExtensionLoaded?: (extension: IGLTFLoaderExtension) => void;
  781. onParsed?: (parsedData: IGLTFLoaderData) => void;
  782. onMeshLoaded?: (mesh: AbstractMesh) => void;
  783. onTextureLoaded?: (texture: BaseTexture) => void;
  784. onMaterialLoaded?: (material: Material) => void;
  785. onComplete?: () => void;
  786. }
  787. }
  788. declare module 'babylonjs-viewer/templating/viewerTemplatePlugin' {
  789. import { EventCallback, Template } from "babylonjs-viewer/templating/templateManager";
  790. export interface IViewerTemplatePlugin {
  791. readonly templateName: string;
  792. readonly eventsToAttach?: Array<string>;
  793. interactionPredicate(event: EventCallback): boolean;
  794. onEvent?(event: EventCallback): void;
  795. addHTMLTemplate?(template: Template): void;
  796. }
  797. export abstract class AbstractViewerNavbarButton implements IViewerTemplatePlugin {
  798. readonly templateName: string;
  799. readonly eventsToAttach: Array<string>;
  800. protected _prepend: boolean;
  801. protected _buttonName: string;
  802. protected _buttonClass: string;
  803. protected _htmlTemplate: string;
  804. constructor(buttonName: string, buttonClass?: string, htmlTemplate?: string);
  805. interactionPredicate(event: EventCallback): boolean;
  806. abstract onEvent(event: EventCallback): void;
  807. addHTMLTemplate(template: Template): void;
  808. protected _generateHTMLElement(template: Template): Element | DocumentFragment;
  809. }
  810. }
  811. declare module 'babylonjs-viewer/optimizer/custom' {
  812. import { SceneManager } from "babylonjs-viewer/managers/sceneManager";
  813. /**
  814. *
  815. * @param name the name of the custom optimizer configuration
  816. * @param upgrade set to true if you want to upgrade optimizer and false if you want to degrade
  817. */
  818. export function getCustomOptimizerByName(name: string, upgrade?: boolean): (sceneManager: SceneManager) => boolean;
  819. export function registerCustomOptimizer(name: string, optimizer: (sceneManager: SceneManager) => boolean): void;
  820. }
  821. declare module 'babylonjs-viewer/initializer' {
  822. /**
  823. * Will attach an init function the the DOMContentLoaded event.
  824. * The init function will be removed automatically after the event was triggered.
  825. */
  826. export function initListeners(): void;
  827. /**
  828. * Select all HTML tags on the page that match the selector and initialize a viewer
  829. *
  830. * @param selector the selector to initialize the viewer on (default is 'babylon')
  831. */
  832. export function InitTags(selector?: string): void;
  833. }
  834. declare module 'babylonjs-viewer/configuration' {
  835. export * from 'babylonjs-viewer/configuration/configuration';
  836. export * from 'babylonjs-viewer/configuration/interfaces';
  837. }
  838. declare module 'babylonjs-viewer/configuration/configuration' {
  839. import { EngineOptions } from 'babylonjs';
  840. import { ICameraConfiguration, IDefaultRenderingPipelineConfiguration, IGroundConfiguration, ILightConfiguration, IModelConfiguration, IObserversConfiguration, ISceneConfiguration, ISceneOptimizerConfiguration, ISkyboxConfiguration, ITemplateConfiguration, IVRConfiguration } from 'babylonjs-viewer/configuration/interfaces';
  841. import { IEnvironmentMapConfiguration } from 'babylonjs-viewer/configuration/interfaces/environmentMapConfiguration';
  842. export function getConfigurationKey(key: string, configObject: any): any;
  843. export interface ViewerConfiguration {
  844. version?: string;
  845. extends?: string;
  846. pageUrl?: string;
  847. configuration?: string | {
  848. url?: string;
  849. payload?: any;
  850. mapper?: string;
  851. };
  852. observers?: IObserversConfiguration;
  853. canvasElement?: string;
  854. model?: IModelConfiguration | string;
  855. scene?: ISceneConfiguration;
  856. optimizer?: ISceneOptimizerConfiguration | boolean;
  857. camera?: ICameraConfiguration;
  858. skybox?: boolean | ISkyboxConfiguration;
  859. ground?: boolean | IGroundConfiguration;
  860. lights?: {
  861. [name: string]: number | boolean | ILightConfiguration;
  862. };
  863. engine?: {
  864. renderInBackground?: boolean;
  865. antialiasing?: boolean;
  866. disableResize?: boolean;
  867. engineOptions?: EngineOptions;
  868. adaptiveQuality?: boolean;
  869. hdEnabled?: boolean;
  870. };
  871. templates?: {
  872. main: ITemplateConfiguration;
  873. [key: string]: ITemplateConfiguration;
  874. };
  875. customShaders?: {
  876. shaders?: {
  877. [key: string]: string;
  878. };
  879. includes?: {
  880. [key: string]: string;
  881. };
  882. };
  883. loaderPlugins?: {
  884. extendedMaterial?: boolean;
  885. msftLod?: boolean;
  886. telemetry?: boolean;
  887. minecraft?: boolean;
  888. [propName: string]: boolean | undefined;
  889. };
  890. environmentMap?: IEnvironmentMapConfiguration;
  891. vr?: IVRConfiguration;
  892. lab?: {
  893. flashlight?: boolean | {
  894. exponent?: number;
  895. angle?: number;
  896. intensity?: number;
  897. diffuse?: {
  898. r: number;
  899. g: number;
  900. b: number;
  901. };
  902. specular?: {
  903. r: number;
  904. g: number;
  905. b: number;
  906. };
  907. };
  908. hideLoadingDelay?: number;
  909. /** Deprecated */
  910. assetsRootURL?: string;
  911. environmentMainColor?: {
  912. r: number;
  913. g: number;
  914. b: number;
  915. };
  916. /** Deprecated */
  917. environmentMap?: {
  918. /**
  919. * Environment map texture path in relative to the asset folder.
  920. */
  921. texture: string;
  922. /**
  923. * Default rotation to apply to the environment map.
  924. */
  925. rotationY: number;
  926. /**
  927. * Tint level of the main color on the environment map.
  928. */
  929. tintLevel: number;
  930. };
  931. defaultRenderingPipelines?: boolean | IDefaultRenderingPipelineConfiguration;
  932. globalLightRotation?: number;
  933. };
  934. }
  935. }
  936. declare module 'babylonjs-viewer/templating/templateManager' {
  937. import { Observable } from 'babylonjs';
  938. import { EventManager } from 'babylonjs-viewer/templating/eventManager';
  939. import { ITemplateConfiguration } from 'babylonjs-viewer/configuration/interfaces';
  940. /**
  941. * The object sent when an event is triggered
  942. */
  943. export interface EventCallback {
  944. event: Event;
  945. template: Template;
  946. selector: string;
  947. payload?: any;
  948. }
  949. /**
  950. * The template manager, a member of the viewer class, will manage the viewer's templates and generate the HTML.
  951. * The template manager managers a single viewer and can be seen as the collection of all sub-templates of the viewer.
  952. */
  953. export class TemplateManager {
  954. containerElement: Element;
  955. /**
  956. * Will be triggered when any template is initialized
  957. */
  958. onTemplateInit: Observable<Template>;
  959. /**
  960. * Will be triggered when any template is fully loaded
  961. */
  962. onTemplateLoaded: Observable<Template>;
  963. /**
  964. * Will be triggered when a template state changes
  965. */
  966. onTemplateStateChange: Observable<Template>;
  967. /**
  968. * Will be triggered when all templates finished loading
  969. */
  970. onAllLoaded: Observable<TemplateManager>;
  971. /**
  972. * Will be triggered when any event on any template is triggered.
  973. */
  974. onEventTriggered: Observable<EventCallback>;
  975. /**
  976. * This template manager's event manager. In charge of callback registrations to native event types
  977. */
  978. eventManager: EventManager;
  979. constructor(containerElement: Element);
  980. /**
  981. * Initialize the template(s) for the viewer. Called bay the Viewer class
  982. * @param templates the templates to be used to initialize the main template
  983. */
  984. initTemplate(templates: {
  985. [key: string]: ITemplateConfiguration;
  986. }): Promise<void>;
  987. /**
  988. * Get the canvas in the template tree.
  989. * There must be one and only one canvas inthe template.
  990. */
  991. getCanvas(): HTMLCanvasElement | null;
  992. /**
  993. * Get a specific template from the template tree
  994. * @param name the name of the template to load
  995. */
  996. getTemplate(name: string): Template | undefined;
  997. /**
  998. * Dispose the template manager
  999. */
  1000. dispose(): void;
  1001. }
  1002. /**
  1003. * This class represents a single template in the viewer's template tree.
  1004. * An example for a template is a single canvas, an overlay (containing sub-templates) or the navigation bar.
  1005. * A template is injected using the template manager in the correct position.
  1006. * The template is rendered using Handlebars and can use Handlebars' features (such as parameter injection)
  1007. *
  1008. * For further information please refer to the documentation page, https://doc.babylonjs.com
  1009. */
  1010. export class Template {
  1011. name: string;
  1012. /**
  1013. * Will be triggered when the template is loaded
  1014. */
  1015. onLoaded: Observable<Template>;
  1016. /**
  1017. * will be triggered when the template is appended to the tree
  1018. */
  1019. onAppended: Observable<Template>;
  1020. /**
  1021. * Will be triggered when the template's state changed (shown, hidden)
  1022. */
  1023. onStateChange: Observable<Template>;
  1024. /**
  1025. * Will be triggered when an event is triggered on ths template.
  1026. * The event is a native browser event (like mouse or pointer events)
  1027. */
  1028. onEventTriggered: Observable<EventCallback>;
  1029. onParamsUpdated: Observable<Template>;
  1030. onHTMLRendered: Observable<Template>;
  1031. /**
  1032. * is the template loaded?
  1033. */
  1034. isLoaded: boolean;
  1035. /**
  1036. * This is meant to be used to track the show and hide functions.
  1037. * This is NOT (!!) a flag to check if the element is actually visible to the user.
  1038. */
  1039. isShown: boolean;
  1040. /**
  1041. * Is this template a part of the HTML tree (the template manager injected it)
  1042. */
  1043. isInHtmlTree: boolean;
  1044. /**
  1045. * The HTML element containing this template
  1046. */
  1047. parent: HTMLElement;
  1048. /**
  1049. * A promise that is fulfilled when the template finished loading.
  1050. */
  1051. initPromise: Promise<Template>;
  1052. constructor(name: string, _configuration: ITemplateConfiguration);
  1053. /**
  1054. * Some templates have parameters (like background color for example).
  1055. * The parameters are provided to Handlebars which in turn generates the template.
  1056. * This function will update the template with the new parameters
  1057. *
  1058. * Note that when updating parameters the events will be registered again (after being cleared).
  1059. *
  1060. * @param params the new template parameters
  1061. */
  1062. updateParams(params: {
  1063. [key: string]: string | number | boolean | object;
  1064. }, append?: boolean): void;
  1065. redraw(): void;
  1066. /**
  1067. * Get the template'S configuration
  1068. */
  1069. readonly configuration: ITemplateConfiguration;
  1070. /**
  1071. * A template can be a parent element for other templates or HTML elements.
  1072. * This function will deliver all child HTML elements of this template.
  1073. */
  1074. getChildElements(): Array<string>;
  1075. /**
  1076. * Appending the template to a parent HTML element.
  1077. * If a parent is already set and you wish to replace the old HTML with new one, forceRemove should be true.
  1078. * @param parent the parent to which the template is added
  1079. * @param forceRemove if the parent already exists, shoud the template be removed from it?
  1080. */
  1081. appendTo(parent: HTMLElement, forceRemove?: boolean): void;
  1082. /**
  1083. * Show the template using the provided visibilityFunction, or natively using display: flex.
  1084. * The provided function returns a promise that should be fullfilled when the element is shown.
  1085. * Since it is a promise async operations are more than possible.
  1086. * See the default viewer for an opacity example.
  1087. * @param visibilityFunction The function to execute to show the template.
  1088. */
  1089. show(visibilityFunction?: (template: Template) => Promise<Template>): Promise<Template>;
  1090. /**
  1091. * Hide the template using the provided visibilityFunction, or natively using display: none.
  1092. * The provided function returns a promise that should be fullfilled when the element is hidden.
  1093. * Since it is a promise async operations are more than possible.
  1094. * See the default viewer for an opacity example.
  1095. * @param visibilityFunction The function to execute to show the template.
  1096. */
  1097. hide(visibilityFunction?: (template: Template) => Promise<Template>): Promise<Template>;
  1098. /**
  1099. * Dispose this template
  1100. */
  1101. dispose(): void;
  1102. }
  1103. }
  1104. declare module 'babylonjs-viewer/configuration/configurationContainer' {
  1105. import { ViewerConfiguration } from 'babylonjs-viewer/configuration/configuration';
  1106. import { Color3, Scene } from 'babylonjs';
  1107. export class ConfigurationContainer {
  1108. configuration: ViewerConfiguration;
  1109. viewerId: string;
  1110. mainColor: Color3;
  1111. reflectionColor: Color3;
  1112. scene?: Scene;
  1113. }
  1114. }
  1115. declare module 'babylonjs-viewer/configuration/loader' {
  1116. import { ViewerConfiguration } from 'babylonjs-viewer/configuration/configuration';
  1117. /**
  1118. * The configuration loader will load the configuration object from any source and will use the defined mapper to
  1119. * parse the object and return a conform ViewerConfiguration.
  1120. * It is a private member of the scene.
  1121. */
  1122. export class ConfigurationLoader {
  1123. constructor(_enableCache?: boolean);
  1124. /**
  1125. * load a configuration object that is defined in the initial configuration provided.
  1126. * The viewer configuration can extend different types of configuration objects and have an extra configuration defined.
  1127. *
  1128. * @param initConfig the initial configuration that has the definitions of further configuration to load.
  1129. * @param callback an optional callback that will be called sync, if noconfiguration needs to be loaded or configuration is payload-only
  1130. * @returns A promise that delivers the extended viewer configuration, when done.
  1131. */
  1132. loadConfiguration(initConfig?: ViewerConfiguration, callback?: (config: ViewerConfiguration) => void): Promise<ViewerConfiguration>;
  1133. /**
  1134. * Dispose the configuration loader. This will cancel file requests, if active.
  1135. */
  1136. dispose(): void;
  1137. }
  1138. }
  1139. declare module 'babylonjs-viewer/managers/observablesManager' {
  1140. import { Engine, ISceneLoaderPlugin, ISceneLoaderPluginAsync, Observable, Scene, SceneLoaderProgressEvent } from 'babylonjs';
  1141. import { ViewerModel } from 'babylonjs-viewer/model/viewerModel';
  1142. export class ObservablesManager {
  1143. /**
  1144. * Will notify when the scene was initialized
  1145. */
  1146. onSceneInitObservable: Observable<Scene>;
  1147. /**
  1148. * will notify when the engine was initialized
  1149. */
  1150. onEngineInitObservable: Observable<Engine>;
  1151. /**
  1152. * Will notify when a new model was added to the scene.
  1153. * Note that added does not neccessarily mean loaded!
  1154. */
  1155. onModelAddedObservable: Observable<ViewerModel>;
  1156. /**
  1157. * will notify after every model load
  1158. */
  1159. onModelLoadedObservable: Observable<ViewerModel>;
  1160. /**
  1161. * will notify when any model notify of progress
  1162. */
  1163. onModelLoadProgressObservable: Observable<SceneLoaderProgressEvent>;
  1164. /**
  1165. * will notify when any model load failed.
  1166. */
  1167. onModelLoadErrorObservable: Observable<{
  1168. message: string;
  1169. exception: any;
  1170. }>;
  1171. /**
  1172. * Will notify when a model was removed from the scene;
  1173. */
  1174. onModelRemovedObservable: Observable<ViewerModel>;
  1175. /**
  1176. * will notify when a new loader was initialized.
  1177. * Used mainly to know when a model starts loading.
  1178. */
  1179. onLoaderInitObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  1180. /**
  1181. * Observers registered here will be executed when the entire load process has finished.
  1182. */
  1183. onViewerInitDoneObservable: Observable<any>;
  1184. /**
  1185. * Will notify when the viewer init started (after configuration was loaded)
  1186. */
  1187. onViewerInitStartedObservable: Observable<any>;
  1188. /**
  1189. * Functions added to this observable will be executed on each frame rendered.
  1190. */
  1191. onFrameRenderedObservable: Observable<any>;
  1192. /**
  1193. * Will notify when VR mode is entered.
  1194. */
  1195. onEnteringVRObservable: Observable<any>;
  1196. /**
  1197. * Will notify when VR mode is exited.
  1198. */
  1199. onExitingVRObservable: Observable<any>;
  1200. constructor();
  1201. dispose(): void;
  1202. }
  1203. }
  1204. declare module 'babylonjs-viewer/managers/sceneManager' {
  1205. import { Scene, ArcRotateCamera, Engine, Light, SceneOptimizer, EnvironmentHelper, Color3, Observable, DefaultRenderingPipeline, Nullable, VRExperienceHelper } from 'babylonjs';
  1206. import { ILightConfiguration, ISceneConfiguration, ISceneOptimizerConfiguration, ICameraConfiguration, ISkyboxConfiguration, ViewerConfiguration, IGroundConfiguration, IModelConfiguration, IVRConfiguration } from 'babylonjs-viewer/configuration';
  1207. import { ViewerModel } from 'babylonjs-viewer/model/viewerModel';
  1208. import { ViewerLabs } from 'babylonjs-viewer/labs/viewerLabs';
  1209. import { ObservablesManager } from 'babylonjs-viewer/managers/observablesManager';
  1210. import { ConfigurationContainer } from 'babylonjs-viewer/configuration/configurationContainer';
  1211. import { IEnvironmentMapConfiguration } from 'babylonjs-viewer/configuration/interfaces/environmentMapConfiguration';
  1212. /**
  1213. * This interface describes the structure of the variable sent with the configuration observables of the scene manager.
  1214. * O - the type of object we are dealing with (Light, ArcRotateCamera, Scene, etc')
  1215. * T - the configuration type
  1216. */
  1217. export interface IPostConfigurationCallback<OBJ, CONF> {
  1218. newConfiguration: CONF;
  1219. sceneManager: SceneManager;
  1220. object: OBJ;
  1221. model?: ViewerModel;
  1222. }
  1223. export class SceneManager {
  1224. /**
  1225. * Will notify when the scene was initialized
  1226. */
  1227. onSceneInitObservable: Observable<Scene>;
  1228. /**
  1229. * Will notify after the scene was configured. Can be used to further configure the scene
  1230. */
  1231. onSceneConfiguredObservable: Observable<IPostConfigurationCallback<Scene, ISceneConfiguration>>;
  1232. /**
  1233. * Will notify after the scene optimized was configured. Can be used to further configure the scene optimizer
  1234. */
  1235. onSceneOptimizerConfiguredObservable: Observable<IPostConfigurationCallback<SceneOptimizer, ISceneOptimizerConfiguration | boolean>>;
  1236. /**
  1237. * Will notify after the camera was configured. Can be used to further configure the camera
  1238. */
  1239. onCameraConfiguredObservable: Observable<IPostConfigurationCallback<ArcRotateCamera, ICameraConfiguration>>;
  1240. /**
  1241. * Will notify after the lights were configured. Can be used to further configure lights
  1242. */
  1243. onLightsConfiguredObservable: Observable<IPostConfigurationCallback<Array<Light>, {
  1244. [name: string]: ILightConfiguration | boolean | number;
  1245. }>>;
  1246. /**
  1247. * Will notify after the model(s) were configured. Can be used to further configure models
  1248. */
  1249. onModelsConfiguredObservable: Observable<IPostConfigurationCallback<Array<ViewerModel>, IModelConfiguration>>;
  1250. /**
  1251. * Will notify after the envirnoment was configured. Can be used to further configure the environment
  1252. */
  1253. onEnvironmentConfiguredObservable: Observable<IPostConfigurationCallback<EnvironmentHelper, {
  1254. skybox?: ISkyboxConfiguration | boolean;
  1255. ground?: IGroundConfiguration | boolean;
  1256. }>>;
  1257. /**
  1258. * Will notify after the model(s) were configured. Can be used to further configure models
  1259. */
  1260. onVRConfiguredObservable: Observable<IPostConfigurationCallback<VRExperienceHelper, IVRConfiguration>>;
  1261. /**
  1262. * The Babylon Scene of this viewer
  1263. */
  1264. scene: Scene;
  1265. /**
  1266. * The camera used in this viewer
  1267. */
  1268. camera: ArcRotateCamera;
  1269. /**
  1270. * Babylon's scene optimizer
  1271. */
  1272. sceneOptimizer: SceneOptimizer;
  1273. /**
  1274. * Models displayed in this viewer.
  1275. */
  1276. models: Array<ViewerModel>;
  1277. /**
  1278. * Babylon's environment helper of this viewer
  1279. */
  1280. environmentHelper?: EnvironmentHelper;
  1281. protected _defaultHighpTextureType: number;
  1282. protected _shadowGeneratorBias: number;
  1283. protected _defaultPipelineTextureType: number;
  1284. /**
  1285. * The maximum number of shadows supported by the curent viewer
  1286. */
  1287. protected _maxShadows: number;
  1288. /**
  1289. * The labs variable consists of objects that will have their API change.
  1290. * Please be careful when using labs in production.
  1291. */
  1292. labs: ViewerLabs;
  1293. readonly defaultRenderingPipeline: Nullable<DefaultRenderingPipeline>;
  1294. protected _vrHelper?: VRExperienceHelper;
  1295. readonly vrHelper: VRExperienceHelper | undefined;
  1296. constructor(_engine: Engine, _configurationContainer: ConfigurationContainer, _observablesManager?: ObservablesManager | undefined);
  1297. /**
  1298. * Returns a boolean representing HDR support
  1299. */
  1300. readonly isHdrSupported: boolean;
  1301. /**
  1302. * Return the main color defined in the configuration.
  1303. */
  1304. readonly mainColor: Color3;
  1305. readonly reflectionColor: Color3;
  1306. animationBlendingEnabled: boolean;
  1307. readonly observablesManager: ObservablesManager | undefined;
  1308. /**
  1309. * Should shadows be rendered every frame, or only once and stop.
  1310. * This can be used to optimize a scene.
  1311. *
  1312. * Not that the shadows will NOT disapear but will remain in place.
  1313. * @param process if true shadows will be updated once every frame. if false they will stop being updated.
  1314. */
  1315. processShadows: boolean;
  1316. groundEnabled: boolean;
  1317. /**
  1318. * sets wether the reflection is disabled.
  1319. */
  1320. groundMirrorEnabled: boolean;
  1321. defaultRenderingPipelineEnabled: boolean;
  1322. /**
  1323. * Sets the engine flags to unlock all babylon features.
  1324. * Can also be configured using the scene.flags configuration object
  1325. */
  1326. unlockBabylonFeatures(): void;
  1327. /**
  1328. * initialize the scene. Calling this function again will dispose the old scene, if exists.
  1329. */
  1330. initScene(sceneConfiguration?: ISceneConfiguration, optimizerConfiguration?: boolean | ISceneOptimizerConfiguration): Promise<Scene>;
  1331. clearScene(clearModels?: boolean, clearLights?: boolean): void;
  1332. /**
  1333. * This will update the scene's configuration, including camera, lights, environment.
  1334. * @param newConfiguration the delta that should be configured. This includes only the changes
  1335. * @param globalConfiguration The global configuration object, after the new configuration was merged into it
  1336. */
  1337. updateConfiguration(newConfiguration: Partial<ViewerConfiguration>): void;
  1338. bloomEnabled: boolean;
  1339. fxaaEnabled: boolean;
  1340. /**
  1341. * internally configure the scene using the provided configuration.
  1342. * The scene will not be recreated, but just updated.
  1343. * @param sceneConfig the (new) scene configuration
  1344. */
  1345. protected _configureScene(sceneConfig: ISceneConfiguration): void;
  1346. /**
  1347. * Configure the scene optimizer.
  1348. * The existing scene optimizer will be disposed and a new one will be created.
  1349. * @param optimizerConfig the (new) optimizer configuration
  1350. */
  1351. protected _configureOptimizer(optimizerConfig: ISceneOptimizerConfiguration | boolean): void;
  1352. /**
  1353. * configure all models using the configuration.
  1354. * @param modelConfiguration the configuration to use to reconfigure the models
  1355. */
  1356. protected _configureVR(vrConfig: IVRConfiguration): void;
  1357. protected _configureEnvironmentMap(environmentMapConfiguration: IEnvironmentMapConfiguration): any;
  1358. /**
  1359. * (Re) configure the camera. The camera will only be created once and from this point will only be reconfigured.
  1360. * @param cameraConfig the new camera configuration
  1361. * @param model optionally use the model to configure the camera.
  1362. */
  1363. protected _configureCamera(cameraConfig?: ICameraConfiguration): void;
  1364. protected _configureEnvironment(skyboxConifguration?: ISkyboxConfiguration | boolean, groundConfiguration?: IGroundConfiguration | boolean): void;
  1365. /**
  1366. * configure the lights.
  1367. *
  1368. * @param lightsConfiguration the (new) light(s) configuration
  1369. * @param model optionally use the model to configure the camera.
  1370. */
  1371. protected _configureLights(lightsConfiguration?: {
  1372. [name: string]: ILightConfiguration | boolean | number;
  1373. }): void;
  1374. /**
  1375. * Gets the shadow map blur kernel according to the light configuration.
  1376. * @param light The light used to generate the shadows
  1377. * @param bufferSize The size of the shadow map
  1378. * @return the kernel blur size
  1379. */
  1380. getBlurKernel(light: BABYLON.IShadowLight, bufferSize: number): number;
  1381. /**
  1382. * Alters render settings to reduce features based on hardware feature limitations
  1383. * @param enableHDR Allows the viewer to run in HDR mode.
  1384. */
  1385. protected _handleHardwareLimitations(enableHDR?: boolean): void;
  1386. /**
  1387. * Dispoe the entire viewer including the scene and the engine
  1388. */
  1389. dispose(): void;
  1390. }
  1391. }
  1392. declare module 'babylonjs-viewer/configuration/interfaces/modelConfiguration' {
  1393. import { IModelAnimationConfiguration } from "babylonjs-viewer/configuration/interfaces/modelAnimationConfiguration";
  1394. export interface IModelConfiguration {
  1395. id?: string;
  1396. url?: string;
  1397. root?: string;
  1398. file?: string | File;
  1399. loader?: string;
  1400. position?: {
  1401. x: number;
  1402. y: number;
  1403. z: number;
  1404. };
  1405. rotation?: {
  1406. x: number;
  1407. y: number;
  1408. z: number;
  1409. w?: number;
  1410. };
  1411. scaling?: {
  1412. x: number;
  1413. y: number;
  1414. z: number;
  1415. };
  1416. parentObjectIndex?: number;
  1417. castShadow?: boolean;
  1418. receiveShadows?: boolean;
  1419. normalize?: boolean | {
  1420. center?: boolean;
  1421. unitSize?: boolean;
  1422. parentIndex?: number;
  1423. };
  1424. title?: string;
  1425. subtitle?: string;
  1426. thumbnail?: string;
  1427. animation?: {
  1428. autoStart?: boolean | string;
  1429. playOnce?: boolean;
  1430. autoStartIndex?: number;
  1431. };
  1432. entryAnimation?: IModelAnimationConfiguration;
  1433. exitAnimation?: IModelAnimationConfiguration;
  1434. material?: {
  1435. directEnabled?: boolean;
  1436. directIntensity?: number;
  1437. emissiveIntensity?: number;
  1438. environmentIntensity?: number;
  1439. [propName: string]: any;
  1440. };
  1441. /**
  1442. * Rotation offset axis definition
  1443. */
  1444. rotationOffsetAxis?: {
  1445. x: number;
  1446. y: number;
  1447. z: number;
  1448. };
  1449. /**
  1450. * the offset angle
  1451. */
  1452. rotationOffsetAngle?: number;
  1453. loaderConfiguration?: {
  1454. maxLODsToLoad?: number;
  1455. progressiveLoading?: boolean;
  1456. };
  1457. }
  1458. }
  1459. declare module 'babylonjs-viewer/loader/plugins' {
  1460. import { TelemetryLoaderPlugin } from "babylonjs-viewer/loader/plugins/telemetryLoaderPlugin";
  1461. import { ILoaderPlugin } from "babylonjs-viewer/loader/plugins/loaderPlugin";
  1462. import { MSFTLodLoaderPlugin } from 'babylonjs-viewer/loader/plugins/msftLodLoaderPlugin';
  1463. import { ApplyMaterialConfigPlugin } from 'babylonjs-viewer/loader/plugins/applyMaterialConfig';
  1464. import { ExtendedMaterialLoaderPlugin } from 'babylonjs-viewer/loader/plugins/extendedMaterialLoaderPlugin';
  1465. export { TelemetryLoaderPlugin, ILoaderPlugin, MSFTLodLoaderPlugin, ApplyMaterialConfigPlugin, ExtendedMaterialLoaderPlugin };
  1466. /**
  1467. * Get a loader plugin according to its name.
  1468. * The plugin will be cached and will be reused if called for again.
  1469. *
  1470. * @param name the name of the plugin
  1471. */
  1472. export function getLoaderPluginByName(name: string): ILoaderPlugin;
  1473. /**
  1474. *
  1475. */
  1476. export function addLoaderPlugin(name: string, plugin: ILoaderPlugin): void;
  1477. }
  1478. declare module 'babylonjs-viewer/configuration/interfaces' {
  1479. export * from 'babylonjs-viewer/configuration/interfaces/cameraConfiguration';
  1480. export * from 'babylonjs-viewer/configuration/interfaces/colorGradingConfiguration';
  1481. export * from 'babylonjs-viewer/configuration/interfaces/defaultRenderingPipelineConfiguration';
  1482. export * from 'babylonjs-viewer/configuration/interfaces/groundConfiguration';
  1483. export * from 'babylonjs-viewer/configuration/interfaces/imageProcessingConfiguration';
  1484. export * from 'babylonjs-viewer/configuration/interfaces/lightConfiguration';
  1485. export * from 'babylonjs-viewer/configuration/interfaces/modelAnimationConfiguration';
  1486. export * from 'babylonjs-viewer/configuration/interfaces/modelConfiguration';
  1487. export * from 'babylonjs-viewer/configuration/interfaces/observersConfiguration';
  1488. export * from 'babylonjs-viewer/configuration/interfaces/sceneConfiguration';
  1489. export * from 'babylonjs-viewer/configuration/interfaces/sceneOptimizerConfiguration';
  1490. export * from 'babylonjs-viewer/configuration/interfaces/skyboxConfiguration';
  1491. export * from 'babylonjs-viewer/configuration/interfaces/templateConfiguration';
  1492. export * from 'babylonjs-viewer/configuration/interfaces/vrConfiguration';
  1493. export * from 'babylonjs-viewer/configuration/interfaces/environmentMapConfiguration';
  1494. }
  1495. declare module 'babylonjs-viewer/configuration/interfaces/environmentMapConfiguration' {
  1496. export interface IEnvironmentMapConfiguration {
  1497. /**
  1498. * Environment map texture path in relative to the asset folder.
  1499. */
  1500. texture: string;
  1501. /**
  1502. * Default rotation to apply to the environment map.
  1503. */
  1504. rotationY: number;
  1505. /**
  1506. * Tint level of the main color on the environment map.
  1507. */
  1508. tintLevel: number;
  1509. /**
  1510. * The environment's main color.
  1511. */
  1512. mainColor?: {
  1513. r?: number;
  1514. g?: number;
  1515. b?: number;
  1516. };
  1517. }
  1518. }
  1519. declare module 'babylonjs-viewer/templating/eventManager' {
  1520. import { EventCallback, TemplateManager } from "babylonjs-viewer/templating/templateManager";
  1521. /**
  1522. * The EventManager is in charge of registering user interctions with the viewer.
  1523. * It is used in the TemplateManager
  1524. */
  1525. export class EventManager {
  1526. constructor(_templateManager: TemplateManager);
  1527. /**
  1528. * Register a new callback to a specific template.
  1529. * The best example for the usage can be found in the DefaultViewer
  1530. *
  1531. * @param templateName the templateName to register the event to
  1532. * @param callback The callback to be executed
  1533. * @param eventType the type of event to register
  1534. * @param selector an optional selector. if not defined the parent object in the template will be selected
  1535. */
  1536. registerCallback(templateName: string, callback: (eventData: EventCallback) => void, eventType?: string, selector?: string): void;
  1537. /**
  1538. * This will remove a registered event from the defined template.
  1539. * Each one of the variables apart from the template name are optional, but one must be provided.
  1540. *
  1541. * @param templateName the templateName
  1542. * @param callback the callback to remove (optional)
  1543. * @param eventType the event type to remove (optional)
  1544. * @param selector the selector from which to remove the event (optional)
  1545. */
  1546. unregisterCallback(templateName: string, callback: (eventData: EventCallback) => void, eventType?: string, selector?: string): void;
  1547. /**
  1548. * Dispose the event manager
  1549. */
  1550. dispose(): void;
  1551. }
  1552. }
  1553. declare module 'babylonjs-viewer/labs/viewerLabs' {
  1554. import { PBREnvironment } from "babylonjs-viewer/labs/environmentSerializer";
  1555. import { ShadowLight, Vector3, Scene } from 'babylonjs';
  1556. /**
  1557. * The ViewerLabs class will hold functions that are not (!) backwards compatible.
  1558. * The APIs in all labs-related classes and configuration might change.
  1559. * Once stable, lab features will be moved to the publis API and configuration object.
  1560. */
  1561. export class ViewerLabs {
  1562. constructor(_scene: Scene);
  1563. assetsRootURL: string;
  1564. environment: PBREnvironment;
  1565. /**
  1566. * Loads an environment map from a given URL
  1567. * @param url URL of environment map
  1568. * @param onSuccess Callback fired after environment successfully applied to the scene
  1569. * @param onProgress Callback fired at progress events while loading the environment map
  1570. * @param onError Callback fired when the load fails
  1571. */
  1572. loadEnvironment(url: string, onSuccess?: (env: PBREnvironment) => void, onProgress?: (bytesLoaded: number, bytesTotal: number) => void, onError?: (e: any) => void): void;
  1573. /**
  1574. * Loads an environment map from a given URL
  1575. * @param buffer ArrayBuffer containing environment map
  1576. * @param onSuccess Callback fired after environment successfully applied to the scene
  1577. * @param onProgress Callback fired at progress events while loading the environment map
  1578. * @param onError Callback fired when the load fails
  1579. */
  1580. loadEnvironment(buffer: ArrayBuffer, onSuccess?: (env: PBREnvironment) => void, onProgress?: (bytesLoaded: number, bytesTotal: number) => void, onError?: (e: any) => void): void;
  1581. /**
  1582. * Sets the environment to an already loaded environment
  1583. * @param env PBREnvironment instance
  1584. * @param onSuccess Callback fired after environment successfully applied to the scene
  1585. * @param onProgress Callback fired at progress events while loading the environment map
  1586. * @param onError Callback fired when the load fails
  1587. */
  1588. loadEnvironment(env: PBREnvironment, onSuccess?: (env: PBREnvironment) => void, onProgress?: (bytesLoaded: number, bytesTotal: number) => void, onError?: (e: any) => void): void;
  1589. /**
  1590. * Applies an `EnvironmentMapConfiguration` to the scene
  1591. * @param environmentMapConfiguration Environment map configuration to apply
  1592. */
  1593. applyEnvironmentMapConfiguration(rotationY?: number): void;
  1594. /**
  1595. * Get an environment asset url by using the configuration if the path is not absolute.
  1596. * @param url Asset url
  1597. * @returns The Asset url using the `environmentAssetsRootURL` if the url is not an absolute path.
  1598. */
  1599. getAssetUrl(url: string): string;
  1600. rotateShadowLight(shadowLight: ShadowLight, amount: number, point?: Vector3, axis?: Vector3, target?: Vector3): void;
  1601. }
  1602. }
  1603. declare module 'babylonjs-viewer/configuration/interfaces/modelAnimationConfiguration' {
  1604. /**
  1605. * Defines an animation to be applied to a model (translation, scale or rotation).
  1606. */
  1607. export interface IModelAnimationConfiguration {
  1608. /**
  1609. * Time of animation, in seconds
  1610. */
  1611. time?: number;
  1612. /**
  1613. * Scale to apply
  1614. */
  1615. scaling?: {
  1616. x: number;
  1617. y: number;
  1618. z: number;
  1619. };
  1620. /**
  1621. * Easing function to apply
  1622. */
  1623. easingFunction?: number;
  1624. /**
  1625. * An Easing mode to apply to the easing function
  1626. * See BABYLON.EasingFunction
  1627. */
  1628. easingMode?: number;
  1629. }
  1630. }
  1631. declare module 'babylonjs-viewer/loader/plugins/telemetryLoaderPlugin' {
  1632. import { ILoaderPlugin } from "babylonjs-viewer/loader/plugins/loaderPlugin";
  1633. import { ViewerModel } from "babylonjs-viewer/model/viewerModel";
  1634. import { ISceneLoaderPlugin, ISceneLoaderPluginAsync } from "babylonjs";
  1635. export class TelemetryLoaderPlugin implements ILoaderPlugin {
  1636. onInit(loader: ISceneLoaderPlugin | ISceneLoaderPluginAsync, model: ViewerModel): void;
  1637. onLoaded(model: ViewerModel): void;
  1638. onError(message: string, exception: any): void;
  1639. onComplete(): void;
  1640. }
  1641. }
  1642. declare module 'babylonjs-viewer/loader/plugins/msftLodLoaderPlugin' {
  1643. import { ISceneLoaderPlugin, ISceneLoaderPluginAsync } from 'babylonjs';
  1644. import { IGLTFLoaderExtension } from 'babylonjs-loaders';
  1645. import { ViewerModel } from 'babylonjs-viewer/model/viewerModel';
  1646. import { ILoaderPlugin } from 'babylonjs-viewer/loader/plugins/loaderPlugin';
  1647. /**
  1648. * A loder plugin to use MSFT_lod extension correctly (glTF)
  1649. */
  1650. export class MSFTLodLoaderPlugin implements ILoaderPlugin {
  1651. onInit(loader: ISceneLoaderPlugin | ISceneLoaderPluginAsync, model: ViewerModel): void;
  1652. onExtensionLoaded(extension: IGLTFLoaderExtension): void;
  1653. }
  1654. }
  1655. declare module 'babylonjs-viewer/loader/plugins/applyMaterialConfig' {
  1656. import { ISceneLoaderPlugin, ISceneLoaderPluginAsync, Material } from 'babylonjs';
  1657. import { ViewerModel } from 'babylonjs-viewer/model/viewerModel';
  1658. import { ILoaderPlugin } from 'babylonjs-viewer/loader/plugins/loaderPlugin';
  1659. /**
  1660. * Force-apply material configuration right after a material was loaded.
  1661. */
  1662. export class ApplyMaterialConfigPlugin implements ILoaderPlugin {
  1663. onInit(loader: ISceneLoaderPlugin | ISceneLoaderPluginAsync, model: ViewerModel): void;
  1664. onMaterialLoaded(material: Material): void;
  1665. }
  1666. }
  1667. declare module 'babylonjs-viewer/loader/plugins/extendedMaterialLoaderPlugin' {
  1668. import { Material } from 'babylonjs';
  1669. import { ILoaderPlugin } from 'babylonjs-viewer/loader/plugins/loaderPlugin';
  1670. /**
  1671. * A (PBR) material will be extended using this function.
  1672. * This function will hold extra default configuration for the viewer, if not implemented in Babylon itself.
  1673. */
  1674. export class ExtendedMaterialLoaderPlugin implements ILoaderPlugin {
  1675. onMaterialLoaded(baseMaterial: Material): void;
  1676. }
  1677. }
  1678. declare module 'babylonjs-viewer/configuration/interfaces/cameraConfiguration' {
  1679. export interface ICameraConfiguration {
  1680. position?: {
  1681. x: number;
  1682. y: number;
  1683. z: number;
  1684. };
  1685. rotation?: {
  1686. x: number;
  1687. y: number;
  1688. z: number;
  1689. w: number;
  1690. };
  1691. fov?: number;
  1692. fovMode?: number;
  1693. minZ?: number;
  1694. maxZ?: number;
  1695. inertia?: number;
  1696. exposure?: number;
  1697. pinchPrecision?: number;
  1698. behaviors?: {
  1699. [name: string]: boolean | number | ICameraBehaviorConfiguration;
  1700. };
  1701. disableCameraControl?: boolean;
  1702. disableCtrlForPanning?: boolean;
  1703. disableAutoFocus?: boolean;
  1704. [propName: string]: any;
  1705. }
  1706. export interface ICameraBehaviorConfiguration {
  1707. type: number;
  1708. [propName: string]: any;
  1709. }
  1710. }
  1711. declare module 'babylonjs-viewer/configuration/interfaces/colorGradingConfiguration' {
  1712. /**
  1713. * The Color Grading Configuration groups the different settings used to define the color grading used in the viewer.
  1714. */
  1715. export interface IColorGradingConfiguration {
  1716. /**
  1717. * Transform data string, encoded as determined by transformDataFormat.
  1718. */
  1719. transformData: string;
  1720. /**
  1721. * The encoding format of TransformData (currently only raw-base16 is supported).
  1722. */
  1723. transformDataFormat: string;
  1724. /**
  1725. * The weight of the transform
  1726. */
  1727. transformWeight: number;
  1728. /**
  1729. * Color curve colorFilterHueGlobal value
  1730. */
  1731. colorFilterHueGlobal: number;
  1732. /**
  1733. * Color curve colorFilterHueShadows value
  1734. */
  1735. colorFilterHueShadows: number;
  1736. /**
  1737. * Color curve colorFilterHueMidtones value
  1738. */
  1739. colorFilterHueMidtones: number;
  1740. /**
  1741. * Color curve colorFilterHueHighlights value
  1742. */
  1743. colorFilterHueHighlights: number;
  1744. /**
  1745. * Color curve colorFilterDensityGlobal value
  1746. */
  1747. colorFilterDensityGlobal: number;
  1748. /**
  1749. * Color curve colorFilterDensityShadows value
  1750. */
  1751. colorFilterDensityShadows: number;
  1752. /**
  1753. * Color curve colorFilterDensityMidtones value
  1754. */
  1755. colorFilterDensityMidtones: number;
  1756. /**
  1757. * Color curve colorFilterDensityHighlights value
  1758. */
  1759. colorFilterDensityHighlights: number;
  1760. /**
  1761. * Color curve saturationGlobal value
  1762. */
  1763. saturationGlobal: number;
  1764. /**
  1765. * Color curve saturationShadows value
  1766. */
  1767. saturationShadows: number;
  1768. /**
  1769. * Color curve saturationMidtones value
  1770. */
  1771. saturationMidtones: number;
  1772. /**
  1773. * Color curve saturationHighlights value
  1774. */
  1775. saturationHighlights: number;
  1776. /**
  1777. * Color curve exposureGlobal value
  1778. */
  1779. exposureGlobal: number;
  1780. /**
  1781. * Color curve exposureShadows value
  1782. */
  1783. exposureShadows: number;
  1784. /**
  1785. * Color curve exposureMidtones value
  1786. */
  1787. exposureMidtones: number;
  1788. /**
  1789. * Color curve exposureHighlights value
  1790. */
  1791. exposureHighlights: number;
  1792. }
  1793. }
  1794. declare module 'babylonjs-viewer/configuration/interfaces/defaultRenderingPipelineConfiguration' {
  1795. import { DepthOfFieldEffectBlurLevel } from 'babylonjs';
  1796. export interface IDefaultRenderingPipelineConfiguration {
  1797. sharpenEnabled?: boolean;
  1798. bloomEnabled?: boolean;
  1799. bloomThreshold?: number;
  1800. depthOfFieldEnabled?: boolean;
  1801. depthOfFieldBlurLevel?: DepthOfFieldEffectBlurLevel;
  1802. fxaaEnabled?: boolean;
  1803. imageProcessingEnabled?: boolean;
  1804. defaultPipelineTextureType?: number;
  1805. bloomScale?: number;
  1806. chromaticAberrationEnabled?: boolean;
  1807. grainEnabled?: boolean;
  1808. bloomKernel?: number;
  1809. hardwareScaleLevel?: number;
  1810. bloomWeight?: number;
  1811. hdr?: boolean;
  1812. samples?: number;
  1813. glowLayerEnabled?: boolean;
  1814. }
  1815. }
  1816. declare module 'babylonjs-viewer/configuration/interfaces/groundConfiguration' {
  1817. export interface IGroundConfiguration {
  1818. size?: number;
  1819. receiveShadows?: boolean;
  1820. shadowLevel?: number;
  1821. shadowOnly?: boolean;
  1822. mirror?: boolean | {
  1823. sizeRatio?: number;
  1824. blurKernel?: number;
  1825. amount?: number;
  1826. fresnelWeight?: number;
  1827. fallOffDistance?: number;
  1828. textureType?: number;
  1829. };
  1830. texture?: string;
  1831. color?: {
  1832. r: number;
  1833. g: number;
  1834. b: number;
  1835. };
  1836. opacity?: number;
  1837. material?: {
  1838. [propName: string]: any;
  1839. };
  1840. }
  1841. }
  1842. declare module 'babylonjs-viewer/configuration/interfaces/imageProcessingConfiguration' {
  1843. export interface IImageProcessingConfiguration {
  1844. colorGradingEnabled?: boolean;
  1845. colorCurvesEnabled?: boolean;
  1846. colorCurves?: {
  1847. globalHue?: number;
  1848. globalDensity?: number;
  1849. globalSaturation?: number;
  1850. globalExposure?: number;
  1851. highlightsHue?: number;
  1852. highlightsDensity?: number;
  1853. highlightsSaturation?: number;
  1854. highlightsExposure?: number;
  1855. midtonesHue?: number;
  1856. midtonesDensity?: number;
  1857. midtonesSaturation?: number;
  1858. midtonesExposure?: number;
  1859. shadowsHue?: number;
  1860. shadowsDensity?: number;
  1861. shadowsSaturation?: number;
  1862. shadowsExposure?: number;
  1863. };
  1864. colorGradingWithGreenDepth?: boolean;
  1865. colorGradingBGR?: boolean;
  1866. exposure?: number;
  1867. toneMappingEnabled?: boolean;
  1868. contrast?: number;
  1869. vignetteEnabled?: boolean;
  1870. vignetteStretch?: number;
  1871. vignetteCentreX?: number;
  1872. vignetteCentreY?: number;
  1873. vignetteWeight?: number;
  1874. vignetteColor?: {
  1875. r: number;
  1876. g: number;
  1877. b: number;
  1878. a?: number;
  1879. };
  1880. vignetteCameraFov?: number;
  1881. vignetteBlendMode?: number;
  1882. vignetteM?: boolean;
  1883. applyByPostProcess?: boolean;
  1884. isEnabled?: boolean;
  1885. }
  1886. }
  1887. declare module 'babylonjs-viewer/configuration/interfaces/lightConfiguration' {
  1888. export interface ILightConfiguration {
  1889. type: number;
  1890. name?: string;
  1891. disabled?: boolean;
  1892. position?: {
  1893. x: number;
  1894. y: number;
  1895. z: number;
  1896. };
  1897. target?: {
  1898. x: number;
  1899. y: number;
  1900. z: number;
  1901. };
  1902. direction?: {
  1903. x: number;
  1904. y: number;
  1905. z: number;
  1906. };
  1907. diffuse?: {
  1908. r: number;
  1909. g: number;
  1910. b: number;
  1911. };
  1912. specular?: {
  1913. r: number;
  1914. g: number;
  1915. b: number;
  1916. };
  1917. intensity?: number;
  1918. intensityMode?: number;
  1919. radius?: number;
  1920. shadownEnabled?: boolean;
  1921. shadowConfig?: {
  1922. useBlurExponentialShadowMap?: boolean;
  1923. useBlurCloseExponentialShadowMap?: boolean;
  1924. useKernelBlur?: boolean;
  1925. blurKernel?: number;
  1926. blurScale?: number;
  1927. minZ?: number;
  1928. maxZ?: number;
  1929. frustumSize?: number;
  1930. angleScale?: number;
  1931. frustumEdgeFalloff?: number;
  1932. [propName: string]: any;
  1933. };
  1934. spotAngle?: number;
  1935. shadowFieldOfView?: number;
  1936. shadowBufferSize?: number;
  1937. shadowFrustumSize?: number;
  1938. shadowMinZ?: number;
  1939. shadowMaxZ?: number;
  1940. [propName: string]: any;
  1941. behaviors?: {
  1942. [name: string]: number | {
  1943. type: number;
  1944. [propName: string]: any;
  1945. };
  1946. };
  1947. }
  1948. }
  1949. declare module 'babylonjs-viewer/configuration/interfaces/observersConfiguration' {
  1950. export interface IObserversConfiguration {
  1951. onEngineInit?: string;
  1952. onSceneInit?: string;
  1953. onModelLoaded?: string;
  1954. }
  1955. }
  1956. declare module 'babylonjs-viewer/configuration/interfaces/sceneConfiguration' {
  1957. import { IImageProcessingConfiguration } from "babylonjs-viewer/configuration/interfaces/imageProcessingConfiguration";
  1958. import { IColorGradingConfiguration } from "babylonjs-viewer/configuration/interfaces/colorGradingConfiguration";
  1959. import { IGlowLayerOptions } from "babylonjs";
  1960. export interface ISceneConfiguration {
  1961. debug?: boolean;
  1962. clearColor?: {
  1963. r: number;
  1964. g: number;
  1965. b: number;
  1966. a: number;
  1967. };
  1968. /** Deprecated, use environmentMap.mainColor instead. */
  1969. mainColor?: {
  1970. r?: number;
  1971. g?: number;
  1972. b?: number;
  1973. };
  1974. imageProcessingConfiguration?: IImageProcessingConfiguration;
  1975. environmentTexture?: string;
  1976. colorGrading?: IColorGradingConfiguration;
  1977. environmentRotationY?: number;
  1978. /**
  1979. * Deprecated, please use default rendering pipeline
  1980. */
  1981. glow?: boolean | IGlowLayerOptions;
  1982. disableHdr?: boolean;
  1983. renderInBackground?: boolean;
  1984. disableCameraControl?: boolean;
  1985. animationPropertiesOverride?: {
  1986. [propName: string]: any;
  1987. };
  1988. defaultMaterial?: {
  1989. materialType: "standard" | "pbr";
  1990. [propName: string]: any;
  1991. };
  1992. flags?: {
  1993. shadowsEnabled?: boolean;
  1994. particlesEnabled?: boolean;
  1995. collisionsEnabled?: boolean;
  1996. lightsEnabled?: boolean;
  1997. texturesEnabled?: boolean;
  1998. lensFlaresEnabled?: boolean;
  1999. proceduralTexturesEnabled?: boolean;
  2000. renderTargetsEnabled?: boolean;
  2001. spritesEnabled?: boolean;
  2002. skeletonsEnabled?: boolean;
  2003. audioEnabled?: boolean;
  2004. };
  2005. assetsRootURL?: string;
  2006. }
  2007. }
  2008. declare module 'babylonjs-viewer/configuration/interfaces/sceneOptimizerConfiguration' {
  2009. export interface ISceneOptimizerConfiguration {
  2010. targetFrameRate?: number;
  2011. trackerDuration?: number;
  2012. autoGeneratePriorities?: boolean;
  2013. improvementMode?: boolean;
  2014. degradation?: string;
  2015. types?: {
  2016. texture?: ISceneOptimizerParameters;
  2017. hardwareScaling?: ISceneOptimizerParameters;
  2018. shadow?: ISceneOptimizerParameters;
  2019. postProcess?: ISceneOptimizerParameters;
  2020. lensFlare?: ISceneOptimizerParameters;
  2021. particles?: ISceneOptimizerParameters;
  2022. renderTarget?: ISceneOptimizerParameters;
  2023. mergeMeshes?: ISceneOptimizerParameters;
  2024. };
  2025. custom?: string;
  2026. }
  2027. export interface ISceneOptimizerParameters {
  2028. priority?: number;
  2029. maximumSize?: number;
  2030. step?: number;
  2031. }
  2032. }
  2033. declare module 'babylonjs-viewer/configuration/interfaces/skyboxConfiguration' {
  2034. import { IImageProcessingConfiguration } from "babylonjs-viewer/configuration/interfaces/imageProcessingConfiguration";
  2035. export interface ISkyboxConfiguration {
  2036. cubeTexture?: {
  2037. noMipMap?: boolean;
  2038. gammaSpace?: boolean;
  2039. url?: string | Array<string>;
  2040. };
  2041. color?: {
  2042. r: number;
  2043. g: number;
  2044. b: number;
  2045. };
  2046. pbr?: boolean;
  2047. scale?: number;
  2048. blur?: number;
  2049. material?: {
  2050. imageProcessingConfiguration?: IImageProcessingConfiguration;
  2051. [propName: string]: any;
  2052. };
  2053. infiniteDistance?: boolean;
  2054. }
  2055. }
  2056. declare module 'babylonjs-viewer/configuration/interfaces/templateConfiguration' {
  2057. /**
  2058. * A single template configuration object
  2059. */
  2060. export interface ITemplateConfiguration {
  2061. /**
  2062. * can be either the id of the template's html element or a URL.
  2063. * See - http://doc.babylonjs.com/extensions/the_templating_system#location-vs-html
  2064. */
  2065. location?: string;
  2066. /**
  2067. * If no location is provided you can provide here the raw html of this template.
  2068. * See http://doc.babylonjs.com/extensions/the_templating_system#location-vs-html
  2069. */
  2070. html?: string;
  2071. id?: string;
  2072. /**
  2073. * Parameters that will be delivered to the template and will render it accordingly.
  2074. */
  2075. params?: {
  2076. [key: string]: string | number | boolean | object;
  2077. };
  2078. /**
  2079. * Events to attach to this template.
  2080. * event name is the key. the value can either be a boolean (attach to the parent element)
  2081. * or a map of html id elements.
  2082. *
  2083. * See - http://doc.babylonjs.com/extensions/the_templating_system#event-binding
  2084. */
  2085. events?: {
  2086. pointerdown?: boolean | {
  2087. [id: string]: boolean;
  2088. };
  2089. pointerup?: boolean | {
  2090. [id: string]: boolean;
  2091. };
  2092. pointermove?: boolean | {
  2093. [id: string]: boolean;
  2094. };
  2095. pointerover?: boolean | {
  2096. [id: string]: boolean;
  2097. };
  2098. pointerout?: boolean | {
  2099. [id: string]: boolean;
  2100. };
  2101. pointerenter?: boolean | {
  2102. [id: string]: boolean;
  2103. };
  2104. pointerleave?: boolean | {
  2105. [id: string]: boolean;
  2106. };
  2107. pointercancel?: boolean | {
  2108. [id: string]: boolean;
  2109. };
  2110. click?: boolean | {
  2111. [id: string]: boolean;
  2112. };
  2113. dragstart?: boolean | {
  2114. [id: string]: boolean;
  2115. };
  2116. drop?: boolean | {
  2117. [id: string]: boolean;
  2118. };
  2119. [key: string]: boolean | {
  2120. [id: string]: boolean;
  2121. } | undefined;
  2122. };
  2123. }
  2124. }
  2125. declare module 'babylonjs-viewer/configuration/interfaces/vrConfiguration' {
  2126. import { VRExperienceHelperOptions } from "babylonjs";
  2127. export interface IVRConfiguration {
  2128. disabled?: boolean;
  2129. objectScaleFactor?: number;
  2130. disableInteractions?: boolean;
  2131. disableTeleportation?: boolean;
  2132. overrideFloorMeshName?: string;
  2133. vrOptions?: VRExperienceHelperOptions;
  2134. modelHeightCorrection?: number | boolean;
  2135. rotateUsingControllers?: boolean;
  2136. cameraPosition?: {
  2137. x: number;
  2138. y: number;
  2139. z: number;
  2140. };
  2141. }
  2142. }
  2143. declare module 'babylonjs-viewer/labs/environmentSerializer' {
  2144. import { Vector3 } from "babylonjs";
  2145. import { TextureCube } from 'babylonjs-viewer/labs/texture';
  2146. /**
  2147. * Spherical polynomial coefficients (counter part to spherical harmonic coefficients used in shader irradiance calculation)
  2148. * @ignoreChildren
  2149. */
  2150. export interface SphericalPolynomalCoefficients {
  2151. x: Vector3;
  2152. y: Vector3;
  2153. z: Vector3;
  2154. xx: Vector3;
  2155. yy: Vector3;
  2156. zz: Vector3;
  2157. yz: Vector3;
  2158. zx: Vector3;
  2159. xy: Vector3;
  2160. }
  2161. /**
  2162. * Wraps data and maps required for environments with physically based rendering
  2163. */
  2164. export interface PBREnvironment {
  2165. /**
  2166. * Spherical Polynomial Coefficients representing an irradiance map
  2167. */
  2168. irradiancePolynomialCoefficients: SphericalPolynomalCoefficients;
  2169. /**
  2170. * Specular cubemap
  2171. */
  2172. specularTexture?: TextureCube;
  2173. /**
  2174. * A scale factor applied to RGB values after reading from environment maps
  2175. */
  2176. textureIntensityScale: number;
  2177. }
  2178. /**
  2179. * Environment map representations: layouts, projections and approximations
  2180. */
  2181. export type MapType = 'irradiance_sh_coefficients_9' | 'cubemap_faces';
  2182. /**
  2183. * Image type used for environment map
  2184. */
  2185. export type ImageType = 'png';
  2186. /**
  2187. * A generic field in JSON that report's its type
  2188. */
  2189. export interface TypedObject<T> {
  2190. type: T;
  2191. }
  2192. /**
  2193. * Describes a range of bytes starting at byte pos (inclusive) and finishing at byte pos + length - 1
  2194. */
  2195. export interface ByteRange {
  2196. pos: number;
  2197. length: number;
  2198. }
  2199. /**
  2200. * Complete Spectre Environment JSON Descriptor
  2201. */
  2202. export interface EnvJsonDescriptor {
  2203. radiance: TypedObject<MapType>;
  2204. irradiance: TypedObject<MapType>;
  2205. specular: TypedObject<MapType>;
  2206. }
  2207. /**
  2208. * Spherical harmonic coefficients to provide an irradiance map
  2209. */
  2210. export interface IrradianceSHCoefficients9 extends TypedObject<MapType> {
  2211. l00: Array<number>;
  2212. l1_1: Array<number>;
  2213. l10: Array<number>;
  2214. l11: Array<number>;
  2215. l2_2: Array<number>;
  2216. l2_1: Array<number>;
  2217. l20: Array<number>;
  2218. l21: Array<number>;
  2219. l22: Array<number>;
  2220. }
  2221. /**
  2222. * A generic set of images, where the image content is specified by byte ranges in the mipmaps field
  2223. */
  2224. export interface ImageSet<T> extends TypedObject<MapType> {
  2225. imageType: ImageType;
  2226. width: number;
  2227. height: number;
  2228. mipmaps: Array<T>;
  2229. multiplier: number;
  2230. }
  2231. /**
  2232. * A set of cubemap faces
  2233. */
  2234. export type CubemapFaces = ImageSet<Array<ByteRange>>;
  2235. /**
  2236. * A single image containing an atlas of equirectangular-projection maps across all mip levels
  2237. */
  2238. export type EquirectangularMipmapAtlas = ImageSet<ByteRange>;
  2239. /**
  2240. * A static class proving methods to aid parsing Spectre environment files
  2241. */
  2242. export class EnvironmentDeserializer {
  2243. /**
  2244. * Parses an arraybuffer into a new PBREnvironment object
  2245. * @param arrayBuffer The arraybuffer of the Spectre environment file
  2246. * @return a PBREnvironment object
  2247. */
  2248. static Parse(arrayBuffer: ArrayBuffer): PBREnvironment;
  2249. }
  2250. }
  2251. declare module 'babylonjs-viewer/labs/texture' {
  2252. import { Scene, CubeTexture, BaseTexture } from "babylonjs";
  2253. /**
  2254. * WebGL Pixel Formats
  2255. */
  2256. export const enum PixelFormat {
  2257. DEPTH_COMPONENT = 6402,
  2258. ALPHA = 6406,
  2259. RGB = 6407,
  2260. RGBA = 6408,
  2261. LUMINANCE = 6409,
  2262. LUMINANCE_ALPHA = 6410
  2263. }
  2264. /**
  2265. * WebGL Pixel Types
  2266. */
  2267. export const enum PixelType {
  2268. UNSIGNED_BYTE = 5121,
  2269. UNSIGNED_SHORT_4_4_4_4 = 32819,
  2270. UNSIGNED_SHORT_5_5_5_1 = 32820,
  2271. UNSIGNED_SHORT_5_6_5 = 33635
  2272. }
  2273. /**
  2274. * WebGL Texture Magnification Filter
  2275. */
  2276. export const enum TextureMagFilter {
  2277. NEAREST = 9728,
  2278. LINEAR = 9729
  2279. }
  2280. /**
  2281. * WebGL Texture Minification Filter
  2282. */
  2283. export const enum TextureMinFilter {
  2284. NEAREST = 9728,
  2285. LINEAR = 9729,
  2286. NEAREST_MIPMAP_NEAREST = 9984,
  2287. LINEAR_MIPMAP_NEAREST = 9985,
  2288. NEAREST_MIPMAP_LINEAR = 9986,
  2289. LINEAR_MIPMAP_LINEAR = 9987
  2290. }
  2291. /**
  2292. * WebGL Texture Wrap Modes
  2293. */
  2294. export const enum TextureWrapMode {
  2295. REPEAT = 10497,
  2296. CLAMP_TO_EDGE = 33071,
  2297. MIRRORED_REPEAT = 33648
  2298. }
  2299. /**
  2300. * Raw texture data and descriptor sufficient for WebGL texture upload
  2301. */
  2302. export interface TextureData {
  2303. /**
  2304. * Width of image
  2305. */
  2306. width: number;
  2307. /**
  2308. * Height of image
  2309. */
  2310. height: number;
  2311. /**
  2312. * Format of pixels in data
  2313. */
  2314. format: PixelFormat;
  2315. /**
  2316. * Row byte alignment of pixels in data
  2317. */
  2318. alignment: number;
  2319. /**
  2320. * Pixel data
  2321. */
  2322. data: ArrayBufferView;
  2323. }
  2324. /**
  2325. * Wraps sampling parameters for a WebGL texture
  2326. */
  2327. export interface SamplingParameters {
  2328. /**
  2329. * Magnification mode when upsampling from a WebGL texture
  2330. */
  2331. magFilter?: TextureMagFilter;
  2332. /**
  2333. * Minification mode when upsampling from a WebGL texture
  2334. */
  2335. minFilter?: TextureMinFilter;
  2336. /**
  2337. * X axis wrapping mode when sampling out of a WebGL texture bounds
  2338. */
  2339. wrapS?: TextureWrapMode;
  2340. /**
  2341. * Y axis wrapping mode when sampling out of a WebGL texture bounds
  2342. */
  2343. wrapT?: TextureWrapMode;
  2344. /**
  2345. * Anisotropic filtering samples
  2346. */
  2347. maxAnisotropy?: number;
  2348. }
  2349. /**
  2350. * Represents a valid WebGL texture source for use in texImage2D
  2351. */
  2352. export type TextureSource = TextureData | ImageData | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement;
  2353. /**
  2354. * A generic set of texture mipmaps (where index 0 has the largest dimension)
  2355. */
  2356. export type Mipmaps<T> = Array<T>;
  2357. /**
  2358. * A set of 6 cubemap arranged in the order [+x, -x, +y, -y, +z, -z]
  2359. */
  2360. export type Faces<T> = Array<T>;
  2361. /**
  2362. * A set of texture mipmaps specifically for 2D textures in WebGL (where index 0 has the largest dimension)
  2363. */
  2364. export type Mipmaps2D = Mipmaps<TextureSource>;
  2365. /**
  2366. * A set of texture mipmaps specifically for cubemap textures in WebGL (where index 0 has the largest dimension)
  2367. */
  2368. export type MipmapsCube = Mipmaps<Faces<TextureSource>>;
  2369. /**
  2370. * A minimal WebGL cubemap descriptor
  2371. */
  2372. export class TextureCube {
  2373. internalFormat: PixelFormat;
  2374. type: PixelType;
  2375. source: MipmapsCube;
  2376. /**
  2377. * Returns the width of a face of the texture or 0 if not available
  2378. */
  2379. readonly Width: number;
  2380. /**
  2381. * Returns the height of a face of the texture or 0 if not available
  2382. */
  2383. readonly Height: number;
  2384. /**
  2385. * constructor
  2386. * @param internalFormat WebGL pixel format for the texture on the GPU
  2387. * @param type WebGL pixel type of the supplied data and texture on the GPU
  2388. * @param source An array containing mipmap levels of faces, where each mipmap level is an array of faces and each face is a TextureSource object
  2389. */
  2390. constructor(internalFormat: PixelFormat, type: PixelType, source?: MipmapsCube);
  2391. }
  2392. /**
  2393. * A static class providing methods to aid working with Bablyon textures.
  2394. */
  2395. export class TextureUtils {
  2396. /**
  2397. * A prefix used when storing a babylon texture object reference on a Spectre texture object
  2398. */
  2399. static BabylonTextureKeyPrefix: string;
  2400. /**
  2401. * Controls anisotropic filtering for deserialized textures.
  2402. */
  2403. static MaxAnisotropy: number;
  2404. /**
  2405. * Returns a BabylonCubeTexture instance from a Spectre texture cube, subject to sampling parameters.
  2406. * If such a texture has already been requested in the past, this texture will be returned, otherwise a new one will be created.
  2407. * The advantage of this is to enable working with texture objects without the need to initialize on the GPU until desired.
  2408. * @param scene A Babylon Scene instance
  2409. * @param textureCube A Spectre TextureCube object
  2410. * @param parameters WebGL texture sampling parameters
  2411. * @param automaticMipmaps Pass true to enable automatic mipmap generation where possible (requires power of images)
  2412. * @param environment Specifies that the texture will be used as an environment
  2413. * @param singleLod Specifies that the texture will be a singleLod (for environment)
  2414. * @return Babylon cube texture
  2415. */
  2416. static GetBabylonCubeTexture(scene: Scene, textureCube: TextureCube, automaticMipmaps: boolean, environment?: boolean, singleLod?: boolean): CubeTexture;
  2417. /**
  2418. * Applies Spectre SamplingParameters to a Babylon texture by directly setting texture parameters on the internal WebGLTexture as well as setting Babylon fields
  2419. * @param babylonTexture Babylon texture to apply texture to (requires the Babylon texture has an initialize _texture field)
  2420. * @param parameters Spectre SamplingParameters to apply
  2421. */
  2422. static ApplySamplingParameters(babylonTexture: BaseTexture, parameters: SamplingParameters): void;
  2423. /**
  2424. * Environment preprocessing dedicated value (Internal Use or Advanced only).
  2425. */
  2426. static EnvironmentLODScale: number;
  2427. /**
  2428. * Environment preprocessing dedicated value (Internal Use or Advanced only)..
  2429. */
  2430. static EnvironmentLODOffset: number;
  2431. }
  2432. }