babylon.viewer.module.d.ts 118 KB

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