babylon.viewer.module.d.ts 112 KB

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