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 | /**
* The events for cornerstoneTools3D Tools. Native Mouse and Keyboard events are
* captured, normalized, and re-triggered with a `CORNERSTONE_TOOLS` prefix. This
* allows us to handle events consistently across different browsers.
*
*/
enum Events {
///////////////////////////////////////
// Tools
///////////////////////////////////////
/**
* Triggers on the eventTarget when a new tools is activated.
*
* Make use of {@link EventTypes.ToolActivatedEventType | Tool Activated Event Type }
* for typing your event listeners for this tool activated event, and see what event
* detail is included in {@link EventTypes.ToolActivatedEventDetail | Tool Activated Event Detail}.
*/
TOOL_ACTIVATED = 'CORNERSTONE_TOOLS_TOOL_ACTIVATED',
// fired when a viewport is added to the toolGroup
TOOLGROUP_VIEWPORT_ADDED = 'CORNERSTONE_TOOLS_TOOLGROUP_VIEWPORT_ADDED',
// fired when a viewport is removed from the toolGroup
TOOLGROUP_VIEWPORT_REMOVED = 'CORNERSTONE_TOOLS_TOOLGROUP_VIEWPORT_REMOVED',
/**
* Triggers on the eventTarget when a mode of a tool is changed (active, passive, enabled and disabled).
*
* Make use of {@link EventTypes.ToolModeChangedEventType | Tool Mode Changed Event Type }
* for typing your event listeners for this tool activated event, and see what event
* detail is included in {@link EventTypes.ToolModeChangedEventDetail | Tool Mode Changed Event Detail}.
*/
TOOL_MODE_CHANGED = 'CORNERSTONE_TOOLS_TOOL_MODE_CHANGED',
///////////////////////////////////////
// Annotations
///////////////////////////////////////
/**
* Triggers on the eventTarget when a new annotation is added to the state.
*
* Make use of {@link EventTypes.AnnotationAddedEventType | Annotation Added Event Type }
* for typing your event listeners for this annotation added event, and see what event
* detail is included in {@link EventTypes.AnnotationAddedEventDetail | Annotation Added Event Detail}.
*/
ANNOTATION_ADDED = 'CORNERSTONE_TOOLS_ANNOTATION_ADDED',
/**
* Triggers on the eventTarget when a new annotation is completed its drawing
* Make use of {@link EventTypes.AnnotationCompletedEventType | Annotation Completed Event Type }
* for typing your event listeners for this annotation completed event, and see what event
* detail is included in {@link EventTypes.AnnotationCompletedEventDetail | Annotation Completed Event Detail}.
*/
ANNOTATION_COMPLETED = 'CORNERSTONE_TOOLS_ANNOTATION_COMPLETED',
/**
* Triggers on the eventTarget when an annotation is modified (e.g. a handle is modified).
* Make use of {@link EventTypes.AnnotationModifiedEventType | Annotation Modified Event Type}
* for typing your event listeners for this annotation modified event, and see what
* event detail is included in {@link EventTypes.AnnotationModifiedEventDetail | Annotation Modified Event Detail}.
*/
ANNOTATION_MODIFIED = 'CORNERSTONE_TOOLS_ANNOTATION_MODIFIED',
/**
* Triggers on the eventTarget when an annotation is removed from the annotations manager.
* Make use of {@link EventTypes.AnnotationRemovedEventType | Annotation Removed Event Type}
* for typing your event listeners for this annotation removed event, and see what
* event detail is included in {@link EventTypes.AnnotationRemovedEventDetail | Annotation Removed Event Detail}.
*/
ANNOTATION_REMOVED = 'CORNERSTONE_TOOLS_ANNOTATION_REMOVED',
/**
* Triggers on the eventTarget when an annotation selection status is changed.
* Make use of {@link EventTypes.AnnotationSelectionChangeEventType | Annotation Selection Change Event Type}
* for typing your event listeners for this annotation selection change event, and see what
* event detail is included in {@link EventTypes.AnnotationSelectionChangeEventDetail | Annotation Selection Change Event Detail}.
*/
ANNOTATION_SELECTION_CHANGE = 'CORNERSTONE_TOOLS_ANNOTATION_SELECTION_CHANGE',
/**
* Triggers on the eventTarget when an annotation locked status is changed.
* Make use of {@link EventTypes.AnnotationLockChangeEventType | Annotation Lock Change Event Type}
* for typing your event listeners for this annotation lock change event, and see what
* event detail is included in {@link EventTypes.AnnotationLockChangeEventDetail | Annotation Lock Change Event Detail}.
*/
ANNOTATION_LOCK_CHANGE = 'CORNERSTONE_TOOLS_ANNOTATION_LOCK_CHANGE',
/**
* Triggers on the eventTarget when an annotation visible status is changed.
* Make use of {@link EventTypes.AnnotationVisibilityChangeEventType | Annotation Visible Change Event Type}
* for typing your event listeners for this annotation Hide change event, and see what
* event detail is included in {@link EventTypes.AnnotationVisibilityChangeEventDetail | Annotation Visible Change Event Detail}.
*/
ANNOTATION_VISIBILITY_CHANGE = 'CORNERSTONE_TOOLS_ANNOTATION_VISIBILITY_CHANGE',
/**
* Triggers on the eventTarget when an annotation is rendered.
* Make use of {@link EventTypes.AnnotationRenderedEventType | Annotation Rendered Event Type}
* for typing your event listeners for this annotation rendered event, and see what
* event detail is included in {@link EventTypes.AnnotationRenderedEventDetail | Annotation Rendered Event Detail}.
*/
ANNOTATION_RENDERED = 'CORNERSTONE_TOOLS_ANNOTATION_RENDERED',
/**
* Triggers on the eventTarget when an annotation interpolation process completed.
* Make use of {@link EventTypes.AnnotationInterpolationCompletedEventType | Annotation Interpolation process Completed Event Type}
* for typing your event listeners for this annotation interpolation complete event, and see what
* event detail is included in {@link EventTypes.AnnotationInterpolationCompletedEventDetail | Annotation interpolation process Event Detail}.
*/
ANNOTATION_INTERPOLATION_PROCESS_COMPLETED = 'CORNERSTONE_TOOLS_ANNOTATION_INTERPOLATION_PROCESS_COMPLETED',
/**
* Triggers on the eventTarget when interpolated annotations are removed.
* Make use of {@link EventTypes.AnnotationInterpolationRemovedEventType | Annotation Interpolation Removed Event Type}
* for typing your event listeners for this interpolated annotation removed event, and see what
* event detail is included in {@link EventTypes.AnnotationInterpolationRemovedEventDetail | Annotation interpolation removed Event Detail}.
*/
INTERPOLATED_ANNOTATIONS_REMOVED = 'CORNERSTONE_TOOLS_INTERPOLATED_ANNOTATIONS_REMOVED',
///////////////////////////////////////
// Segmentations Events
///////////////////////////////////////
/**
* Triggers on the eventTarget when a Segmentation is updated in the state manager.
* Make use of {@link EventTypes.SegmentationModifiedEventType | Segmentation Modified Event Type}
* for typing your event listeners for this segmentation modified event, and see what
* event detail is included in {@link EventTypes.SegmentationModifiedEventDetail | Segmentation Modified Event Detail}.
*/
SEGMENTATION_MODIFIED = 'CORNERSTONE_TOOLS_SEGMENTATION_MODIFIED',
/**
* Triggers on the eventTarget when a Segmentation is rendered by the Segmentation Rendering Engine.
* Make use of {@link EventTypes.SegmentationRenderedEventType | Segmentation Rendered Event Type}
* for typing your event listeners for this segmentation rendered event, and see what
* event detail is included in {@link EventTypes.SegmentationRenderedEventDetail | Segmentation Rendered Event Detail}.
*/
SEGMENTATION_RENDERED = 'CORNERSTONE_TOOLS_SEGMENTATION_RENDERED',
/**
* Triggers on the eventTarget when a Segmentation representation of a toolGroup is modified in the state manager.
* Make use of {@link EventTypes.SegmentationRepresentationModifiedEventType | Segmentation Representation Modified Event Type}
* for typing your event listeners for this segmentation representation modified event, and see what
* event detail is included in {@link EventTypes.SegmentationRepresentationModifiedEventDetail | Segmentation Representation Modified Event Detail}.
*/
SEGMENTATION_REPRESENTATION_MODIFIED = 'CORNERSTONE_TOOLS_SEGMENTATION_REPRESENTATION_MODIFIED',
/**
* Triggers on the eventTarget when a Segmentation is removed from the state manager.
* Make use of {@link EventTypes.SegmentationRemovedEventType | Segmentation Removed Event Type}
* for typing your event listeners for this segmentation removed event, and see what
* event detail is included in {@link EventTypes.SegmentationRemovedEventDetail | Segmentation Removed Event Detail}.
*/
SEGMENTATION_REMOVED = 'CORNERSTONE_TOOLS_SEGMENTATION_REMOVED',
/**
* Triggers on the eventTarget when a Segmentation representation of a toolGroup is removed in the state manager.
* Make use of {@link EventTypes.SegmentationRepresentationRemovedEventType | Segmentation Representation Removed Event Type}
* for typing your event listeners for this segmentation representation removed event, and see what
* event detail is included in {@link EventTypes.SegmentationRepresentationRemovedEventDetail | Segmentation Representation Removed Event Detail}.
*/
SEGMENTATION_REPRESENTATION_REMOVED = 'CORNERSTONE_TOOLS_SEGMENTATION_REPRESENTATION_REMOVED',
/**
* Triggers on the eventTarget when a Segmentation data is modified (e.g., by brush tool).
* Make use of {@link EventTypes.SegmentationDataModifiedEventType | Segmentation Data Modified Event Type}
* for typing your event listeners for this segmentation data modified event, and see what
* event detail is included in {@link EventTypes.SegmentationDataModifiedEventDetail | Segmentation Data Modified Event Detail}.
*/
SEGMENTATION_DATA_MODIFIED = 'CORNERSTONE_TOOLS_SEGMENTATION_DATA_MODIFIED',
///////////////////////////////////////
// Keyboard Events
///////////////////////////////////////
/**
* Triggers on the eventTarget when a key on the keyboard is pressed.
* Make use of {@link EventTypes.KeyDownEventType | Key Down Event Type}
* for typing your event listeners for this key down event, and see what
* event detail is included in {@link EventTypes.KeyDownEventDetail | Key Down Event Detail}.
*/
KEY_DOWN = 'CORNERSTONE_TOOLS_KEY_DOWN',
/**
* Triggers on the eventTarget when a key on the keyboard is released.
* Make use of {@link EventTypes.KeyUpEventType | Key Up Event Type}
* for typing your event listeners for this key up event, and see what
* event detail is included in {@link EventTypes.KeyUpEventDetail | Key Up Event Detail}.
*/
KEY_UP = 'CORNERSTONE_TOOLS_KEY_UP',
///////////////////////////////////////
// Mouse Events
///////////////////////////////////////
/**
* Triggers on the eventTarget when the mouse is pressed down, it is CornerstoneTools normalized event.
* Make use of {@link EventTypes.MouseDownEventType | Mouse Down Event Type}
* for typing your event listeners for this mouse down event, and see what
* event detail is included in {@link EventTypes.MouseDownEventDetail | Mouse Down Event Detail}.
*/
MOUSE_DOWN = 'CORNERSTONE_TOOLS_MOUSE_DOWN',
/**
* Triggers on the eventTarget when the mouse is released, it is CornerstoneTools normalized event.
* Make use of {@link EventTypes.MouseUpEventType | Mouse Up Event Type}
* for typing your event listeners for this mouse up event, and see what
* event detail is included in {@link EventTypes.MouseUpEventDetail | Mouse Up Event Detail}.
*/
MOUSE_UP = 'CORNERSTONE_TOOLS_MOUSE_UP',
/**
* Triggers on the eventTarget when a handled `MOUSE_DOWN` event does not `stopPropagation`. The hook
* we use to create new annotation for mouse events.
* Make use of {@link EventTypes.MouseDownActivateEventType | Mouse Down Activate Event Type}
* for typing your event listeners for this mouse down activate event, and see what
* event detail is included in {@link EventTypes.MouseDownActivateEventDetail | Mouse Down Activate Event Detail}.
*/
MOUSE_DOWN_ACTIVATE = 'CORNERSTONE_TOOLS_MOUSE_DOWN_ACTIVATE',
/**
* Triggers on the event target when mouse is dragging an annotation or textBox.
* Make use of {@link EventTypes.MouseDragEventType | Mouse Drag Event Type}
* for typing your event listeners for this mouse drag event, and see what
* event detail is included in {@link EventTypes.MouseDragEventDetail | Mouse Drag Event Detail}.
*/
MOUSE_DRAG = 'CORNERSTONE_TOOLS_MOUSE_DRAG',
/**
* Triggers on the eventTarget, when the mouse is moved, it is CornerstoneTools normalized event.
* It can be just a mouse move or when double click is performed and annotation
* drawing can be performed with just mouse move.
* Make use of {@link EventTypes.MouseMoveEventType | Mouse Move Event Type}
* for typing your event listeners for this mouse move event, and see what
* event detail is included in {@link EventTypes.MouseMoveEventDetail | Mouse Move Event Detail}.
*/
MOUSE_MOVE = 'CORNERSTONE_TOOLS_MOUSE_MOVE',
/**
* Triggers on the eventTarget when a mouse click is detected. It is CornerstoneTools normalized event.
* Make use of {@link EventTypes.MouseClickEventType | Mouse Click Event Type}
* for typing your event listeners for this mouse click event, and see what
* event detail is included in {@link EventTypes.MouseClickEventDetail | Mouse Click Event Detail}.
*/
MOUSE_CLICK = 'CORNERSTONE_TOOLS_MOUSE_CLICK',
/**
* Triggers on the eventTarget when a mouse double click is detected. It is CornerstoneTools normalized event.
* Make use of {@link EventTypes.MouseDoubleClickEventType | Mouse Double Click Event Type}
* for typing your event listeners for this mouse double click event, and see what
* event detail is included in {@link EventTypes.MouseDoubleClickEventDetail | Mouse Double Click Event Detail}.
*/
MOUSE_DOUBLE_CLICK = 'CORNERSTONE_TOOLS_MOUSE_DOUBLE_CLICK',
/**
* Triggers on the eventTarget when a mouse wheel event is detected. It is CornerstoneTools normalized event.
* Make use of {@link EventTypes.MouseWheelEventType | Mouse Wheel Event Type}
* for typing your event listeners for this mouse wheel event, and see what
* event detail is included in {@link EventTypes.MouseWheelEventDetail | Mouse Wheel Event Detail}.
*/
MOUSE_WHEEL = 'CORNERSTONE_TOOLS_MOUSE_WHEEL',
// Todo: not being fired as of now
// ANNOTATION_COMPLETED = 'CORNERSTONE_TOOLS_ANNOTATION_COMPLETED',
// Todo: not implemented yet
// KEY_PRESS = 'CORNERSTONE_TOOLS_KEY_PRESS',
//////////////////////
// Touch Events //
//////////////////////
// The event flow looks like the following
// Touch Start -> (optional) Touch Press -> Touch Drag -> (optional) Touch Swipe -> Touch End
// Touch Tap
// mousedown
// mousedown, Touch Start, and Tap are mutually exclusive events
TOUCH_START = 'CORNERSTONE_TOOLS_TOUCH_START',
TOUCH_START_ACTIVATE = 'CORNERSTONE_TOOLS_TOUCH_START_ACTIVATE',
TOUCH_PRESS = 'CORNERSTONE_TOOLS_TOUCH_PRESS',
TOUCH_DRAG = 'CORNERSTONE_TOOLS_TOUCH_DRAG',
TOUCH_END = 'CORNERSTONE_TOOLS_TOUCH_END',
TOUCH_TAP = 'CORNERSTONE_TOOLS_TAP',
TOUCH_SWIPE = 'CORNERSTONE_TOOLS_SWIPE',
}
export default Events;
|