@thewtex/vtk.js-esm/Rendering/Misc/GenericRenderWindow.d.ts

Visualization Toolkit for the Web

import { vtkObject, vtkSubscription } from '@kitware/vtk.js/interfaces';
import vtkRenderer from '@kitware/vtk.js/Rendering/Core/Renderer';
import vtkRenderWindow from '@kitware/vtk.js/Rendering/Core/RenderWindow';
import vtkRenderWindowInteractor from '@kitware/vtk.js/Rendering/Core/RenderWindowInteractor';

// import vtkOpenGLRenderWindow from '@kitware/vtk.js/OpenGL/RenderWindow';


/**
 *
 */
interface IGenericRenderWindowInitialValues {
	background?: number[];	
	listenWindowResize?: boolean;
	container?: HTMLElement,
}

export interface vtkGenericRenderWindow extends vtkObject {

	/**
	 * Release GL context
	 */
	delete(): void;

	/**
	 * Get container element
	 */
	getContainer(): HTMLElement;

	/**
	 * Get interactor object
	 */
	getInteractor(): vtkRenderWindowInteractor;

	/**
	 * 
	 */
	getOpenGLRenderWindow(): any; // vtkOpenGLRenderWindow

	/**
	 * 
	 */
	getRenderWindow(): vtkRenderWindow;

	/**
	 * 
	 */
	getRenderer(): vtkRenderer;

	/**
	 * Method to register callback when the object is resize().
	 *
	 * @param callback function
	 * @returns subscription object so you can easily unsubscribe later on
	 */
	onResize(callback: (instance: vtkObject) => any): vtkSubscription;

	/**
	 * Handle window resize
	 */
	resize(): void;

	/**
	 * Set background color
	 * @param {Number[]} background The background color.
	 */
	setBackground(background: number[]): boolean;

	/**
	 * Set container element
	 * @param {HTMLElement} el 
	 */
	setContainer(el: HTMLElement): void;
}

/**
 * Method used to decorate a given object (publicAPI+model) with vtkGenericRenderWindow characteristics.
 *
 * @param publicAPI object on which methods will be bounds (public)
 * @param model object on which data structure will be bounds (protected)
 * @param {IGenericRenderWindowInitialValues} [initialValues] (default: {})
 */
export function extend(publicAPI: object, model: object, initialValues?: IGenericRenderWindowInitialValues): void;

/**
 * Method used to create a new instance of vtkGenericRenderWindow
 * @param {IGenericRenderWindowInitialValues} [initialValues] for pre-setting some of its content
 */
export function newInstance(initialValues?: IGenericRenderWindowInitialValues): vtkGenericRenderWindow;

/**
 * vtkGenericRenderWindow provides a skeleton for implementing a render window
 * using one's own OpenGL context and drawable.
 */
export declare const vtkGenericRenderWindow: {
	newInstance: typeof newInstance;
	extend: typeof extend;
}
export default vtkGenericRenderWindow;