123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262 |
- /// <reference path="./babylon.d.ts"/>
- /// <reference path="./babylon.glTF2Interface.d.ts"/>
- /// <reference path="./babylonjs.loaders.d.ts"/>
- declare module "babylonjs-loaders"{ export=BABYLON;}
- // Generated by dts-bundle v0.7.3
- // Dependencies for this module:
- // ../../Tools/Gulp/babylonjs
- // ../../Tools/Gulp/babylonjs-loaders
- declare module 'babylonjs-viewer' {
- import { mapperManager } from 'babylonjs-viewer/configuration/mappers';
- import { viewerGlobals } from 'babylonjs-viewer/configuration/globals';
- import { viewerManager } from 'babylonjs-viewer/viewer/viewerManager';
- import { DefaultViewer } from 'babylonjs-viewer/viewer/defaultViewer';
- import { AbstractViewer } from 'babylonjs-viewer/viewer/viewer';
- import { telemetryManager } from 'babylonjs-viewer/telemetryManager';
- import { ModelLoader } from 'babylonjs-viewer/loader/modelLoader';
- import { ViewerModel, ModelState } from 'babylonjs-viewer/model/viewerModel';
- import { AnimationPlayMode, AnimationState } from 'babylonjs-viewer/model/modelAnimation';
- import { ILoaderPlugin } from 'babylonjs-viewer/loader/plugins/loaderPlugin';
- /**
- * BabylonJS Viewer
- *
- * An HTML-Based viewer for 3D models, based on BabylonJS and its extensions.
- */
- import * as BABYLON from 'babylonjs';
- import 'babylonjs-loaders';
- import 'pep';
- import { InitTags } from 'babylonjs-viewer/initializer';
- let disableInit: boolean;
- /**
- * Dispose all viewers currently registered
- */
- function disposeAll(): void;
- const Version: string;
- export { BABYLON, Version, InitTags, DefaultViewer, AbstractViewer, viewerGlobals, telemetryManager, disableInit, viewerManager, mapperManager, disposeAll, ModelLoader, ViewerModel, AnimationPlayMode, AnimationState, ModelState, ILoaderPlugin };
- }
- declare module 'babylonjs-viewer/configuration/mappers' {
- import { ViewerConfiguration } from 'babylonjs-viewer/configuration/configuration';
- /**
- * This is the mapper's interface. Implement this function to create your own mapper and register it at the mapper manager
- */
- export interface IMapper {
- map(rawSource: any): ViewerConfiguration;
- }
- /**
- * The MapperManager manages the different implemented mappers.
- * It allows the user to register new mappers as well and use them to parse their own configuration data
- */
- export class MapperManager {
- /**
- * The default mapper is the JSON mapper.
- */
- static DefaultMapper: string;
- constructor();
- /**
- * Get a specific configuration mapper.
- *
- * @param type the name of the mapper to load
- */
- getMapper(type: string): IMapper;
- /**
- * Use this functio to register your own configuration mapper.
- * After a mapper is registered, it can be used to parse the specific type fo configuration to the standard ViewerConfiguration.
- * @param type the name of the mapper. This will be used to define the configuration type and/or to get the mapper
- * @param mapper The implemented mapper
- */
- registerMapper(type: string, mapper: IMapper): void;
- /**
- * Dispose the mapper manager and all of its mappers.
- */
- dispose(): void;
- }
- /**
- * mapperManager is a singleton of the type MapperManager.
- * The mapperManager can be disposed directly with calling mapperManager.dispose()
- * or indirectly with using BabylonViewer.disposeAll()
- */
- export let mapperManager: MapperManager;
- }
- declare module 'babylonjs-viewer/configuration/globals' {
- export class ViewerGlobals {
- disableInit: boolean;
- disableWebGL2Support: boolean;
- }
- export let viewerGlobals: ViewerGlobals;
- }
- declare module 'babylonjs-viewer/viewer/viewerManager' {
- import { Observable } from 'babylonjs';
- import { AbstractViewer } from 'babylonjs-viewer/viewer/viewer';
- /**
- * The viewer manager is the container for all viewers currently registered on this page.
- * It is possible to have more than one viewer on a single page.
- */
- export class ViewerManager {
- /**
- * A callback that will be triggered when a new viewer was added
- */
- onViewerAdded: (viewer: AbstractViewer) => void;
- /**
- * Will notify when a new viewer was added
- */
- onViewerAddedObservable: Observable<AbstractViewer>;
- /**
- * Will notify when a viewer was removed (disposed)
- */
- onViewerRemovedObservable: Observable<string>;
- constructor();
- /**
- * Adding a new viewer to the viewer manager and start tracking it.
- * @param viewer the viewer to add
- */
- addViewer(viewer: AbstractViewer): void;
- /**
- * remove a viewer from the viewer manager
- * @param viewer the viewer to remove
- */
- removeViewer(viewer: AbstractViewer): void;
- /**
- * 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)
- * @param id the id of the HTMl element (or the viewer's, if none provided)
- */
- getViewerById(id: string): AbstractViewer;
- /**
- * Get a viewer using a container element
- * @param element the HTML element to search viewers associated with
- */
- getViewerByHTMLElement(element: HTMLElement): AbstractViewer | undefined;
- /**
- * Get a promise that will fullfil when this viewer was initialized.
- * Since viewer initialization and template injection is asynchronous, using the promise will guaranty that
- * you will get the viewer after everything was already configured.
- * @param id the viewer id to find
- */
- getViewerPromiseById(id: string): Promise<AbstractViewer>;
- /**
- * dispose the manager and all of its associated viewers
- */
- dispose(): void;
- }
- export let viewerManager: ViewerManager;
- }
- declare module 'babylonjs-viewer/viewer/defaultViewer' {
- import { ViewerConfiguration, IModelConfiguration } from 'babylonjs-viewer/configuration/configuration';
- import { Template } from 'babylonjs-viewer/templateManager';
- import { AbstractViewer } from 'babylonjs-viewer/viewer/viewer';
- import { ViewerModel } from 'babylonjs-viewer/model/viewerModel';
- /**
- * The Default viewer is the default implementation of the AbstractViewer.
- * It uses the templating system to render a new canvas and controls.
- */
- export class DefaultViewer extends AbstractViewer {
- containerElement: HTMLElement;
- /**
- * Create a new default viewer
- * @param containerElement the element in which the templates will be rendered
- * @param initialConfiguration the initial configuration. Defaults to extending the default configuration
- */
- constructor(containerElement: HTMLElement, initialConfiguration?: ViewerConfiguration);
- /**
- * This will be executed when the templates initialize.
- */
- protected _onTemplatesLoaded(): Promise<AbstractViewer>;
- /**
- * Toggle fullscreen of the entire viewer
- */
- toggleFullscreen: () => void;
- /**
- * Preparing the container element to present the viewer
- */
- protected _prepareContainerElement(): void;
- /**
- * This function will configure the templates and update them after a model was loaded
- * It is mainly responsible to changing the title and subtitle etc'.
- * @param model the model to be used to configure the templates by
- */
- protected _configureTemplate(model: ViewerModel): void;
- /**
- * This will load a new model to the default viewer
- * overriding the AbstractViewer's loadModel.
- * The scene will automatically be cleared of the old models, if exist.
- * @param model the configuration object (or URL) to load.
- */
- loadModel(model?: string | IModelConfiguration): Promise<ViewerModel>;
- /**
- * Show the overlay and the defined sub-screen.
- * Mainly used for help and errors
- * @param subScreen the name of the subScreen. Those can be defined in the configuration object
- */
- showOverlayScreen(subScreen: string): Promise<string> | Promise<Template>;
- /**
- * Hide the overlay screen.
- */
- hideOverlayScreen(): Promise<string> | Promise<Template>;
- /**
- * show the viewer (in case it was hidden)
- *
- * @param visibilityFunction an optional function to execute in order to show the container
- */
- show(visibilityFunction?: ((template: Template) => Promise<Template>)): Promise<Template>;
- /**
- * hide the viewer (in case it is visible)
- *
- * @param visibilityFunction an optional function to execute in order to hide the container
- */
- hide(visibilityFunction?: ((template: Template) => Promise<Template>)): Promise<Template>;
- /**
- * Show the loading screen.
- * The loading screen can be configured using the configuration object
- */
- showLoadingScreen(): Promise<string> | Promise<Template>;
- /**
- * Hide the loading screen
- */
- hideLoadingScreen(): Promise<string> | Promise<Template>;
- }
- }
- declare module 'babylonjs-viewer/viewer/viewer' {
- import { SceneManager } from 'babylonjs-viewer/viewer/sceneManager';
- import { TemplateManager } from 'babylonjs-viewer/templateManager';
- import { ConfigurationLoader } from 'babylonjs-viewer/configuration/loader';
- import { Observable, Engine, Scene, SceneLoaderProgressEvent, ISceneLoaderPlugin, ISceneLoaderPluginAsync } from 'babylonjs';
- import { ViewerConfiguration, IObserversConfiguration, IModelConfiguration } from 'babylonjs-viewer/configuration/configuration';
- import { ViewerModel } from 'babylonjs-viewer/model/viewerModel';
- import { ModelLoader } from 'babylonjs-viewer/loader/modelLoader';
- /**
- * The AbstractViewr is the center of Babylon's viewer.
- * It is the basic implementation of the default viewer and is responsible of loading and showing the model and the templates
- */
- export abstract class AbstractViewer {
- containerElement: HTMLElement;
- /**
- * The corresponsing template manager of this viewer.
- */
- templateManager: TemplateManager;
- /**
- * Babylon Engine corresponding with this viewer
- */
- engine: Engine;
- /**
- * The ID of this viewer. it will be generated randomly or use the HTML Element's ID.
- */
- readonly baseId: string;
- /**
- * The last loader used to load a model.
- * @deprecated
- */
- lastUsedLoader: ISceneLoaderPlugin | ISceneLoaderPluginAsync;
- /**
- * The ModelLoader instance connected with this viewer.
- */
- modelLoader: ModelLoader;
- /**
- * A flag that controls whether or not the render loop should be executed
- */
- runRenderLoop: boolean;
- /**
- * The scene manager connected with this viewer instance
- */
- sceneManager: SceneManager;
- /**
- * the viewer configuration object
- */
- protected _configuration: ViewerConfiguration;
- /**
- * Will notify when the scene was initialized
- */
- onSceneInitObservable: Observable<Scene>;
- /**
- * will notify when the engine was initialized
- */
- onEngineInitObservable: Observable<Engine>;
- /**
- * Will notify when a new model was added to the scene.
- * Note that added does not neccessarily mean loaded!
- */
- onModelAddedObservable: Observable<ViewerModel>;
- /**
- * will notify after every model load
- */
- onModelLoadedObservable: Observable<ViewerModel>;
- /**
- * will notify when any model notify of progress
- */
- onModelLoadProgressObservable: Observable<SceneLoaderProgressEvent>;
- /**
- * will notify when any model load failed.
- */
- onModelLoadErrorObservable: Observable<{
- message: string;
- exception: any;
- }>;
- /**
- * Will notify when a model was removed from the scene;
- */
- onModelRemovedObservable: Observable<ViewerModel>;
- /**
- * will notify when a new loader was initialized.
- * Used mainly to know when a model starts loading.
- */
- onLoaderInitObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
- /**
- * Observers registered here will be executed when the entire load process has finished.
- */
- onInitDoneObservable: Observable<AbstractViewer>;
- /**
- * Functions added to this observable will be executed on each frame rendered.
- */
- onFrameRenderedObservable: Observable<AbstractViewer>;
- /**
- * The canvas associated with this viewer
- */
- protected _canvas: HTMLCanvasElement;
- /**
- * The (single) canvas of this viewer
- */
- readonly canvas: HTMLCanvasElement;
- /**
- * is this viewer disposed?
- */
- protected _isDisposed: boolean;
- /**
- * registered onBeforeRender functions.
- * This functions are also registered at the native scene. The reference can be used to unregister them.
- */
- protected _registeredOnBeforeRenderFunctions: Array<() => void>;
- /**
- * The configuration loader of this viewer
- */
- protected _configurationLoader: ConfigurationLoader;
- protected _isInit: boolean;
- constructor(containerElement: HTMLElement, initialConfiguration?: ViewerConfiguration);
- /**
- * get the baseId of this viewer
- */
- getBaseId(): string;
- /**
- * Do we have a canvas to render on, and is it a part of the scene
- */
- isCanvasInDOM(): boolean;
- /**
- * Set the viewer's background rendering flag.
- */
- renderInBackground: boolean;
- /**
- * Get the configuration object. This is a reference only.
- * The configuration can ONLY be updated using the updateConfiguration function.
- * changing this object will have no direct effect on the scene.
- */
- readonly configuration: ViewerConfiguration;
- /**
- * force resizing the engine.
- */
- forceResize(): void;
- /**
- * The resize function that will be registered with the window object
- */
- protected _resize: () => void;
- /**
- * Force a single render loop execution.
- */
- forceRender(): void;
- /**
- * render loop that will be executed by the engine
- */
- protected _render: (force?: boolean) => void;
- /**
- * Takes a screenshot of the scene and returns it as a base64 encoded png.
- * @param callback optional callback that will be triggered when screenshot is done.
- * @param width Optional screenshot width (default to 512).
- * @param height Optional screenshot height (default to 512).
- * @returns a promise with the screenshot data
- */
- takeScreenshot(callback?: (data: string) => void, width?: number, height?: number): Promise<string>;
- /**
- * Update the current viewer configuration with new values.
- * Only provided information will be updated, old configuration values will be kept.
- * If this.configuration was manually changed, you can trigger this function with no parameters,
- * and the entire configuration will be updated.
- * @param newConfiguration
- */
- updateConfiguration(newConfiguration?: Partial<ViewerConfiguration>, mode?: ViewerModel): void;
- /**
- * this is used to register native functions using the configuration object.
- * This will configure the observers.
- * @param observersConfiguration observers configuration
- */
- protected _configureObservers(observersConfiguration: IObserversConfiguration): void;
- /**
- * Dispoe the entire viewer including the scene and the engine
- */
- dispose(): void;
- /**
- * This will prepare the container element for the viewer
- */
- protected abstract _prepareContainerElement(): any;
- /**
- * This function will execute when the HTML templates finished initializing.
- * It should initialize the engine and continue execution.
- *
- * @returns {Promise<AbstractViewer>} The viewer object will be returned after the object was loaded.
- */
- protected _onTemplatesLoaded(): Promise<AbstractViewer>;
- /**
- * Initialize the engine. Retruns a promise in case async calls are needed.
- *
- * @protected
- * @returns {Promise<Engine>}
- * @memberof Viewer
- */
- protected _initEngine(): Promise<Engine>;
- /**
- * Initialize a model loading. The returns object (a ViewerModel object) will be loaded in the background.
- * The difference between this and loadModel is that loadModel will fulfill the promise when the model finished loading.
- *
- * @param modelConfig model configuration to use when loading the model.
- * @param clearScene should the scene be cleared before loading this model
- * @returns a ViewerModel object that is not yet fully loaded.
- */
- initModel(modelConfig: string | IModelConfiguration, clearScene?: boolean): ViewerModel;
- /**
- * load a model using the provided configuration
- *
- * @param modelConfig the model configuration or URL to load.
- * @param clearScene Should the scene be cleared before loading the model
- * @returns a Promise the fulfills when the model finished loading successfully.
- */
- loadModel(modelConfig: string | IModelConfiguration, clearScene?: boolean): Promise<ViewerModel>;
- protected _initTelemetryEvents(): void;
- /**
- * Injects all the spectre shader in the babylon shader store
- */
- protected _injectCustomShaders(): void;
- }
- }
- declare module 'babylonjs-viewer/telemetryManager' {
- import { Observable } from "babylonjs";
- import { AbstractViewer } from "babylonjs-viewer/viewer/viewer";
- /**
- * The data structure of a telemetry event.
- */
- export interface TelemetryData {
- event: string;
- session: string;
- date: Date;
- now: number;
- viewer?: AbstractViewer;
- detail: any;
- }
- /**
- * Receives Telemetry events and raises events to the API
- */
- export class TelemetryManager {
- onEventBroadcastedObservable: Observable<TelemetryData>;
- /**
- * Receives a telemetry event
- * @param event The name of the Telemetry event
- * @param details An additional value, or an object containing a list of property/value pairs
- */
- readonly broadcast: (event: string, viewer: AbstractViewer, details?: any) => void;
- /**
- * Log a Telemetry event for errors raised on the WebGL context.
- * @param engine The Babylon engine with the WebGL context.
- */
- flushWebGLErrors(viewer: AbstractViewer): void;
- /**
- * Enable or disable telemetry events
- * @param enabled Boolan, true if events are enabled
- */
- enable: boolean;
- /**
- * Returns the current session ID or creates one if it doesn't exixt
- * @return The current session ID
- */
- readonly session: string;
- dispose(): void;
- }
- export const telemetryManager: TelemetryManager;
- }
- declare module 'babylonjs-viewer/loader/modelLoader' {
- import { AbstractViewer } from "babylonjs-viewer/viewer/viewer";
- import { IModelConfiguration } from "babylonjs-viewer/configuration/configuration";
- import { ViewerModel } from "babylonjs-viewer/model/viewerModel";
- import { ILoaderPlugin } from 'babylonjs-viewer/loader/plugins/loaderPlugin';
- /**
- * An instance of the class is in charge of loading the model correctly.
- * This class will continously be expended with tasks required from the specific loaders Babylon has.
- *
- * A Model loader is unique per (Abstract)Viewer. It is being generated by the viewer
- */
- export class ModelLoader {
- /**
- * Create a new Model loader
- * @param _viewer the viewer using this model loader
- */
- constructor(_viewer: AbstractViewer);
- addPlugin(plugin: ILoaderPlugin | string): void;
- /**
- * Load a model using predefined configuration
- * @param modelConfiguration the modelConfiguration to use to load the model
- */
- load(modelConfiguration: IModelConfiguration): ViewerModel;
- cancelLoad(model: ViewerModel): void;
- /**
- * dispose the model loader.
- * If loaders are registered and are in the middle of loading, they will be disposed and the request(s) will be cancelled.
- */
- dispose(): void;
- }
- }
- declare module 'babylonjs-viewer/model/viewerModel' {
- import { ISceneLoaderPlugin, ISceneLoaderPluginAsync, AnimationGroup, AbstractMesh, Observable, SceneLoaderProgressEvent, ParticleSystem, Skeleton, IDisposable, Nullable, Animation, Material } from "babylonjs";
- import { GLTF2 } from "babylonjs-loaders";
- import { IModelConfiguration } from "babylonjs-viewer/configuration/configuration";
- import { IModelAnimation } from "babylonjs-viewer/model/modelAnimation";
- import { AbstractViewer } from "babylonjs-viewer/";
- export enum ModelState {
- INIT = 0,
- LOADING = 1,
- LOADED = 2,
- ENTRY = 3,
- ENTRYDONE = 4,
- COMPLETE = 5,
- CANCELED = 6,
- ERROR = 7,
- }
- /**
- * The viewer model is a container for all assets representing a sngle loaded model.
- */
- export class ViewerModel implements IDisposable {
- protected _viewer: AbstractViewer;
- /**
- * The loader used to load this model.
- */
- loader: ISceneLoaderPlugin | ISceneLoaderPluginAsync;
- /**
- * This model's root mesh (the parent of all other meshes).
- * This mesh does not(!) exist in the meshes array.
- */
- rootMesh: AbstractMesh;
- /**
- * ParticleSystems connected to this model
- */
- particleSystems: Array<ParticleSystem>;
- /**
- * Skeletons defined in this model
- */
- skeletons: Array<Skeleton>;
- /**
- * The current model animation.
- * On init, this will be undefined.
- */
- currentAnimation: IModelAnimation;
- /**
- * Observers registered here will be executed when the model is done loading
- */
- onLoadedObservable: Observable<ViewerModel>;
- /**
- * Observers registered here will be executed when the loader notified of a progress event
- */
- onLoadProgressObservable: Observable<SceneLoaderProgressEvent>;
- /**
- * Observers registered here will be executed when the loader notified of an error.
- */
- onLoadErrorObservable: Observable<{
- message: string;
- exception: any;
- }>;
- /**
- * Will be executed after the model finished loading and complete, including entry animation and lod
- */
- onCompleteObservable: Observable<ViewerModel>;
- /**
- * Observers registered here will be executed every time the model is being configured.
- * This can be used to extend the model's configuration without extending the class itself
- */
- onAfterConfigure: Observable<ViewerModel>;
- /**
- * The current model state (loaded, error, etc)
- */
- state: ModelState;
- /**
- * A loadID provided by the modelLoader, unique to ths (Abstract)Viewer instance.
- */
- loadId: number;
- loadInfo: GLTF2.IAsset;
- constructor(_viewer: AbstractViewer, modelConfiguration: IModelConfiguration);
- /**
- * Set whether this model is enabled or not.
- */
- enabled: boolean;
- loaderDone: boolean;
- /**
- * Get the viewer showing this model
- */
- getViewer(): AbstractViewer;
- /**
- * Add a mesh to this model.
- * Any mesh that has no parent will be provided with the root mesh as its new parent.
- *
- * @param mesh the new mesh to add
- * @param triggerLoaded should this mesh trigger the onLoaded observable. Used when adding meshes manually.
- */
- addMesh(mesh: AbstractMesh, triggerLoaded?: boolean): Promise<ViewerModel> | undefined;
- /**
- * get the list of meshes (excluding the root mesh)
- */
- readonly meshes: AbstractMesh[];
- /**
- * (Re-)set the model's entire configuration
- * @param newConfiguration the new configuration to replace the new one
- */
- configuration: IModelConfiguration;
- /**
- * Update the current configuration with new values.
- * Configuration will not be overwritten, but merged with the new configuration.
- * Priority is to the new configuration
- * @param newConfiguration the configuration to be merged into the current configuration;
- */
- updateConfiguration(newConfiguration: Partial<IModelConfiguration>): void;
- /**
- * Add a new animation group to this model.
- * @param animationGroup the new animation group to be added
- */
- addAnimationGroup(animationGroup: AnimationGroup): void;
- /**
- * Get the ModelAnimation array
- */
- getAnimations(): Array<IModelAnimation>;
- /**
- * Get the animations' names. Using the names you can play a specific animation.
- */
- getAnimationNames(): Array<string>;
- /**
- * Get an animation by the provided name. Used mainly when playing n animation.
- * @param name the name of the animation to find
- */
- protected _getAnimationByName(name: string): Nullable<IModelAnimation>;
- /**
- * Choose an initialized animation using its name and start playing it
- * @param name the name of the animation to play
- * @returns The model aniamtion to be played.
- */
- playAnimation(name: string): IModelAnimation;
- setCurrentAnimationByName(name: string): IModelAnimation;
- /**
- * Apply a material configuration to a material
- * @param material Material to apply configuration to
- */
- _applyModelMaterialConfiguration(material: Material): void;
- /**
- * Begin @animations with the specified @easingFunction
- * @param animations The BABYLON Animations to begin
- * @param duration of transition, in seconds
- * @param easingFunction An easing function to apply
- * @param easingMode A easing mode to apply to the easingFunction
- * @param onAnimationEnd Call back trigger at the end of the animation.
- */
- transitionTo(animations: Animation[], duration: number, easingFunction: any, easingMode: number | undefined, onAnimationEnd: () => void): void;
- /**
- * Stops and removes all animations that have been applied to the model
- */
- stopAllAnimations(): void;
- /**
- * Will remove this model from the viewer (but NOT dispose it).
- */
- remove(): void;
- /**
- * Dispose this model, including all of its associated assets.
- */
- dispose(): void;
- }
- }
- declare module 'babylonjs-viewer/model/modelAnimation' {
- import { AnimationGroup, Vector3 } from "babylonjs";
- /**
- * Animation play mode enum - is the animation looping or playing once
- */
- export const enum AnimationPlayMode {
- ONCE = 0,
- LOOP = 1,
- }
- /**
- * An enum representing the current state of an animation object
- */
- export const enum AnimationState {
- INIT = 0,
- PLAYING = 1,
- PAUSED = 2,
- STOPPED = 3,
- ENDED = 4,
- }
- /**
- * The different type of easing functions available
- */
- export const enum EasingFunction {
- Linear = 0,
- CircleEase = 1,
- BackEase = 2,
- BounceEase = 3,
- CubicEase = 4,
- ElasticEase = 5,
- ExponentialEase = 6,
- PowerEase = 7,
- QuadraticEase = 8,
- QuarticEase = 9,
- QuinticEase = 10,
- SineEase = 11,
- }
- /**
- * Defines a simple animation to be applied to a model (scale).
- */
- export interface ModelAnimationConfiguration {
- /**
- * Time of animation, in seconds
- */
- time: number;
- /**
- * Scale to apply
- */
- scaling?: Vector3;
- /**
- * Easing function to apply
- * See SPECTRE.EasingFunction
- */
- easingFunction?: number;
- /**
- * An Easing mode to apply to the easing function
- * See BABYLON.EasingFunction
- */
- easingMode?: number;
- }
- /**
- * This interface can be implemented to define new types of ModelAnimation objects.
- */
- export interface IModelAnimation {
- /**
- * Current animation state (playing, stopped etc')
- */
- readonly state: AnimationState;
- /**
- * the name of the animation
- */
- readonly name: string;
- /**
- * Get the max numbers of frame available in the animation group
- *
- * In correlation to an arry, this would be ".length"
- */
- readonly frames: number;
- /**
- * Get the current frame playing right now.
- * This can be used to poll the frame currently playing (and, for exmaple, display a progress bar with the data)
- *
- * In correlation to an array, this would be the current index
- */
- readonly currentFrame: number;
- /**
- * Animation's FPS value
- */
- readonly fps: number;
- /**
- * Get or set the animation's speed ration (Frame-to-fps)
- */
- speedRatio: number;
- /**
- * Gets or sets the aimation's play mode.
- */
- playMode: AnimationPlayMode;
- /**
- * Start the animation
- */
- start(): any;
- /**
- * Stop the animation.
- * This will fail silently if the animation group is already stopped.
- */
- stop(): any;
- /**
- * Pause the animation
- * This will fail silently if the animation is not currently playing
- */
- pause(): any;
- /**
- * Reset this animation
- */
- reset(): any;
- /**
- * Restart the animation
- */
- restart(): any;
- /**
- * Go to a specific
- * @param frameNumber the frame number to go to
- */
- goToFrame(frameNumber: number): any;
- /**
- * Dispose this animation
- */
- dispose(): any;
- }
- /**
- * The GroupModelAnimation is an implementation of the IModelAnimation interface using BABYLON's
- * native GroupAnimation class.
- */
- export class GroupModelAnimation implements IModelAnimation {
- /**
- * Create a new GroupModelAnimation object using an AnimationGroup object
- * @param _animationGroup The aniamtion group to base the class on
- */
- constructor(_animationGroup: AnimationGroup);
- /**
- * Get the animation's name
- */
- readonly name: string;
- /**
- * Get the current animation's state
- */
- readonly state: AnimationState;
- /**
- * Sets the speed ratio to use for all animations
- */
- speedRatio: number;
- /**
- * Get the max numbers of frame available in the animation group
- *
- * In correlation to an arry, this would be ".length"
- */
- readonly frames: number;
- /**
- * Get the current frame playing right now.
- * This can be used to poll the frame currently playing (and, for exmaple, display a progress bar with the data)
- *
- * In correlation to an array, this would be the current index
- */
- readonly currentFrame: number;
- /**
- * Get the FPS value of this animation
- */
- readonly fps: number;
- /**
- * Set the play mode.
- * If the animation is played, it will continue playing at least once more, depending on the new play mode set.
- * If the animation is not set, the will be initialized and will wait for the user to start playing it.
- */
- playMode: AnimationPlayMode;
- /**
- * Reset the animation group
- */
- reset(): void;
- /**
- * Restart the animation group
- */
- restart(): void;
- /**
- *
- * @param frameNumber Go to a specific frame in the animation
- */
- goToFrame(frameNumber: number): void;
- /**
- * Start playing the animation.
- */
- start(): void;
- /**
- * Pause the animation
- */
- pause(): void;
- /**
- * Stop the animation.
- * This will fail silently if the animation group is already stopped.
- */
- stop(): void;
- /**
- * Dispose this animation object.
- */
- dispose(): void;
- }
- }
- declare module 'babylonjs-viewer/loader/plugins/loaderPlugin' {
- import { ViewerModel } from "babylonjs-viewer/model/viewerModel";
- import { IGLTFLoaderExtension, IGLTFLoaderData } from "babylonjs-loaders";
- import { AbstractMesh, ISceneLoaderPlugin, ISceneLoaderPluginAsync, SceneLoaderProgressEvent, BaseTexture, Material } from "babylonjs";
- export interface ILoaderPlugin {
- onInit?: (loader: ISceneLoaderPlugin | ISceneLoaderPluginAsync, model: ViewerModel) => void;
- onLoaded?: (model: ViewerModel) => void;
- onError?: (message: string, exception?: any) => void;
- onProgress?: (progressEvent: SceneLoaderProgressEvent) => void;
- onExtensionLoaded?: (extension: IGLTFLoaderExtension) => void;
- onParsed?: (parsedData: IGLTFLoaderData) => void;
- onMeshLoaded?: (mesh: AbstractMesh) => void;
- onTextureLoaded?: (texture: BaseTexture) => void;
- onMaterialLoaded?: (material: Material) => void;
- onComplete?: () => void;
- }
- }
- declare module 'babylonjs-viewer/initializer' {
- /**
- * Will attach an init function the the DOMContentLoaded event.
- * The init function will be removed automatically after the event was triggered.
- */
- export function initListeners(): void;
- /**
- * Select all HTML tags on the page that match the selector and initialize a viewer
- *
- * @param selector the selector to initialize the viewer on (default is 'babylon')
- */
- export function InitTags(selector?: string): void;
- }
- declare module 'babylonjs-viewer/configuration/configuration' {
- import { ITemplateConfiguration } from 'babylonjs-viewer/templateManager';
- import { EngineOptions, IGlowLayerOptions, DepthOfFieldEffectBlurLevel } from 'babylonjs';
- export function getConfigurationKey(key: string, configObject: any): any;
- export interface ViewerConfiguration {
- version?: string;
- extends?: string;
- pageUrl?: string;
- configuration?: string | {
- url?: string;
- payload?: any;
- mapper?: string;
- };
- observers?: IObserversConfiguration;
- canvasElement?: string;
- model?: IModelConfiguration | string;
- scene?: ISceneConfiguration;
- optimizer?: ISceneOptimizerConfiguration | boolean;
- camera?: ICameraConfiguration;
- skybox?: boolean | ISkyboxConfiguration;
- ground?: boolean | IGroundConfiguration;
- lights?: {
- [name: string]: boolean | ILightConfiguration;
- };
- engine?: {
- renderInBackground?: boolean;
- antialiasing?: boolean;
- disableResize?: boolean;
- engineOptions?: EngineOptions;
- adaptiveQuality?: boolean;
- };
- templates?: {
- main: ITemplateConfiguration;
- [key: string]: ITemplateConfiguration;
- };
- customShaders?: {
- shaders?: {
- [key: string]: string;
- };
- includes?: {
- [key: string]: string;
- };
- };
- loaderPlugins?: {
- extendedMaterial?: boolean;
- msftLod?: boolean;
- telemetry?: boolean;
- minecraft?: boolean;
- [propName: string]: boolean | undefined;
- };
- lab?: {
- flashlight?: boolean | {
- exponent?: number;
- angle?: number;
- intensity?: number;
- diffuse?: {
- r: number;
- g: number;
- b: number;
- };
- specular?: {
- r: number;
- g: number;
- b: number;
- };
- };
- hideLoadingDelay?: number;
- assetsRootURL?: string;
- environmentMainColor?: {
- r: number;
- g: number;
- b: number;
- };
- environmentMap?: {
- /**
- * Environment map texture path in relative to the asset folder.
- */
- texture: string;
- /**
- * Default rotation to apply to the environment map.
- */
- rotationY: number;
- /**
- * Tint level of the main color on the environment map.
- */
- tintLevel: number;
- };
- defaultRenderingPipelines?: boolean | IDefaultRenderingPipelineConfiguration;
- };
- }
- /**
- * Defines an animation to be applied to a model (translation, scale or rotation).
- */
- export interface IModelAnimationConfiguration {
- /**
- * Time of animation, in seconds
- */
- time?: number;
- /**
- * Scale to apply
- */
- scaling?: {
- x: number;
- y: number;
- z: number;
- };
- /**
- * Easing function to apply
- * See SPECTRE.EasingFunction
- */
- easingFunction?: number;
- /**
- * An Easing mode to apply to the easing function
- * See BABYLON.EasingFunction
- */
- easingMode?: number;
- }
- export interface IDefaultRenderingPipelineConfiguration {
- sharpenEnabled?: boolean;
- bloomEnabled?: boolean;
- bloomThreshold?: number;
- depthOfFieldEnabled?: boolean;
- depthOfFieldBlurLevel?: DepthOfFieldEffectBlurLevel;
- fxaaEnabled?: boolean;
- imageProcessingEnabled?: boolean;
- defaultPipelineTextureType?: number;
- bloomScale?: number;
- chromaticAberrationEnabled?: boolean;
- grainEnabled?: boolean;
- bloomKernel?: number;
- hardwareScaleLevel?: number;
- bloomWeight?: number;
- bllomThreshold?: number;
- hdr?: boolean;
- samples?: number;
- }
- export interface IModelConfiguration {
- id?: string;
- url?: string;
- root?: string;
- file?: string;
- loader?: string;
- position?: {
- x: number;
- y: number;
- z: number;
- };
- rotation?: {
- x: number;
- y: number;
- z: number;
- w?: number;
- };
- scaling?: {
- x: number;
- y: number;
- z: number;
- };
- parentObjectIndex?: number;
- castShadow?: boolean;
- receiveShadows?: boolean;
- normalize?: boolean | {
- center?: boolean;
- unitSize?: boolean;
- parentIndex?: number;
- };
- title?: string;
- subtitle?: string;
- thumbnail?: string;
- animation?: {
- autoStart?: boolean | string;
- playOnce?: boolean;
- autoStartIndex?: number;
- };
- entryAnimation?: IModelAnimationConfiguration;
- exitAnimation?: IModelAnimationConfiguration;
- material?: {
- directEnabled?: boolean;
- directIntensity?: number;
- emissiveIntensity?: number;
- environmentIntensity?: number;
- [propName: string]: any;
- };
- /**
- * Rotation offset axis definition
- */
- rotationOffsetAxis?: {
- x: number;
- y: number;
- z: number;
- };
- /**
- * the offset angle
- */
- rotationOffsetAngle?: number;
- loaderConfiguration?: {
- maxLODsToLoad?: number;
- progressiveLoading?: boolean;
- };
- }
- export interface ISkyboxConfiguration {
- cubeTexture?: {
- noMipMap?: boolean;
- gammaSpace?: boolean;
- url?: string | Array<string>;
- };
- color?: {
- r: number;
- g: number;
- b: number;
- };
- pbr?: boolean;
- scale?: number;
- blur?: number;
- material?: {
- imageProcessingConfiguration?: IImageProcessingConfiguration;
- [propName: string]: any;
- };
- infiniteDistance?: boolean;
- }
- export interface IGroundConfiguration {
- size?: number;
- receiveShadows?: boolean;
- shadowLevel?: number;
- shadowOnly?: boolean;
- mirror?: boolean | {
- sizeRatio?: number;
- blurKernel?: number;
- amount?: number;
- fresnelWeight?: number;
- fallOffDistance?: number;
- textureType?: number;
- };
- texture?: string;
- color?: {
- r: number;
- g: number;
- b: number;
- };
- opacity?: number;
- material?: {
- [propName: string]: any;
- };
- }
- export interface ISceneConfiguration {
- debug?: boolean;
- clearColor?: {
- r: number;
- g: number;
- b: number;
- a: number;
- };
- mainColor?: {
- r: number;
- g: number;
- b: number;
- };
- imageProcessingConfiguration?: IImageProcessingConfiguration;
- environmentTexture?: string;
- colorGrading?: IColorGradingConfiguration;
- environmentRotationY?: number;
- glow?: boolean | IGlowLayerOptions;
- disableHdr?: boolean;
- renderInBackground?: boolean;
- disableCameraControl?: boolean;
- animationPropertiesOverride?: {
- [propName: string]: any;
- };
- defaultMaterial?: {
- materialType: "standard" | "pbr";
- [propName: string]: any;
- };
- flags?: {
- shadowsEnabled?: boolean;
- particlesEnabled?: boolean;
- collisionsEnabled?: boolean;
- lightsEnabled?: boolean;
- texturesEnabled?: boolean;
- lensFlaresEnabled?: boolean;
- proceduralTexturesEnabled?: boolean;
- renderTargetsEnabled?: boolean;
- spritesEnabled?: boolean;
- skeletonsEnabled?: boolean;
- audioEnabled?: boolean;
- };
- }
- /**
- * The Color Grading Configuration groups the different settings used to define the color grading used in the viewer.
- */
- export interface IColorGradingConfiguration {
- /**
- * Transform data string, encoded as determined by transformDataFormat.
- */
- transformData: string;
- /**
- * The encoding format of TransformData (currently only raw-base16 is supported).
- */
- transformDataFormat: string;
- /**
- * The weight of the transform
- */
- transformWeight: number;
- /**
- * Color curve colorFilterHueGlobal value
- */
- colorFilterHueGlobal: number;
- /**
- * Color curve colorFilterHueShadows value
- */
- colorFilterHueShadows: number;
- /**
- * Color curve colorFilterHueMidtones value
- */
- colorFilterHueMidtones: number;
- /**
- * Color curve colorFilterHueHighlights value
- */
- colorFilterHueHighlights: number;
- /**
- * Color curve colorFilterDensityGlobal value
- */
- colorFilterDensityGlobal: number;
- /**
- * Color curve colorFilterDensityShadows value
- */
- colorFilterDensityShadows: number;
- /**
- * Color curve colorFilterDensityMidtones value
- */
- colorFilterDensityMidtones: number;
- /**
- * Color curve colorFilterDensityHighlights value
- */
- colorFilterDensityHighlights: number;
- /**
- * Color curve saturationGlobal value
- */
- saturationGlobal: number;
- /**
- * Color curve saturationShadows value
- */
- saturationShadows: number;
- /**
- * Color curve saturationMidtones value
- */
- saturationMidtones: number;
- /**
- * Color curve saturationHighlights value
- */
- saturationHighlights: number;
- /**
- * Color curve exposureGlobal value
- */
- exposureGlobal: number;
- /**
- * Color curve exposureShadows value
- */
- exposureShadows: number;
- /**
- * Color curve exposureMidtones value
- */
- exposureMidtones: number;
- /**
- * Color curve exposureHighlights value
- */
- exposureHighlights: number;
- }
- export interface ISceneOptimizerConfiguration {
- targetFrameRate?: number;
- trackerDuration?: number;
- autoGeneratePriorities?: boolean;
- improvementMode?: boolean;
- degradation?: string;
- types?: {
- texture?: ISceneOptimizerParameters;
- hardwareScaling?: ISceneOptimizerParameters;
- shadow?: ISceneOptimizerParameters;
- postProcess?: ISceneOptimizerParameters;
- lensFlare?: ISceneOptimizerParameters;
- particles?: ISceneOptimizerParameters;
- renderTarget?: ISceneOptimizerParameters;
- mergeMeshes?: ISceneOptimizerParameters;
- };
- custom?: string;
- }
- export interface IObserversConfiguration {
- onEngineInit?: string;
- onSceneInit?: string;
- onModelLoaded?: string;
- }
- export interface ICameraConfiguration {
- position?: {
- x: number;
- y: number;
- z: number;
- };
- rotation?: {
- x: number;
- y: number;
- z: number;
- w: number;
- };
- fov?: number;
- fovMode?: number;
- minZ?: number;
- maxZ?: number;
- inertia?: number;
- exposure?: number;
- pinchPrecision?: number;
- behaviors?: {
- [name: string]: number | {
- type: number;
- [propName: string]: any;
- };
- };
- disableCameraControl?: boolean;
- disableCtrlForPanning?: boolean;
- disableAutoFocus?: boolean;
- [propName: string]: any;
- }
- export interface ILightConfiguration {
- type: number;
- name?: string;
- disabled?: boolean;
- position?: {
- x: number;
- y: number;
- z: number;
- };
- target?: {
- x: number;
- y: number;
- z: number;
- };
- direction?: {
- x: number;
- y: number;
- z: number;
- };
- diffuse?: {
- r: number;
- g: number;
- b: number;
- };
- specular?: {
- r: number;
- g: number;
- b: number;
- };
- intensity?: number;
- intensityMode?: number;
- radius?: number;
- shadownEnabled?: boolean;
- shadowConfig?: {
- useBlurExponentialShadowMap?: boolean;
- useBlurCloseExponentialShadowMap?: boolean;
- useKernelBlur?: boolean;
- blurKernel?: number;
- blurScale?: number;
- minZ?: number;
- maxZ?: number;
- frustumSize?: number;
- angleScale?: number;
- frustumEdgeFalloff?: number;
- [propName: string]: any;
- };
- spotAngle?: number;
- shadowFieldOfView?: number;
- shadowBufferSize?: number;
- shadowFrustumSize?: number;
- shadowMinZ?: number;
- shadowMaxZ?: number;
- [propName: string]: any;
- behaviors?: {
- [name: string]: number | {
- type: number;
- [propName: string]: any;
- };
- };
- }
- export interface ISceneOptimizerParameters {
- priority?: number;
- maximumSize?: number;
- step?: number;
- }
- export interface IImageProcessingConfiguration {
- colorGradingEnabled?: boolean;
- colorCurvesEnabled?: boolean;
- colorCurves?: {
- globalHue?: number;
- globalDensity?: number;
- globalSaturation?: number;
- globalExposure?: number;
- highlightsHue?: number;
- highlightsDensity?: number;
- highlightsSaturation?: number;
- highlightsExposure?: number;
- midtonesHue?: number;
- midtonesDensity?: number;
- midtonesSaturation?: number;
- midtonesExposure?: number;
- shadowsHue?: number;
- shadowsDensity?: number;
- shadowsSaturation?: number;
- shadowsExposure?: number;
- };
- colorGradingWithGreenDepth?: boolean;
- colorGradingBGR?: boolean;
- exposure?: number;
- toneMappingEnabled?: boolean;
- contrast?: number;
- vignetteEnabled?: boolean;
- vignetteStretch?: number;
- vignetteCentreX?: number;
- vignetteCentreY?: number;
- vignetteWeight?: number;
- vignetteColor?: {
- r: number;
- g: number;
- b: number;
- a?: number;
- };
- vignetteCameraFov?: number;
- vignetteBlendMode?: number;
- vignetteM?: boolean;
- applyByPostProcess?: boolean;
- isEnabled?: boolean;
- }
- }
- declare module 'babylonjs-viewer/templateManager' {
- import { Observable } from 'babylonjs';
- /**
- * A single template configuration object
- */
- export interface ITemplateConfiguration {
- location?: string;
- html?: string;
- id?: string;
- params?: {
- [key: string]: string | number | boolean | object;
- };
- events?: {
- pointerdown?: boolean | {
- [id: string]: boolean;
- };
- pointerup?: boolean | {
- [id: string]: boolean;
- };
- pointermove?: boolean | {
- [id: string]: boolean;
- };
- pointerover?: boolean | {
- [id: string]: boolean;
- };
- pointerout?: boolean | {
- [id: string]: boolean;
- };
- pointerenter?: boolean | {
- [id: string]: boolean;
- };
- pointerleave?: boolean | {
- [id: string]: boolean;
- };
- pointercancel?: boolean | {
- [id: string]: boolean;
- };
- click?: boolean | {
- [id: string]: boolean;
- };
- dragstart?: boolean | {
- [id: string]: boolean;
- };
- drop?: boolean | {
- [id: string]: boolean;
- };
- [key: string]: boolean | {
- [id: string]: boolean;
- } | undefined;
- };
- }
- /**
- * The object sent when an event is triggered
- */
- export interface EventCallback {
- event: Event;
- template: Template;
- selector: string;
- payload?: any;
- }
- /**
- * The template manager, a member of the viewer class, will manage the viewer's templates and generate the HTML.
- * The template manager managers a single viewer and can be seen as the collection of all sub-templates of the viewer.
- */
- export class TemplateManager {
- containerElement: HTMLElement;
- /**
- * Will be triggered when any template is initialized
- */
- onTemplateInit: Observable<Template>;
- /**
- * Will be triggered when any template is fully loaded
- */
- onTemplateLoaded: Observable<Template>;
- /**
- * Will be triggered when a template state changes
- */
- onTemplateStateChange: Observable<Template>;
- /**
- * Will be triggered when all templates finished loading
- */
- onAllLoaded: Observable<TemplateManager>;
- /**
- * Will be triggered when any event on any template is triggered.
- */
- onEventTriggered: Observable<EventCallback>;
- /**
- * This template manager's event manager. In charge of callback registrations to native event types
- */
- eventManager: EventManager;
- constructor(containerElement: HTMLElement);
- /**
- * Initialize the template(s) for the viewer. Called bay the Viewer class
- * @param templates the templates to be used to initialize the main template
- */
- initTemplate(templates: {
- [key: string]: ITemplateConfiguration;
- }): Promise<void>;
- /**
- * Get the canvas in the template tree.
- * There must be one and only one canvas inthe template.
- */
- getCanvas(): HTMLCanvasElement | null;
- /**
- * Get a specific template from the template tree
- * @param name the name of the template to load
- */
- getTemplate(name: string): Template | undefined;
- /**
- * Dispose the template manager
- */
- dispose(): void;
- }
- import { EventManager } from 'babylonjs-viewer/eventManager';
- /**
- * This class represents a single template in the viewer's template tree.
- * An example for a template is a single canvas, an overlay (containing sub-templates) or the navigation bar.
- * A template is injected using the template manager in the correct position.
- * The template is rendered using Handlebars and can use Handlebars' features (such as parameter injection)
- *
- * For further information please refer to the documentation page, https://doc.babylonjs.com
- */
- export class Template {
- name: string;
- /**
- * Will be triggered when the template is loaded
- */
- onLoaded: Observable<Template>;
- /**
- * will be triggered when the template is appended to the tree
- */
- onAppended: Observable<Template>;
- /**
- * Will be triggered when the template's state changed (shown, hidden)
- */
- onStateChange: Observable<Template>;
- /**
- * Will be triggered when an event is triggered on ths template.
- * The event is a native browser event (like mouse or pointer events)
- */
- onEventTriggered: Observable<EventCallback>;
- /**
- * is the template loaded?
- */
- isLoaded: boolean;
- /**
- * This is meant to be used to track the show and hide functions.
- * This is NOT (!!) a flag to check if the element is actually visible to the user.
- */
- isShown: boolean;
- /**
- * Is this template a part of the HTML tree (the template manager injected it)
- */
- isInHtmlTree: boolean;
- /**
- * The HTML element containing this template
- */
- parent: HTMLElement;
- /**
- * A promise that is fulfilled when the template finished loading.
- */
- initPromise: Promise<Template>;
- constructor(name: string, _configuration: ITemplateConfiguration);
- /**
- * Some templates have parameters (like background color for example).
- * The parameters are provided to Handlebars which in turn generates the template.
- * This function will update the template with the new parameters
- *
- * @param params the new template parameters
- */
- updateParams(params: {
- [key: string]: string | number | boolean | object;
- }, append?: boolean): void;
- /**
- * Get the template'S configuration
- */
- readonly configuration: ITemplateConfiguration;
- /**
- * A template can be a parent element for other templates or HTML elements.
- * This function will deliver all child HTML elements of this template.
- */
- getChildElements(): Array<string>;
- /**
- * Appending the template to a parent HTML element.
- * If a parent is already set and you wish to replace the old HTML with new one, forceRemove should be true.
- * @param parent the parent to which the template is added
- * @param forceRemove if the parent already exists, shoud the template be removed from it?
- */
- appendTo(parent: HTMLElement, forceRemove?: boolean): void;
- /**
- * Show the template using the provided visibilityFunction, or natively using display: flex.
- * The provided function returns a promise that should be fullfilled when the element is shown.
- * Since it is a promise async operations are more than possible.
- * See the default viewer for an opacity example.
- * @param visibilityFunction The function to execute to show the template.
- */
- show(visibilityFunction?: (template: Template) => Promise<Template>): Promise<Template>;
- /**
- * Hide the template using the provided visibilityFunction, or natively using display: none.
- * The provided function returns a promise that should be fullfilled when the element is hidden.
- * Since it is a promise async operations are more than possible.
- * See the default viewer for an opacity example.
- * @param visibilityFunction The function to execute to show the template.
- */
- hide(visibilityFunction?: (template: Template) => Promise<Template>): Promise<Template>;
- /**
- * Dispose this template
- */
- dispose(): void;
- }
- }
- declare module 'babylonjs-viewer/viewer/sceneManager' {
- import { Scene, ArcRotateCamera, Light, SceneOptimizer, EnvironmentHelper, Color3, Observable, DefaultRenderingPipeline, Nullable } from 'babylonjs';
- import { AbstractViewer } from 'babylonjs-viewer/viewer/viewer';
- import { ILightConfiguration, ISceneConfiguration, ISceneOptimizerConfiguration, ICameraConfiguration, ISkyboxConfiguration, ViewerConfiguration, IGroundConfiguration, IModelConfiguration } from 'babylonjs-viewer/configuration/configuration';
- import { ViewerModel } from 'babylonjs-viewer/model/viewerModel';
- import { ViewerLabs } from 'babylonjs-viewer/labs/viewerLabs';
- /**
- * This interface describes the structure of the variable sent with the configuration observables of the scene manager.
- * O - the type of object we are dealing with (Light, ArcRotateCamera, Scene, etc')
- * T - the configuration type
- */
- export interface IPostConfigurationCallback<OBJ, CONF> {
- newConfiguration: CONF;
- sceneManager: SceneManager;
- object: OBJ;
- model?: ViewerModel;
- }
- export class SceneManager {
- /**
- * Will notify when the scene was initialized
- */
- onSceneInitObservable: Observable<Scene>;
- /**
- * Will notify after the scene was configured. Can be used to further configure the scene
- */
- onSceneConfiguredObservable: Observable<IPostConfigurationCallback<Scene, ISceneConfiguration>>;
- /**
- * Will notify after the scene optimized was configured. Can be used to further configure the scene optimizer
- */
- onSceneOptimizerConfiguredObservable: Observable<IPostConfigurationCallback<SceneOptimizer, ISceneOptimizerConfiguration | boolean>>;
- /**
- * Will notify after the camera was configured. Can be used to further configure the camera
- */
- onCameraConfiguredObservable: Observable<IPostConfigurationCallback<ArcRotateCamera, ICameraConfiguration>>;
- /**
- * Will notify after the lights were configured. Can be used to further configure lights
- */
- onLightsConfiguredObservable: Observable<IPostConfigurationCallback<Array<Light>, {
- [name: string]: ILightConfiguration | boolean;
- }>>;
- /**
- * Will notify after the model(s) were configured. Can be used to further configure models
- */
- onModelsConfiguredObservable: Observable<IPostConfigurationCallback<Array<ViewerModel>, IModelConfiguration>>;
- /**
- * Will notify after the envirnoment was configured. Can be used to further configure the environment
- */
- onEnvironmentConfiguredObservable: Observable<IPostConfigurationCallback<EnvironmentHelper, {
- skybox?: ISkyboxConfiguration | boolean;
- ground?: IGroundConfiguration | boolean;
- }>>;
- /**
- * The Babylon Scene of this viewer
- */
- scene: Scene;
- /**
- * The camera used in this viewer
- */
- camera: ArcRotateCamera;
- /**
- * Babylon's scene optimizer
- */
- sceneOptimizer: SceneOptimizer;
- /**
- * Models displayed in this viewer.
- */
- models: Array<ViewerModel>;
- /**
- * Babylon's environment helper of this viewer
- */
- environmentHelper: EnvironmentHelper;
- protected _defaultHighpTextureType: number;
- protected _shadowGeneratorBias: number;
- protected _defaultPipelineTextureType: number;
- /**
- * The maximum number of shadows supported by the curent viewer
- */
- protected _maxShadows: number;
- /**
- * The labs variable consists of objects that will have their API change.
- * Please be careful when using labs in production.
- */
- labs: ViewerLabs;
- readonly defaultRenderingPipeline: Nullable<DefaultRenderingPipeline>;
- constructor(_viewer: AbstractViewer);
- /**
- * Returns a boolean representing HDR support
- */
- readonly isHdrSupported: boolean;
- /**
- * Return the main color defined in the configuration.
- */
- readonly mainColor: Color3;
- readonly reflectionColor: Color3;
- animationBlendingEnabled: boolean;
- /**
- * Should shadows be rendered every frame, or only once and stop.
- * This can be used to optimize a scene.
- *
- * Not that the shadows will NOT disapear but will remain in place.
- * @param process if true shadows will be updated once every frame. if false they will stop being updated.
- */
- processShadows: boolean;
- groundEnabled: boolean;
- /**
- * sets wether the reflection is disabled.
- */
- groundMirrorEnabled: boolean;
- defaultRenderingPipelineEnabled: boolean;
- /**
- * Sets the engine flags to unlock all babylon features.
- * Can also be configured using the scene.flags configuration object
- */
- unlockBabylonFeatures(): void;
- /**
- * initialize the scene. Calling this function again will dispose the old scene, if exists.
- */
- initScene(sceneConfiguration?: ISceneConfiguration, optimizerConfiguration?: boolean | ISceneOptimizerConfiguration): Promise<Scene>;
- clearScene(clearModels?: boolean, clearLights?: boolean): void;
- /**
- * This will update the scene's configuration, including camera, lights, environment.
- * @param newConfiguration the delta that should be configured. This includes only the changes
- * @param globalConfiguration The global configuration object, after the new configuration was merged into it
- */
- updateConfiguration(newConfiguration: Partial<ViewerConfiguration>, globalConfiguration: ViewerConfiguration, model?: ViewerModel): void;
- bloomEnabled: boolean;
- fxaaEnabled: boolean;
- /**
- * internally configure the scene using the provided configuration.
- * The scene will not be recreated, but just updated.
- * @param sceneConfig the (new) scene configuration
- */
- protected _configureScene(sceneConfig: ISceneConfiguration): void;
- /**
- * Configure the scene optimizer.
- * The existing scene optimizer will be disposed and a new one will be created.
- * @param optimizerConfig the (new) optimizer configuration
- */
- protected _configureOptimizer(optimizerConfig: ISceneOptimizerConfiguration | boolean): void;
- /**
- * (Re) configure the camera. The camera will only be created once and from this point will only be reconfigured.
- * @param cameraConfig the new camera configuration
- * @param model optionally use the model to configure the camera.
- */
- protected _configureCamera(cameraConfig?: ICameraConfiguration, model?: ViewerModel): void;
- protected _configureEnvironment(skyboxConifguration?: ISkyboxConfiguration | boolean, groundConfiguration?: IGroundConfiguration | boolean, model?: ViewerModel): Promise<Scene> | undefined;
- /**
- * configure the lights.
- *
- * @param lightsConfiguration the (new) light(s) configuration
- * @param model optionally use the model to configure the camera.
- */
- protected _configureLights(lightsConfiguration?: {
- [name: string]: ILightConfiguration | boolean;
- }, model?: ViewerModel): void;
- /**
- * Gets the shadow map blur kernel according to the light configuration.
- * @param light The light used to generate the shadows
- * @param bufferSize The size of the shadow map
- * @return the kernel blur size
- */
- getBlurKernel(light: BABYLON.IShadowLight, bufferSize: number): number;
- /**
- * Alters render settings to reduce features based on hardware feature limitations
- * @param enableHDR Allows the viewer to run in HDR mode.
- */
- protected _handleHardwareLimitations(enableHDR?: boolean): void;
- /**
- * Dispoe the entire viewer including the scene and the engine
- */
- dispose(): void;
- }
- }
- declare module 'babylonjs-viewer/configuration/loader' {
- import { ViewerConfiguration } from 'babylonjs-viewer/configuration/configuration';
- /**
- * The configuration loader will load the configuration object from any source and will use the defined mapper to
- * parse the object and return a conform ViewerConfiguration.
- * It is a private member of the scene.
- */
- export class ConfigurationLoader {
- constructor(_enableCache?: boolean);
- /**
- * load a configuration object that is defined in the initial configuration provided.
- * The viewer configuration can extend different types of configuration objects and have an extra configuration defined.
- *
- * @param initConfig the initial configuration that has the definitions of further configuration to load.
- * @param callback an optional callback that will be called sync, if noconfiguration needs to be loaded or configuration is payload-only
- * @returns A promise that delivers the extended viewer configuration, when done.
- */
- loadConfiguration(initConfig?: ViewerConfiguration, callback?: (config: ViewerConfiguration) => void): Promise<ViewerConfiguration>;
- /**
- * Dispose the configuration loader. This will cancel file requests, if active.
- */
- dispose(): void;
- }
- }
- declare module 'babylonjs-viewer/' {
- import { mapperManager } from 'babylonjs-viewer/configuration/mappers';
- import { viewerGlobals } from 'babylonjs-viewer/configuration/globals';
- import { viewerManager } from 'babylonjs-viewer/viewer/viewerManager';
- import { DefaultViewer } from 'babylonjs-viewer/viewer/defaultViewer';
- import { AbstractViewer } from 'babylonjs-viewer/viewer/viewer';
- import { telemetryManager } from 'babylonjs-viewer/telemetryManager';
- import { ModelLoader } from 'babylonjs-viewer/loader/modelLoader';
- import { ViewerModel, ModelState } from 'babylonjs-viewer/model/viewerModel';
- import { AnimationPlayMode, AnimationState } from 'babylonjs-viewer/model/modelAnimation';
- import { ILoaderPlugin } from 'babylonjs-viewer/loader/plugins/loaderPlugin';
- /**
- * BabylonJS Viewer
- *
- * An HTML-Based viewer for 3D models, based on BabylonJS and its extensions.
- */
- import * as BABYLON from 'babylonjs';
- import 'babylonjs-loaders';
- import 'pep';
- import { InitTags } from 'babylonjs-viewer/initializer';
- let disableInit: boolean;
- /**
- * Dispose all viewers currently registered
- */
- function disposeAll(): void;
- const Version: string;
- export { BABYLON, Version, InitTags, DefaultViewer, AbstractViewer, viewerGlobals, telemetryManager, disableInit, viewerManager, mapperManager, disposeAll, ModelLoader, ViewerModel, AnimationPlayMode, AnimationState, ModelState, ILoaderPlugin };
- }
- declare module 'babylonjs-viewer/eventManager' {
- import { EventCallback, TemplateManager } from "babylonjs-viewer/templateManager";
- /**
- * The EventManager is in charge of registering user interctions with the viewer.
- * It is used in the TemplateManager
- */
- export class EventManager {
- constructor(_templateManager: TemplateManager);
- /**
- * Register a new callback to a specific template.
- * The best example for the usage can be found in the DefaultViewer
- *
- * @param templateName the templateName to register the event to
- * @param callback The callback to be executed
- * @param eventType the type of event to register
- * @param selector an optional selector. if not defined the parent object in the template will be selected
- */
- registerCallback(templateName: string, callback: (eventData: EventCallback) => void, eventType?: string, selector?: string): void;
- /**
- * This will remove a registered event from the defined template.
- * Each one of the variables apart from the template name are optional, but one must be provided.
- *
- * @param templateName the templateName
- * @param callback the callback to remove (optional)
- * @param eventType the event type to remove (optional)
- * @param selector the selector from which to remove the event (optional)
- */
- unregisterCallback(templateName: string, callback: (eventData: EventCallback) => void, eventType?: string, selector?: string): void;
- /**
- * Dispose the event manager
- */
- dispose(): void;
- }
- }
- declare module 'babylonjs-viewer/labs/viewerLabs' {
- import { PBREnvironment } from "babylonjs-viewer/labs/environmentSerializer";
- import { SceneManager } from 'babylonjs-viewer/viewer/sceneManager';
- export class ViewerLabs {
- constructor(_sceneManager: SceneManager);
- assetsRootURL: string;
- environment: PBREnvironment;
- /**
- * Loads an environment map from a given URL
- * @param url URL of environment map
- * @param onSuccess Callback fired after environment successfully applied to the scene
- * @param onProgress Callback fired at progress events while loading the environment map
- * @param onError Callback fired when the load fails
- */
- loadEnvironment(url: string, onSuccess?: (env: PBREnvironment) => void, onProgress?: (bytesLoaded: number, bytesTotal: number) => void, onError?: (e: any) => void): void;
- /**
- * Loads an environment map from a given URL
- * @param buffer ArrayBuffer containing environment map
- * @param onSuccess Callback fired after environment successfully applied to the scene
- * @param onProgress Callback fired at progress events while loading the environment map
- * @param onError Callback fired when the load fails
- */
- loadEnvironment(buffer: ArrayBuffer, onSuccess?: (env: PBREnvironment) => void, onProgress?: (bytesLoaded: number, bytesTotal: number) => void, onError?: (e: any) => void): void;
- /**
- * Sets the environment to an already loaded environment
- * @param env PBREnvironment instance
- * @param onSuccess Callback fired after environment successfully applied to the scene
- * @param onProgress Callback fired at progress events while loading the environment map
- * @param onError Callback fired when the load fails
- */
- loadEnvironment(env: PBREnvironment, onSuccess?: (env: PBREnvironment) => void, onProgress?: (bytesLoaded: number, bytesTotal: number) => void, onError?: (e: any) => void): void;
- /**
- * Applies an `EnvironmentMapConfiguration` to the scene
- * @param environmentMapConfiguration Environment map configuration to apply
- */
- applyEnvironmentMapConfiguration(rotationY?: number): void;
- /**
- * Get an environment asset url by using the configuration if the path is not absolute.
- * @param url Asset url
- * @returns The Asset url using the `environmentAssetsRootURL` if the url is not an absolute path.
- */
- getAssetUrl(url: string): string;
- }
- }
- declare module 'babylonjs-viewer/labs/environmentSerializer' {
- import { Vector3 } from "babylonjs";
- import { TextureCube } from 'babylonjs-viewer/labs/texture';
- /**
- * Spherical polynomial coefficients (counter part to spherical harmonic coefficients used in shader irradiance calculation)
- * @ignoreChildren
- */
- export interface SphericalPolynomalCoefficients {
- x: Vector3;
- y: Vector3;
- z: Vector3;
- xx: Vector3;
- yy: Vector3;
- zz: Vector3;
- yz: Vector3;
- zx: Vector3;
- xy: Vector3;
- }
- /**
- * Wraps data and maps required for environments with physically based rendering
- */
- export interface PBREnvironment {
- /**
- * Spherical Polynomial Coefficients representing an irradiance map
- */
- irradiancePolynomialCoefficients: SphericalPolynomalCoefficients;
- /**
- * Specular cubemap
- */
- specularTexture?: TextureCube;
- /**
- * A scale factor applied to RGB values after reading from environment maps
- */
- textureIntensityScale: number;
- }
- /**
- * Environment map representations: layouts, projections and approximations
- */
- export type MapType = 'irradiance_sh_coefficients_9' | 'cubemap_faces';
- /**
- * Image type used for environment map
- */
- export type ImageType = 'png';
- /**
- * A generic field in JSON that report's its type
- */
- export interface TypedObject<T> {
- type: T;
- }
- /**
- * Describes a range of bytes starting at byte pos (inclusive) and finishing at byte pos + length - 1
- */
- export interface ByteRange {
- pos: number;
- length: number;
- }
- /**
- * Complete Spectre Environment JSON Descriptor
- */
- export interface EnvJsonDescriptor {
- radiance: TypedObject<MapType>;
- irradiance: TypedObject<MapType>;
- specular: TypedObject<MapType>;
- }
- /**
- * Spherical harmonic coefficients to provide an irradiance map
- */
- export interface IrradianceSHCoefficients9 extends TypedObject<MapType> {
- l00: Array<number>;
- l1_1: Array<number>;
- l10: Array<number>;
- l11: Array<number>;
- l2_2: Array<number>;
- l2_1: Array<number>;
- l20: Array<number>;
- l21: Array<number>;
- l22: Array<number>;
- }
- /**
- * A generic set of images, where the image content is specified by byte ranges in the mipmaps field
- */
- export interface ImageSet<T> extends TypedObject<MapType> {
- imageType: ImageType;
- width: number;
- height: number;
- mipmaps: Array<T>;
- multiplier: number;
- }
- /**
- * A set of cubemap faces
- */
- export type CubemapFaces = ImageSet<Array<ByteRange>>;
- /**
- * A single image containing an atlas of equirectangular-projection maps across all mip levels
- */
- export type EquirectangularMipmapAtlas = ImageSet<ByteRange>;
- /**
- * A static class proving methods to aid parsing Spectre environment files
- */
- export class EnvironmentDeserializer {
- /**
- * Parses an arraybuffer into a new PBREnvironment object
- * @param arrayBuffer The arraybuffer of the Spectre environment file
- * @return a PBREnvironment object
- */
- static Parse(arrayBuffer: ArrayBuffer): PBREnvironment;
- }
- }
- declare module 'babylonjs-viewer/labs/texture' {
- /**
- * WebGL Pixel Formats
- */
- export const enum PixelFormat {
- DEPTH_COMPONENT = 6402,
- ALPHA = 6406,
- RGB = 6407,
- RGBA = 6408,
- LUMINANCE = 6409,
- LUMINANCE_ALPHA = 6410,
- }
- /**
- * WebGL Pixel Types
- */
- export const enum PixelType {
- UNSIGNED_BYTE = 5121,
- UNSIGNED_SHORT_4_4_4_4 = 32819,
- UNSIGNED_SHORT_5_5_5_1 = 32820,
- UNSIGNED_SHORT_5_6_5 = 33635,
- }
- /**
- * WebGL Texture Magnification Filter
- */
- export const enum TextureMagFilter {
- NEAREST = 9728,
- LINEAR = 9729,
- }
- /**
- * WebGL Texture Minification Filter
- */
- export const enum TextureMinFilter {
- NEAREST = 9728,
- LINEAR = 9729,
- NEAREST_MIPMAP_NEAREST = 9984,
- LINEAR_MIPMAP_NEAREST = 9985,
- NEAREST_MIPMAP_LINEAR = 9986,
- LINEAR_MIPMAP_LINEAR = 9987,
- }
- /**
- * WebGL Texture Wrap Modes
- */
- export const enum TextureWrapMode {
- REPEAT = 10497,
- CLAMP_TO_EDGE = 33071,
- MIRRORED_REPEAT = 33648,
- }
- /**
- * Raw texture data and descriptor sufficient for WebGL texture upload
- */
- export interface TextureData {
- /**
- * Width of image
- */
- width: number;
- /**
- * Height of image
- */
- height: number;
- /**
- * Format of pixels in data
- */
- format: PixelFormat;
- /**
- * Row byte alignment of pixels in data
- */
- alignment: number;
- /**
- * Pixel data
- */
- data: ArrayBufferView;
- }
- /**
- * Wraps sampling parameters for a WebGL texture
- */
- export interface SamplingParameters {
- /**
- * Magnification mode when upsampling from a WebGL texture
- */
- magFilter?: TextureMagFilter;
- /**
- * Minification mode when upsampling from a WebGL texture
- */
- minFilter?: TextureMinFilter;
- /**
- * X axis wrapping mode when sampling out of a WebGL texture bounds
- */
- wrapS?: TextureWrapMode;
- /**
- * Y axis wrapping mode when sampling out of a WebGL texture bounds
- */
- wrapT?: TextureWrapMode;
- /**
- * Anisotropic filtering samples
- */
- maxAnisotropy?: number;
- }
- /**
- * Represents a valid WebGL texture source for use in texImage2D
- */
- export type TextureSource = TextureData | ImageData | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement;
- /**
- * A generic set of texture mipmaps (where index 0 has the largest dimension)
- */
- export type Mipmaps<T> = Array<T>;
- /**
- * A set of 6 cubemap arranged in the order [+x, -x, +y, -y, +z, -z]
- */
- export type Faces<T> = Array<T>;
- /**
- * A set of texture mipmaps specifically for 2D textures in WebGL (where index 0 has the largest dimension)
- */
- export type Mipmaps2D = Mipmaps<TextureSource>;
- /**
- * A set of texture mipmaps specifically for cubemap textures in WebGL (where index 0 has the largest dimension)
- */
- export type MipmapsCube = Mipmaps<Faces<TextureSource>>;
- /**
- * A minimal WebGL cubemap descriptor
- */
- export class TextureCube {
- internalFormat: PixelFormat;
- type: PixelType;
- source: MipmapsCube;
- /**
- * Returns the width of a face of the texture or 0 if not available
- */
- readonly Width: number;
- /**
- * Returns the height of a face of the texture or 0 if not available
- */
- readonly Height: number;
- /**
- * constructor
- * @param internalFormat WebGL pixel format for the texture on the GPU
- * @param type WebGL pixel type of the supplied data and texture on the GPU
- * @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
- */
- constructor(internalFormat: PixelFormat, type: PixelType, source?: MipmapsCube);
- }
- /**
- * A static class providing methods to aid working with Bablyon textures.
- */
- export class TextureUtils {
- /**
- * A prefix used when storing a babylon texture object reference on a Spectre texture object
- */
- static BabylonTextureKeyPrefix: string;
- /**
- * Controls anisotropic filtering for deserialized textures.
- */
- static MaxAnisotropy: number;
- /**
- * Returns a BabylonCubeTexture instance from a Spectre texture cube, subject to sampling parameters.
- * If such a texture has already been requested in the past, this texture will be returned, otherwise a new one will be created.
- * The advantage of this is to enable working with texture objects without the need to initialize on the GPU until desired.
- * @param scene A Babylon Scene instance
- * @param textureCube A Spectre TextureCube object
- * @param parameters WebGL texture sampling parameters
- * @param automaticMipmaps Pass true to enable automatic mipmap generation where possible (requires power of images)
- * @param environment Specifies that the texture will be used as an environment
- * @param singleLod Specifies that the texture will be a singleLod (for environment)
- * @return Babylon cube texture
- */
- static GetBabylonCubeTexture(scene: BABYLON.Scene, textureCube: TextureCube, automaticMipmaps: boolean, environment?: boolean, singleLod?: boolean): BABYLON.CubeTexture;
- /**
- * Applies Spectre SamplingParameters to a Babylon texture by directly setting texture parameters on the internal WebGLTexture as well as setting Babylon fields
- * @param babylonTexture Babylon texture to apply texture to (requires the Babylon texture has an initialize _texture field)
- * @param parameters Spectre SamplingParameters to apply
- */
- static ApplySamplingParameters(babylonTexture: BABYLON.BaseTexture, parameters: SamplingParameters): void;
- /**
- * Environment preprocessing dedicated value (Internal Use or Advanced only).
- */
- static EnvironmentLODScale: number;
- /**
- * Environment preprocessing dedicated value (Internal Use or Advanced only)..
- */
- static EnvironmentLODOffset: number;
- }
- }
|