babylon.viewer.module.d.ts 111 KB

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