babylon.viewer.module.d.ts 108 KB

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