babylon.viewer.module.d.ts 106 KB

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