babylon.viewer.module.d.ts 112 KB

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