All files / packages/core/src/RenderingEngine getRenderingEngine.ts

100% Statements 2/2
100% Branches 0/0
100% Functions 2/2
100% Lines 2/2

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35                                            2469x               181x        
import renderingEngineCache from './renderingEngineCache';
import type { IRenderingEngine } from '../types';
 
/**
 * Method to retrieve a RenderingEngine by its unique identifier.
 *
 * @example
 * How to get a RenderingEngine that was created earlier:
 * ```javascript
 * import { RenderingEngine, getRenderingEngine } from 'vtkjs-viewport';
 *
 * const renderingEngine = new RenderingEngine('my-engine');
 *
 * // getting reference to rendering engine later...
 * const renderingEngine = getRenderingEngine('my-engine');
 * ```
 *
 * @param id - The identifier that was used to create the RenderingEngine
 * @returns the matching RenderingEngine, or `undefined` if there is no match
 * @public
 */
export function getRenderingEngine(id: string): IRenderingEngine | undefined {
  return renderingEngineCache.get(id);
}
 
/**
 * Get all the rendering engines that are currently registered
 * @returns An array of rendering engines.
 */
export function getRenderingEngines(): IRenderingEngine[] | undefined {
  return renderingEngineCache.getAll();
}
 
export default getRenderingEngine;