All files / core/src/types IEnabledElement.ts

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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
import type IRenderingEngine from './IRenderingEngine';
import type IStackViewport from './IStackViewport';
import type IVolumeViewport from './IVolumeViewport';
 
/**
 * Cornerstone Enabled Element interface
 */
interface IEnabledElement {
  /** Cornerstone Viewport instance - can be Stack or Volume, or Video Viewport as of now.
   * For the moment, need to cast to unknown first before casting to IVideoViewport
   * (TODO) - this will be done as part of adding annotation tools for video
   */
  viewport: IStackViewport | IVolumeViewport;
  /** Cornerstone Rendering Engine instance */
  renderingEngine: IRenderingEngine;
  /** Unique ID of the viewport in the renderingEngine */
  viewportId: string;
  /** Unique ID of the renderingEngine */
  renderingEngineId: string;
  /** FrameOfReference the enabledElement is rendering inside */
  FrameOfReferenceUID: string;
}
 
export type { IEnabledElement as default };