babylon.viewer.module.d.ts 118 KB

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