babylon.viewer.d.ts 101 KB

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