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 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 | 1x 1x 1x 1x | import { glMatrix, vec3 } from 'gl-matrix';
import {
utilities as csUtils,
getEnabledElement,
StackViewport,
VolumeViewport,
cache,
BaseVolumeViewport,
Enums,
} from '@cornerstonejs/core';
import { Types } from '@cornerstonejs/core';
import CINE_EVENTS from './events';
import { addToolState, getToolState, getToolStateByViewportId } from './state';
import { CINETypes } from '../../types';
import scroll from '../scroll';
const { ViewportStatus } = Enums;
const { triggerEvent } = csUtils;
const debounced = true;
const dynamicVolumesPlayingMap = new Map();
/**
* Starts playing a clip or adjusts the frame rate of an already playing clip. framesPerSecond is
* optional and defaults to 30 if not specified. A negative framesPerSecond will play the clip in reverse.
* The element must be a stack of images
* @param element - HTML Element
* @param framesPerSecond - Number of frames per second
*/
function playClip(
element: HTMLDivElement,
playClipOptions: CINETypes.PlayClipOptions
): void {
let playClipTimeouts;
let playClipIsTimeVarying;
if (element === undefined) {
throw new Error('playClip: element must not be undefined');
}
const enabledElement = getEnabledElement(element);
if (!enabledElement) {
throw new Error(
'playClip: element must be a valid Cornerstone enabled element'
);
}
if (!playClipOptions) {
playClipOptions = {};
}
// 4D Cine is enabled by default
playClipOptions.dynamicCineEnabled =
playClipOptions.dynamicCineEnabled ?? true;
const { viewport } = enabledElement;
const volume = _getVolumeFromViewport(viewport);
const playClipContext = _createCinePlayContext(viewport, playClipOptions);
let playClipData = getToolState(element);
const isDynamicCinePlaying =
playClipOptions.dynamicCineEnabled && volume?.isDynamicVolume();
// If user is trying to play CINE for a 4D volume it first needs
// to stop CINE that has may be playing for any other viewport.
if (isDynamicCinePlaying) {
_stopDynamicVolumeCine(element);
}
if (!playClipData) {
playClipData = {
intervalId: undefined,
framesPerSecond: 30,
lastFrameTimeStamp: undefined,
ignoreFrameTimeVector: false,
usingFrameTimeVector: false,
frameTimeVector: playClipOptions.frameTimeVector ?? undefined,
speed: playClipOptions.frameTimeVectorSpeedMultiplier ?? 1,
reverse: playClipOptions.reverse ?? false,
loop: playClipOptions.loop ?? true,
};
addToolState(element, playClipData);
} else {
// Make sure the specified clip is not running before any property update.
// If a 3D CINE was playing it passes isDynamicCinePlaying as FALSE to
// prevent stopping a 4D CINE in case it is playing on another viewport.
_stopClip(element, {
stopDynamicCine: !isDynamicCinePlaying,
viewportId: viewport.id,
});
}
playClipData.dynamicCineEnabled = playClipOptions.dynamicCineEnabled;
// If a framesPerSecond is specified and is valid, update the playClipData now
if (
playClipOptions.framesPerSecond < 0 ||
playClipOptions.framesPerSecond > 0
) {
playClipData.framesPerSecond = Number(playClipOptions.framesPerSecond);
playClipData.reverse = playClipData.framesPerSecond < 0;
// If framesPerSecond is given, frameTimeVector will be ignored...
playClipData.ignoreFrameTimeVector = true;
}
// Determine if frame time vector should be used instead of a fixed frame rate...
if (
playClipData.ignoreFrameTimeVector !== true &&
playClipData.frameTimeVector &&
playClipData.frameTimeVector.length === playClipContext.numScrollSteps &&
playClipContext.frameTimeVectorEnabled
) {
const { timeouts, isTimeVarying } = _getPlayClipTimeouts(
playClipData.frameTimeVector,
playClipData.speed
);
playClipTimeouts = timeouts;
playClipIsTimeVarying = isTimeVarying;
}
// This function encapsulates the frame rendering logic...
const playClipAction = () => {
const { numScrollSteps, currentStepIndex } = playClipContext;
let newStepIndex = currentStepIndex + (playClipData.reverse ? -1 : 1);
const newStepIndexOutOfRange =
newStepIndex < 0 || newStepIndex >= numScrollSteps;
if (!playClipData.loop && newStepIndexOutOfRange) {
// If a 3D CINE was playing it passes isDynamicCinePlaying as FALSE to
// prevent stopping a 4D CINE in case it is playing on another viewport.
_stopClip(element, {
stopDynamicCine: !isDynamicCinePlaying,
viewportId: viewport.id,
});
const eventDetail = { element };
triggerEvent(element, CINE_EVENTS.CLIP_STOPPED, eventDetail);
return;
}
// Loop around if newStepIndex is out of range
if (newStepIndex >= numScrollSteps) {
newStepIndex = 0;
} else if (newStepIndex < 0) {
newStepIndex = numScrollSteps - 1;
}
const delta = newStepIndex - currentStepIndex;
if (delta) {
playClipContext.scroll(delta);
}
};
if (isDynamicCinePlaying) {
dynamicVolumesPlayingMap.set(volume.volumeId, element);
}
// If playClipTimeouts array is available, not empty and its elements are NOT uniform ...
// ... (at least one timeout is different from the others), use alternate setTimeout implementation
if (
playClipTimeouts &&
playClipTimeouts.length > 0 &&
playClipIsTimeVarying
) {
playClipData.usingFrameTimeVector = true;
playClipData.intervalId = window.setTimeout(
function playClipTimeoutHandler() {
playClipData.intervalId = window.setTimeout(
playClipTimeoutHandler,
playClipTimeouts[playClipContext.currentStepIndex]
);
playClipAction();
},
0
);
} else {
// ... otherwise user setInterval implementation which is much more efficient.
playClipData.usingFrameTimeVector = false;
playClipData.intervalId = window.setInterval(
playClipAction,
1000 / Math.abs(playClipData.framesPerSecond)
);
}
const eventDetail = {
element,
};
triggerEvent(element, CINE_EVENTS.CLIP_STARTED, eventDetail);
}
/**
* Stops an already playing clip.
* @param element - HTML Element
*/
function stopClip(element: HTMLDivElement, options = {} as any): void {
_stopClip(element, {
stopDynamicCine: true,
...options,
});
}
function _stopClip(
element: HTMLDivElement,
options = { stopDynamicCine: true, viewportId: undefined }
) {
const { stopDynamicCine, viewportId } = options;
const enabledElement = getEnabledElement(element);
let toolState;
if (!enabledElement) {
if (viewportId) {
toolState = getToolStateByViewportId(viewportId);
} else {
return;
}
} else {
const { viewport } = enabledElement;
toolState = getToolState(viewport.element);
}
if (toolState) {
_stopClipWithData(toolState);
}
if (
stopDynamicCine &&
enabledElement?.viewport instanceof BaseVolumeViewport
) {
_stopDynamicVolumeCine(element);
}
}
/**
* [private] Stops any CINE playing for the dynamic volume loaded on this viewport
* @param element - HTML Element
*/
function _stopDynamicVolumeCine(element) {
const { viewport } = getEnabledElement(element);
const volume = _getVolumeFromViewport(viewport);
// If the current viewport has a 4D volume loaded it may be playing
// if it is also loaded on another viewport and user has started CINE
// for that one. This guarantees the other viewport will also be stopped.
if (volume?.isDynamicVolume()) {
const dynamicCineElement = dynamicVolumesPlayingMap.get(volume.volumeId);
dynamicVolumesPlayingMap.delete(volume.volumeId);
if (dynamicCineElement && dynamicCineElement !== element) {
stopClip(<HTMLDivElement>dynamicCineElement);
}
}
}
/**
* [private] Turns a Frame Time Vector (0018,1065) array into a normalized array of timeouts. Each element
* ... of the resulting array represents the amount of time each frame will remain on the screen.
* @param vector - A Frame Time Vector (0018,1065) as specified in section C.7.6.5.1.2 of DICOM standard.
* @param speed - A speed factor which will be applied to each element of the resulting array.
* @returns An array with timeouts for each animation frame.
*/
function _getPlayClipTimeouts(vector: number[], speed: number) {
let i;
let sample;
let delay;
let sum = 0;
const limit = vector.length;
const timeouts = [];
// Initialize time varying to false
let isTimeVarying = false;
if (typeof speed !== 'number' || speed <= 0) {
speed = 1;
}
// First element of a frame time vector must be discarded
for (i = 1; i < limit; i++) {
// eslint-disable-next-line no-bitwise
delay = (Number(vector[i]) / speed) | 0; // Integral part only
timeouts.push(delay);
if (i === 1) {
// Use first item as a sample for comparison
sample = delay;
} else if (delay !== sample) {
isTimeVarying = true;
}
sum += delay;
}
if (timeouts.length > 0) {
if (isTimeVarying) {
// If it's a time varying vector, make the last item an average...
// eslint-disable-next-line no-bitwise
delay = (sum / timeouts.length) | 0;
} else {
delay = timeouts[0];
}
timeouts.push(delay);
}
return { timeouts, isTimeVarying };
}
/**
* [private] Performs the heavy lifting of stopping an ongoing animation.
* @param element - HTML Element
* @param playClipData - The data from playClip that needs to be stopped.
*/
function _stopClipWithData(playClipData) {
const id = playClipData.intervalId;
if (typeof id !== 'undefined') {
playClipData.intervalId = undefined;
if (playClipData.usingFrameTimeVector) {
clearTimeout(id);
} else {
clearInterval(id);
}
}
}
function _getVolumesFromViewport(viewport): Types.IImageVolume[] {
return viewport
.getActors()
.map((actor) => cache.getVolume(actor.uid))
.filter((volume) => !!volume);
}
function _getVolumeFromViewport(viewport): Types.IImageVolume {
const volumes = _getVolumesFromViewport(viewport);
const dynamicVolume = volumes.find((volume) => volume.isDynamicVolume());
return dynamicVolume ?? volumes[0];
}
function _createStackViewportCinePlayContext(
viewport: StackViewport,
waitForRendered: number
): CINETypes.CinePlayContext {
const imageIds = viewport.getImageIds();
return {
get numScrollSteps(): number {
return imageIds.length;
},
get currentStepIndex(): number {
return viewport.getTargetImageIdIndex();
},
get frameTimeVectorEnabled(): boolean {
// It is always in acquired orientation
return true;
},
waitForRenderedCount: 0,
scroll(delta: number): void {
if (
this.waitForRenderedCount <= waitForRendered &&
viewport.viewportStatus !== ViewportStatus.RENDERED
) {
this.waitForRenderedCount++;
return;
}
this.waitForRenderedCount = 0;
scroll(viewport, { delta, debounceLoading: debounced });
},
};
}
function _createVolumeViewportCinePlayContext(
viewport: VolumeViewport,
volume: Types.IImageVolume
): CINETypes.CinePlayContext {
const { volumeId } = volume;
const cachedScrollInfo = {
viewPlaneNormal: vec3.create(),
scrollInfo: null,
};
const getScrollInfo = () => {
const camera = viewport.getCamera();
const updateCache =
!cachedScrollInfo.scrollInfo ||
!vec3.equals(camera.viewPlaneNormal, cachedScrollInfo.viewPlaneNormal);
// Number of steps would change only after rotating the volume so it
// caches the result and recomputes only when necessary. Until it is
// rotated the current frame is updated locally
if (updateCache) {
const scrollInfo = csUtils.getVolumeViewportScrollInfo(
viewport,
volumeId
);
cachedScrollInfo.viewPlaneNormal = camera.viewPlaneNormal;
cachedScrollInfo.scrollInfo = scrollInfo;
}
return cachedScrollInfo.scrollInfo;
};
return {
get numScrollSteps(): number {
return getScrollInfo().numScrollSteps;
},
get currentStepIndex(): number {
return getScrollInfo().currentStepIndex;
},
get frameTimeVectorEnabled(): boolean {
const camera = viewport.getCamera();
const volumeViewPlaneNormal = volume.direction
.slice(6, 9)
.map((x) => -x) as Types.Point3;
const dot = vec3.dot(volumeViewPlaneNormal, camera.viewPlaneNormal);
// Check if the volume is in acquired orientation
// it may be flipped or rotated in plane
return glMatrix.equals(dot, 1);
},
scroll(delta: number): void {
getScrollInfo().currentStepIndex += delta;
scroll(viewport, { delta });
},
};
}
function _createDynamicVolumeViewportCinePlayContext(
volume: Types.IDynamicImageVolume
): CINETypes.CinePlayContext {
return {
get numScrollSteps(): number {
return volume.numTimePoints;
},
get currentStepIndex(): number {
return volume.timePointIndex;
},
get frameTimeVectorEnabled(): boolean {
// Looping throught time does not uses frameTimeVector
return false;
},
scroll(delta: number): void {
// Updating this property (setter) makes it move to the desired time point
volume.timePointIndex += delta;
},
};
}
function _createCinePlayContext(
viewport,
playClipOptions: CINETypes.PlayClipOptions
): CINETypes.CinePlayContext {
if (viewport instanceof StackViewport) {
return _createStackViewportCinePlayContext(
viewport,
playClipOptions.waitForRendered ?? 30
);
}
if (viewport instanceof VolumeViewport) {
const volume = _getVolumeFromViewport(viewport);
if (playClipOptions.dynamicCineEnabled && volume?.isDynamicVolume()) {
return _createDynamicVolumeViewportCinePlayContext(
<Types.IDynamicImageVolume>volume
);
}
return _createVolumeViewportCinePlayContext(viewport, volume);
}
throw new Error('Unknown viewport type');
}
export { playClip, stopClip };
|