threepipe
Version:
A modern 3D viewer framework built on top of three.js, written in TypeScript, designed to make creating high-quality, modular, and extensible 3D experiences on the web simple and enjoyable.
30 lines • 1.13 kB
TypeScript
import { AViewerPluginEventMap, AViewerPluginSync } from '../../viewer';
export interface FullScreenPluginEventMap extends AViewerPluginEventMap {
enter: object;
exit: object;
}
/**
* Full Screen Plugin
*
* A simple plugin that provides functions to {@link enter}, {@link exit}, {@link toggle} full screen mode and check if the viewer is in full screen mode with {@link isFullScreen}.
*
* Implementation from:
* https://stackoverflow.com/questions/50568474/how-to-enter-fullscreen-in-three-js
*
* @todo: try out some lib like https://github.com/sindresorhus/screenfull for proper cross browser support
* @category Plugins
*/
export declare class FullScreenPlugin extends AViewerPluginSync<FullScreenPluginEventMap> {
static readonly PluginType = "FullScreenPlugin";
toJSON: any;
enabled: boolean;
constructor();
private _lastSize;
private _lastFsElement;
private _fsChangeHandler;
enter(element?: HTMLElement): Promise<void>;
exit(): Promise<void>;
toggle(element?: HTMLElement): Promise<void>;
isFullScreen(): any;
}
//# sourceMappingURL=FullScreenPlugin.d.ts.map