@shapediver/viewer.shared.services
Advanced tools
Comparing version
@@ -0,1 +1,2 @@ | ||
export declare type MainEventTypes = typeof EVENTTYPE_CAMERA | typeof EVENTTYPE_OUTPUT | typeof EVENTTYPE_RENDERING | typeof EVENTTYPE_SCENE | typeof EVENTTYPE_SESSION | typeof EVENTTYPE_PARAMETER | typeof EVENTTYPE_VIEWPORT | typeof EVENTTYPE_INTERACTION | typeof EVENTTYPE_DRAWING_TOOLS | typeof EVENTTYPE_TASK; | ||
/** | ||
@@ -23,94 +24,115 @@ * Event types for all camera events | ||
/** | ||
* Event types for all rendering events | ||
* The rendering events are used to notify about specific rendering events, like the finishing of the beauty rendering. | ||
* The events that are sent with the rendering events are of type {@link IRenderingEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
* Event types for all drawing tools events | ||
* The drawing tools events are used to notify about drawing tools changes, like cancel, finish, update, inserted, removed, drag start, move and end. | ||
* The events that are sent with the drawing tools events are of type {@link IDrawingToolsEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export declare enum EVENTTYPE_RENDERING { | ||
export declare enum EVENTTYPE_DRAWING_TOOLS { | ||
/** | ||
* The BEAUTY_RENDERING_FINISHED-event is sent when the beauty rendering has finished. | ||
* The CANCEL-event is sent when the drawing process has been canceled. | ||
*/ | ||
BEAUTY_RENDERING_FINISHED = "rendering.beautyRenderingFinished" | ||
} | ||
/** | ||
* Event types for all scene events | ||
* The scene events are used to notify about scene changes, like bounding box changes or empty bounding boxes. | ||
* The events that are sent with the scene events are of type {@link ISceneEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export declare enum EVENTTYPE_SCENE { | ||
CANCEL = "drawing_tools.cancel", | ||
/** | ||
* The SCENE_BOUNDING_BOX_CHANGE-event is sent when the bounding box of the scene has changed. | ||
* The FINISH-event is sent when the drawing process has been finished. | ||
*/ | ||
SCENE_BOUNDING_BOX_CHANGE = "scene.boundingBoxChange", | ||
FINISH = "drawing_tools.finish", | ||
/** | ||
* TheSCENE_BOUNDING_BOX_EMPTY-event is sent when the bounding box of the scene is empty. | ||
* The UPDATE-event is sent when the drawing process has been updated. | ||
*/ | ||
SCENE_BOUNDING_BOX_EMPTY = "scene.boundingBoxEmpty" | ||
} | ||
/** | ||
* Event types for all viewport events | ||
* The viewport events are used to notify about viewport changes, like creation, update, closing, visibility changes or loading of settings. | ||
* The events that are sent with the viewport events are of type {@link IViewportEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export declare enum EVENTTYPE_VIEWPORT { | ||
UPDATE = "drawing_tools.update", | ||
/** | ||
* The BUSY_MODE_ON-event is sent when the busy mode of the viewport has started. | ||
* The ADDED-event is sent when a point has been added. | ||
*/ | ||
BUSY_MODE_ON = "viewport.busy.on", | ||
ADDED = "drawing_tools.added", | ||
/** | ||
* The BUSY_MODE_OFF-event is sent when the busy mode of the viewport has ended. | ||
* The REMOVED-event is sent when a point has been removed. | ||
*/ | ||
BUSY_MODE_OFF = "viewport.busy.off", | ||
REMOVED = "drawing_tools.removed", | ||
/** | ||
* The VIEWPORT_CREATED-event is sent when the viewport has been created. | ||
* The MOVED-event is sent when a point has been moved. | ||
*/ | ||
VIEWPORT_CREATED = "viewport.created", | ||
MOVED = "drawing_tools.moved", | ||
/** | ||
* The VIEWPORT_UPDATED-event is sent when the viewport has been updated. | ||
* The SELECTED-event is sent when a point has been selected. | ||
*/ | ||
VIEWPORT_UPDATED = "viewport.updated", | ||
SELECTED = "drawing_tools.selected", | ||
/** | ||
* The VIEWPORT_CLOSED-event is sent when the viewport has been closed. | ||
* The DESELECTED-event is sent when a point has been deselected. | ||
*/ | ||
VIEWPORT_CLOSED = "viewport.closed", | ||
DESELECTED = "drawing_tools.deselected", | ||
/** | ||
* The VIEWPORT_SETTINGS_LOADED-event is sent when the settings of the viewport have been loaded. | ||
* The GEOMETRY_CHANGED-event is sent when the geometry has been changed. | ||
*/ | ||
VIEWPORT_SETTINGS_LOADED = "viewport.settingsLoaded", | ||
GEOMETRY_CHANGED = "drawing_tools.geometry.changed", | ||
/** | ||
* The VIEWPORT_VISIBLE-event is sent when the viewport has become visible. | ||
* The DRAG_START-event is sent when the dragging of a point has started. | ||
*/ | ||
VIEWPORT_VISIBLE = "viewport.visible", | ||
DRAG_START = "drawing_tools.drag.start", | ||
/** | ||
* The VIEWPORT_HIDDEN-event is sent when the viewport has become hidden. | ||
* The DRAG_MOVE-event is sent when a point is being dragged. | ||
*/ | ||
VIEWPORT_HIDDEN = "viewport.hidden" | ||
DRAG_MOVE = "drawing_tools.drag.move", | ||
/** | ||
* The DRAG_END-event is sent when the dragging of a point has ended. | ||
*/ | ||
DRAG_END = "drawing_tools.drag.end", | ||
/** | ||
* The MINIMUM_POINTS-event is sent when the minimum number of points has not been met. | ||
*/ | ||
MINIMUM_POINTS = "drawing_tools.minimumPoints", | ||
/** | ||
* The MAXIMUM_POINTS-event is sent when the maximum number of points has been exceeded. | ||
*/ | ||
MAXIMUM_POINTS = "drawing_tools.maximumPoints", | ||
/** | ||
* The UNCLOSED_LOOP-event is sent when the loop is not closed, but should be. | ||
*/ | ||
UNCLOSED_LOOP = "drawing_tools.unclosedLoop" | ||
} | ||
/** | ||
* Event types for all session events | ||
* The session events are used to notify about session changes, like creation, customization, closing, loading of initial outputs or delayed loading of SDTF. | ||
* The events that are sent with the session events are of type {@link ISessionEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
* Event types for all interaction events | ||
* The interaction events are used to notify about interaction changes, like drag start, move and end, hover on and off, select on and off. | ||
* The events that are sent with the interaction events are of type {@link IInteractionEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export declare enum EVENTTYPE_SESSION { | ||
export declare enum EVENTTYPE_INTERACTION { | ||
/** | ||
* The SESSION_CREATED-event is sent when the session has been created. | ||
* The DRAG_START-event is sent when the dragging of an object has started. | ||
*/ | ||
SESSION_CREATED = "session.created", | ||
DRAG_START = "interaction.drag.start", | ||
/** | ||
* The SESSION_CUSTOMIZED-event is sent when the session has been customized. | ||
* The DRAG_MOVE-event is sent when an object is being dragged. | ||
*/ | ||
SESSION_CUSTOMIZED = "session.customized", | ||
DRAG_MOVE = "interaction.drag.move", | ||
/** | ||
* The SESSION_CLOSED-event is sent when the session has been closed. | ||
* The DRAG_END-event is sent when the dragging of an object has ended. | ||
*/ | ||
SESSION_CLOSED = "session.closed", | ||
DRAG_END = "interaction.drag.end", | ||
/** | ||
* The SESSION_INITIAL_OUTPUTS_LOADED-event is sent when the initial outputs of the session have been loaded. | ||
* The HOVER_ON-event is sent when an object has been hovered. | ||
*/ | ||
SESSION_INITIAL_OUTPUTS_LOADED = "session.initialOutputsLoaded", | ||
HOVER_ON = "interaction.hover.on", | ||
/** | ||
* The SESSION_SDTF_DELAYED_LOADED-event is sent when the SDTF of the session has been delayed loaded. | ||
* The HOVER_OFF-event is sent when an object has been unhovered. | ||
*/ | ||
SESSION_SDTF_DELAYED_LOADED = "session.sdtfDelayedLoaded" | ||
HOVER_OFF = "interaction.hover.off", | ||
/** | ||
* The SELECT_ON-event is sent when an object has been selected. | ||
*/ | ||
SELECT_ON = "interaction.select.on", | ||
/** | ||
* The SELECT_OFF-event is sent when an object has been deselected. | ||
*/ | ||
SELECT_OFF = "interaction.select.off" | ||
} | ||
/** | ||
* Event types for all output events | ||
* The output events are used to notify about output changes, like updated outputs. | ||
* The events that are sent with the output events are of type {@link IOutputEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export declare enum EVENTTYPE_OUTPUT { | ||
/** | ||
* The OUTPUT_UPDATED-event is sent when an output has been updated. | ||
*/ | ||
OUTPUT_UPDATED = "output.updated" | ||
} | ||
/** | ||
* Event types for all parameter events | ||
@@ -131,108 +153,115 @@ * The parameter events are used to notify about parameter changes, like value changes or session value changes. | ||
/** | ||
* Event types for all output events | ||
* The output events are used to notify about output changes, like updated outputs. | ||
* The events that are sent with the output events are of type {@link IOutputEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
* Event types for all rendering events | ||
* The rendering events are used to notify about specific rendering events, like the finishing of the beauty rendering. | ||
* The events that are sent with the rendering events are of type {@link IRenderingEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export declare enum EVENTTYPE_OUTPUT { | ||
export declare enum EVENTTYPE_RENDERING { | ||
/** | ||
* The OUTPUT_UPDATED-event is sent when an output has been updated. | ||
* The BEAUTY_RENDERING_FINISHED-event is sent when the beauty rendering has finished. | ||
*/ | ||
OUTPUT_UPDATED = "output.updated" | ||
BEAUTY_RENDERING_FINISHED = "rendering.beautyRenderingFinished" | ||
} | ||
/** | ||
* Event types for all task events | ||
* The task events are used to notify about task changes, like start, process, end or cancel of a task. | ||
* The events that are sent with the task events are of type {@link ITaskEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
* Event types for all scene events | ||
* The scene events are used to notify about scene changes, like bounding box changes or empty bounding boxes. | ||
* The events that are sent with the scene events are of type {@link ISceneEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export declare enum EVENTTYPE_TASK { | ||
export declare enum EVENTTYPE_SCENE { | ||
/** | ||
* The TASK_START-event is sent when a task has started. | ||
* The SCENE_BOUNDING_BOX_CHANGE-event is sent when the bounding box of the scene has changed. | ||
*/ | ||
TASK_START = "task.start", | ||
SCENE_BOUNDING_BOX_CHANGE = "scene.boundingBoxChange", | ||
/** | ||
* The TASK_PROCESS-event is sent when the process of a task has been updated. | ||
* TheSCENE_BOUNDING_BOX_EMPTY-event is sent when the bounding box of the scene is empty. | ||
*/ | ||
TASK_PROCESS = "task.process", | ||
SCENE_BOUNDING_BOX_EMPTY = "scene.boundingBoxEmpty" | ||
} | ||
/** | ||
* Event types for all session events | ||
* The session events are used to notify about session changes, like creation, customization, closing, loading of initial outputs or delayed loading of SDTF. | ||
* The events that are sent with the session events are of type {@link ISessionEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export declare enum EVENTTYPE_SESSION { | ||
/** | ||
* The TASK_END-event is sent when a task has ended. | ||
* The SESSION_CREATED-event is sent when the session has been created. | ||
*/ | ||
TASK_END = "task.end", | ||
SESSION_CREATED = "session.created", | ||
/** | ||
* The TASK_CANCEL-event is sent when a task has been canceled. | ||
* The SESSION_CUSTOMIZED-event is sent when the session has been customized. | ||
*/ | ||
TASK_CANCEL = "task.cancel" | ||
} | ||
/** | ||
* Event types for all interaction events | ||
* The interaction events are used to notify about interaction changes, like drag start, move and end, hover on and off, select on and off. | ||
* The events that are sent with the interaction events are of type {@link IInteractionEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export declare enum EVENTTYPE_INTERACTION { | ||
SESSION_CUSTOMIZED = "session.customized", | ||
/** | ||
* The DRAG_START-event is sent when the dragging of an object has started. | ||
* The SESSION_CLOSED-event is sent when the session has been closed. | ||
*/ | ||
DRAG_START = "interaction.drag.start", | ||
SESSION_CLOSED = "session.closed", | ||
/** | ||
* The DRAG_MOVE-event is sent when an object is being dragged. | ||
* The SESSION_INITIAL_OUTPUTS_LOADED-event is sent when the initial outputs of the session have been loaded. | ||
*/ | ||
DRAG_MOVE = "interaction.drag.move", | ||
SESSION_INITIAL_OUTPUTS_LOADED = "session.initialOutputsLoaded", | ||
/** | ||
* The DRAG_END-event is sent when the dragging of an object has ended. | ||
* The SESSION_SDTF_DELAYED_LOADED-event is sent when the SDTF of the session has been delayed loaded. | ||
*/ | ||
DRAG_END = "interaction.drag.end", | ||
SESSION_SDTF_DELAYED_LOADED = "session.sdtfDelayedLoaded" | ||
} | ||
/** | ||
* Event types for all task events | ||
* The task events are used to notify about task changes, like start, process, end or cancel of a task. | ||
* The events that are sent with the task events are of type {@link ITaskEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export declare enum EVENTTYPE_TASK { | ||
/** | ||
* The HOVER_ON-event is sent when an object has been hovered. | ||
* The TASK_START-event is sent when a task has started. | ||
*/ | ||
HOVER_ON = "interaction.hover.on", | ||
TASK_START = "task.start", | ||
/** | ||
* The HOVER_OFF-event is sent when an object has been unhovered. | ||
* The TASK_PROCESS-event is sent when the process of a task has been updated. | ||
*/ | ||
HOVER_OFF = "interaction.hover.off", | ||
TASK_PROCESS = "task.process", | ||
/** | ||
* The SELECT_ON-event is sent when an object has been selected. | ||
* The TASK_END-event is sent when a task has ended. | ||
*/ | ||
SELECT_ON = "interaction.select.on", | ||
TASK_END = "task.end", | ||
/** | ||
* The SELECT_OFF-event is sent when an object has been deselected. | ||
* The TASK_CANCEL-event is sent when a task has been canceled. | ||
*/ | ||
SELECT_OFF = "interaction.select.off" | ||
TASK_CANCEL = "task.cancel" | ||
} | ||
/** | ||
* Event types for all drawing tools events | ||
* The drawing tools events are used to notify about drawing tools changes, like cancel, finish, update, inserted, removed, drag start, move and end. | ||
* The events that are sent with the drawing tools events are of type {@link IDrawingToolsEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
* Event types for all viewport events | ||
* The viewport events are used to notify about viewport changes, like creation, update, closing, visibility changes or loading of settings. | ||
* The events that are sent with the viewport events are of type {@link IViewportEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export declare enum EVENTTYPE_DRAWING_TOOLS { | ||
export declare enum EVENTTYPE_VIEWPORT { | ||
/** | ||
* The CANCEL-event is sent when the drawing process has been canceled. | ||
* The BUSY_MODE_ON-event is sent when the busy mode of the viewport has started. | ||
*/ | ||
CANCEL = "drawing_tools.cancel", | ||
BUSY_MODE_ON = "viewport.busy.on", | ||
/** | ||
* The FINISH-event is sent when the drawing process has been finished. | ||
* The BUSY_MODE_OFF-event is sent when the busy mode of the viewport has ended. | ||
*/ | ||
FINISH = "drawing_tools.finish", | ||
BUSY_MODE_OFF = "viewport.busy.off", | ||
/** | ||
* The UPDATE-event is sent when the drawing process has been updated. | ||
* The VIEWPORT_CREATED-event is sent when the viewport has been created. | ||
*/ | ||
UPDATE = "drawing_tools.update", | ||
VIEWPORT_CREATED = "viewport.created", | ||
/** | ||
* The INSERTED-event is sent when a point has been inserted. | ||
* The VIEWPORT_UPDATED-event is sent when the viewport has been updated. | ||
*/ | ||
INSERTED = "drawing_tools.inserted", | ||
VIEWPORT_UPDATED = "viewport.updated", | ||
/** | ||
* The REMOVED-event is sent when a point has been removed. | ||
* The VIEWPORT_CLOSED-event is sent when the viewport has been closed. | ||
*/ | ||
REMOVED = "drawing_tools.removed", | ||
VIEWPORT_CLOSED = "viewport.closed", | ||
/** | ||
* The DRAG_START-event is sent when the dragging of a point has started. | ||
* The VIEWPORT_SETTINGS_LOADED-event is sent when the settings of the viewport have been loaded. | ||
*/ | ||
DRAG_START = "drawing_tools.drag.start", | ||
VIEWPORT_SETTINGS_LOADED = "viewport.settingsLoaded", | ||
/** | ||
* The DRAG_MOVE-event is sent when a point is being dragged. | ||
* The VIEWPORT_VISIBLE-event is sent when the viewport has become visible. | ||
*/ | ||
DRAG_MOVE = "drawing_tools.drag.move", | ||
VIEWPORT_VISIBLE = "viewport.visible", | ||
/** | ||
* The DRAG_END-event is sent when the dragging of a point has ended. | ||
* The VIEWPORT_HIDDEN-event is sent when the viewport has become hidden. | ||
*/ | ||
DRAG_END = "drawing_tools.drag.end" | ||
VIEWPORT_HIDDEN = "viewport.hidden" | ||
} | ||
@@ -256,3 +285,2 @@ /** | ||
}; | ||
export declare type MainEventTypes = typeof EVENTTYPE_CAMERA | typeof EVENTTYPE_OUTPUT | typeof EVENTTYPE_RENDERING | typeof EVENTTYPE_SCENE | typeof EVENTTYPE_SESSION | typeof EVENTTYPE_PARAMETER | typeof EVENTTYPE_VIEWPORT | typeof EVENTTYPE_INTERACTION | typeof EVENTTYPE_DRAWING_TOOLS | typeof EVENTTYPE_TASK; | ||
//# sourceMappingURL=EventTypes.d.ts.map |
"use strict"; | ||
// #region Type aliases (1) | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.EVENTTYPE = exports.EVENTTYPE_DRAWING_TOOLS = exports.EVENTTYPE_INTERACTION = exports.EVENTTYPE_TASK = exports.EVENTTYPE_OUTPUT = exports.EVENTTYPE_PARAMETER = exports.EVENTTYPE_SESSION = exports.EVENTTYPE_VIEWPORT = exports.EVENTTYPE_SCENE = exports.EVENTTYPE_RENDERING = exports.EVENTTYPE_CAMERA = void 0; | ||
exports.EVENTTYPE = exports.EVENTTYPE_VIEWPORT = exports.EVENTTYPE_TASK = exports.EVENTTYPE_SESSION = exports.EVENTTYPE_SCENE = exports.EVENTTYPE_RENDERING = exports.EVENTTYPE_PARAMETER = exports.EVENTTYPE_OUTPUT = exports.EVENTTYPE_INTERACTION = exports.EVENTTYPE_DRAWING_TOOLS = exports.EVENTTYPE_CAMERA = void 0; | ||
// #endregion Type aliases (1) | ||
// #region Enums (10) | ||
/** | ||
@@ -27,2 +30,134 @@ * Event types for all camera events | ||
/** | ||
* Event types for all drawing tools events | ||
* The drawing tools events are used to notify about drawing tools changes, like cancel, finish, update, inserted, removed, drag start, move and end. | ||
* The events that are sent with the drawing tools events are of type {@link IDrawingToolsEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
var EVENTTYPE_DRAWING_TOOLS; | ||
(function (EVENTTYPE_DRAWING_TOOLS) { | ||
/** | ||
* The CANCEL-event is sent when the drawing process has been canceled. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["CANCEL"] = "drawing_tools.cancel"; | ||
/** | ||
* The FINISH-event is sent when the drawing process has been finished. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["FINISH"] = "drawing_tools.finish"; | ||
/** | ||
* The UPDATE-event is sent when the drawing process has been updated. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["UPDATE"] = "drawing_tools.update"; | ||
/** | ||
* The ADDED-event is sent when a point has been added. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["ADDED"] = "drawing_tools.added"; | ||
/** | ||
* The REMOVED-event is sent when a point has been removed. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["REMOVED"] = "drawing_tools.removed"; | ||
/** | ||
* The MOVED-event is sent when a point has been moved. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["MOVED"] = "drawing_tools.moved"; | ||
/** | ||
* The SELECTED-event is sent when a point has been selected. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["SELECTED"] = "drawing_tools.selected"; | ||
/** | ||
* The DESELECTED-event is sent when a point has been deselected. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["DESELECTED"] = "drawing_tools.deselected"; | ||
/** | ||
* The GEOMETRY_CHANGED-event is sent when the geometry has been changed. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["GEOMETRY_CHANGED"] = "drawing_tools.geometry.changed"; | ||
/** | ||
* The DRAG_START-event is sent when the dragging of a point has started. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["DRAG_START"] = "drawing_tools.drag.start"; | ||
/** | ||
* The DRAG_MOVE-event is sent when a point is being dragged. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["DRAG_MOVE"] = "drawing_tools.drag.move"; | ||
/** | ||
* The DRAG_END-event is sent when the dragging of a point has ended. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["DRAG_END"] = "drawing_tools.drag.end"; | ||
/** | ||
* The MINIMUM_POINTS-event is sent when the minimum number of points has not been met. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["MINIMUM_POINTS"] = "drawing_tools.minimumPoints"; | ||
/** | ||
* The MAXIMUM_POINTS-event is sent when the maximum number of points has been exceeded. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["MAXIMUM_POINTS"] = "drawing_tools.maximumPoints"; | ||
/** | ||
* The UNCLOSED_LOOP-event is sent when the loop is not closed, but should be. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["UNCLOSED_LOOP"] = "drawing_tools.unclosedLoop"; | ||
})(EVENTTYPE_DRAWING_TOOLS = exports.EVENTTYPE_DRAWING_TOOLS || (exports.EVENTTYPE_DRAWING_TOOLS = {})); | ||
/** | ||
* Event types for all interaction events | ||
* The interaction events are used to notify about interaction changes, like drag start, move and end, hover on and off, select on and off. | ||
* The events that are sent with the interaction events are of type {@link IInteractionEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
var EVENTTYPE_INTERACTION; | ||
(function (EVENTTYPE_INTERACTION) { | ||
/** | ||
* The DRAG_START-event is sent when the dragging of an object has started. | ||
*/ | ||
EVENTTYPE_INTERACTION["DRAG_START"] = "interaction.drag.start"; | ||
/** | ||
* The DRAG_MOVE-event is sent when an object is being dragged. | ||
*/ | ||
EVENTTYPE_INTERACTION["DRAG_MOVE"] = "interaction.drag.move"; | ||
/** | ||
* The DRAG_END-event is sent when the dragging of an object has ended. | ||
*/ | ||
EVENTTYPE_INTERACTION["DRAG_END"] = "interaction.drag.end"; | ||
/** | ||
* The HOVER_ON-event is sent when an object has been hovered. | ||
*/ | ||
EVENTTYPE_INTERACTION["HOVER_ON"] = "interaction.hover.on"; | ||
/** | ||
* The HOVER_OFF-event is sent when an object has been unhovered. | ||
*/ | ||
EVENTTYPE_INTERACTION["HOVER_OFF"] = "interaction.hover.off"; | ||
/** | ||
* The SELECT_ON-event is sent when an object has been selected. | ||
*/ | ||
EVENTTYPE_INTERACTION["SELECT_ON"] = "interaction.select.on"; | ||
/** | ||
* The SELECT_OFF-event is sent when an object has been deselected. | ||
*/ | ||
EVENTTYPE_INTERACTION["SELECT_OFF"] = "interaction.select.off"; | ||
})(EVENTTYPE_INTERACTION = exports.EVENTTYPE_INTERACTION || (exports.EVENTTYPE_INTERACTION = {})); | ||
/** | ||
* Event types for all output events | ||
* The output events are used to notify about output changes, like updated outputs. | ||
* The events that are sent with the output events are of type {@link IOutputEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
var EVENTTYPE_OUTPUT; | ||
(function (EVENTTYPE_OUTPUT) { | ||
/** | ||
* The OUTPUT_UPDATED-event is sent when an output has been updated. | ||
*/ | ||
EVENTTYPE_OUTPUT["OUTPUT_UPDATED"] = "output.updated"; | ||
})(EVENTTYPE_OUTPUT = exports.EVENTTYPE_OUTPUT || (exports.EVENTTYPE_OUTPUT = {})); | ||
/** | ||
* Event types for all parameter events | ||
* The parameter events are used to notify about parameter changes, like value changes or session value changes. | ||
* The events that are sent with the parameter events are of type {@link IParameterEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
var EVENTTYPE_PARAMETER; | ||
(function (EVENTTYPE_PARAMETER) { | ||
/** | ||
* The PARAMETER_VALUE_CHANGED-event is sent when the value of a parameter has changed. | ||
*/ | ||
EVENTTYPE_PARAMETER["PARAMETER_VALUE_CHANGED"] = "parameter.valueChanged"; | ||
/** | ||
* The PARAMETER_SESSION_VALUE_CHANGED-event is sent when the session value of a parameter has changed. | ||
*/ | ||
EVENTTYPE_PARAMETER["PARAMETER_SESSION_VALUE_CHANGED"] = "parameter.sessionValueChanged"; | ||
})(EVENTTYPE_PARAMETER = exports.EVENTTYPE_PARAMETER || (exports.EVENTTYPE_PARAMETER = {})); | ||
/** | ||
* Event types for all rendering events | ||
@@ -56,42 +191,2 @@ * The rendering events are used to notify about specific rendering events, like the finishing of the beauty rendering. | ||
/** | ||
* Event types for all viewport events | ||
* The viewport events are used to notify about viewport changes, like creation, update, closing, visibility changes or loading of settings. | ||
* The events that are sent with the viewport events are of type {@link IViewportEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
var EVENTTYPE_VIEWPORT; | ||
(function (EVENTTYPE_VIEWPORT) { | ||
/** | ||
* The BUSY_MODE_ON-event is sent when the busy mode of the viewport has started. | ||
*/ | ||
EVENTTYPE_VIEWPORT["BUSY_MODE_ON"] = "viewport.busy.on"; | ||
/** | ||
* The BUSY_MODE_OFF-event is sent when the busy mode of the viewport has ended. | ||
*/ | ||
EVENTTYPE_VIEWPORT["BUSY_MODE_OFF"] = "viewport.busy.off"; | ||
/** | ||
* The VIEWPORT_CREATED-event is sent when the viewport has been created. | ||
*/ | ||
EVENTTYPE_VIEWPORT["VIEWPORT_CREATED"] = "viewport.created"; | ||
/** | ||
* The VIEWPORT_UPDATED-event is sent when the viewport has been updated. | ||
*/ | ||
EVENTTYPE_VIEWPORT["VIEWPORT_UPDATED"] = "viewport.updated"; | ||
/** | ||
* The VIEWPORT_CLOSED-event is sent when the viewport has been closed. | ||
*/ | ||
EVENTTYPE_VIEWPORT["VIEWPORT_CLOSED"] = "viewport.closed"; | ||
/** | ||
* The VIEWPORT_SETTINGS_LOADED-event is sent when the settings of the viewport have been loaded. | ||
*/ | ||
EVENTTYPE_VIEWPORT["VIEWPORT_SETTINGS_LOADED"] = "viewport.settingsLoaded"; | ||
/** | ||
* The VIEWPORT_VISIBLE-event is sent when the viewport has become visible. | ||
*/ | ||
EVENTTYPE_VIEWPORT["VIEWPORT_VISIBLE"] = "viewport.visible"; | ||
/** | ||
* The VIEWPORT_HIDDEN-event is sent when the viewport has become hidden. | ||
*/ | ||
EVENTTYPE_VIEWPORT["VIEWPORT_HIDDEN"] = "viewport.hidden"; | ||
})(EVENTTYPE_VIEWPORT = exports.EVENTTYPE_VIEWPORT || (exports.EVENTTYPE_VIEWPORT = {})); | ||
/** | ||
* Event types for all session events | ||
@@ -125,30 +220,2 @@ * The session events are used to notify about session changes, like creation, customization, closing, loading of initial outputs or delayed loading of SDTF. | ||
/** | ||
* Event types for all parameter events | ||
* The parameter events are used to notify about parameter changes, like value changes or session value changes. | ||
* The events that are sent with the parameter events are of type {@link IParameterEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
var EVENTTYPE_PARAMETER; | ||
(function (EVENTTYPE_PARAMETER) { | ||
/** | ||
* The PARAMETER_VALUE_CHANGED-event is sent when the value of a parameter has changed. | ||
*/ | ||
EVENTTYPE_PARAMETER["PARAMETER_VALUE_CHANGED"] = "parameter.valueChanged"; | ||
/** | ||
* The PARAMETER_SESSION_VALUE_CHANGED-event is sent when the session value of a parameter has changed. | ||
*/ | ||
EVENTTYPE_PARAMETER["PARAMETER_SESSION_VALUE_CHANGED"] = "parameter.sessionValueChanged"; | ||
})(EVENTTYPE_PARAMETER = exports.EVENTTYPE_PARAMETER || (exports.EVENTTYPE_PARAMETER = {})); | ||
/** | ||
* Event types for all output events | ||
* The output events are used to notify about output changes, like updated outputs. | ||
* The events that are sent with the output events are of type {@link IOutputEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
var EVENTTYPE_OUTPUT; | ||
(function (EVENTTYPE_OUTPUT) { | ||
/** | ||
* The OUTPUT_UPDATED-event is sent when an output has been updated. | ||
*/ | ||
EVENTTYPE_OUTPUT["OUTPUT_UPDATED"] = "output.updated"; | ||
})(EVENTTYPE_OUTPUT = exports.EVENTTYPE_OUTPUT || (exports.EVENTTYPE_OUTPUT = {})); | ||
/** | ||
* Event types for all task events | ||
@@ -178,77 +245,43 @@ * The task events are used to notify about task changes, like start, process, end or cancel of a task. | ||
/** | ||
* Event types for all interaction events | ||
* The interaction events are used to notify about interaction changes, like drag start, move and end, hover on and off, select on and off. | ||
* The events that are sent with the interaction events are of type {@link IInteractionEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
* Event types for all viewport events | ||
* The viewport events are used to notify about viewport changes, like creation, update, closing, visibility changes or loading of settings. | ||
* The events that are sent with the viewport events are of type {@link IViewportEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
var EVENTTYPE_INTERACTION; | ||
(function (EVENTTYPE_INTERACTION) { | ||
var EVENTTYPE_VIEWPORT; | ||
(function (EVENTTYPE_VIEWPORT) { | ||
/** | ||
* The DRAG_START-event is sent when the dragging of an object has started. | ||
* The BUSY_MODE_ON-event is sent when the busy mode of the viewport has started. | ||
*/ | ||
EVENTTYPE_INTERACTION["DRAG_START"] = "interaction.drag.start"; | ||
EVENTTYPE_VIEWPORT["BUSY_MODE_ON"] = "viewport.busy.on"; | ||
/** | ||
* The DRAG_MOVE-event is sent when an object is being dragged. | ||
* The BUSY_MODE_OFF-event is sent when the busy mode of the viewport has ended. | ||
*/ | ||
EVENTTYPE_INTERACTION["DRAG_MOVE"] = "interaction.drag.move"; | ||
EVENTTYPE_VIEWPORT["BUSY_MODE_OFF"] = "viewport.busy.off"; | ||
/** | ||
* The DRAG_END-event is sent when the dragging of an object has ended. | ||
* The VIEWPORT_CREATED-event is sent when the viewport has been created. | ||
*/ | ||
EVENTTYPE_INTERACTION["DRAG_END"] = "interaction.drag.end"; | ||
EVENTTYPE_VIEWPORT["VIEWPORT_CREATED"] = "viewport.created"; | ||
/** | ||
* The HOVER_ON-event is sent when an object has been hovered. | ||
* The VIEWPORT_UPDATED-event is sent when the viewport has been updated. | ||
*/ | ||
EVENTTYPE_INTERACTION["HOVER_ON"] = "interaction.hover.on"; | ||
EVENTTYPE_VIEWPORT["VIEWPORT_UPDATED"] = "viewport.updated"; | ||
/** | ||
* The HOVER_OFF-event is sent when an object has been unhovered. | ||
* The VIEWPORT_CLOSED-event is sent when the viewport has been closed. | ||
*/ | ||
EVENTTYPE_INTERACTION["HOVER_OFF"] = "interaction.hover.off"; | ||
EVENTTYPE_VIEWPORT["VIEWPORT_CLOSED"] = "viewport.closed"; | ||
/** | ||
* The SELECT_ON-event is sent when an object has been selected. | ||
* The VIEWPORT_SETTINGS_LOADED-event is sent when the settings of the viewport have been loaded. | ||
*/ | ||
EVENTTYPE_INTERACTION["SELECT_ON"] = "interaction.select.on"; | ||
EVENTTYPE_VIEWPORT["VIEWPORT_SETTINGS_LOADED"] = "viewport.settingsLoaded"; | ||
/** | ||
* The SELECT_OFF-event is sent when an object has been deselected. | ||
* The VIEWPORT_VISIBLE-event is sent when the viewport has become visible. | ||
*/ | ||
EVENTTYPE_INTERACTION["SELECT_OFF"] = "interaction.select.off"; | ||
})(EVENTTYPE_INTERACTION = exports.EVENTTYPE_INTERACTION || (exports.EVENTTYPE_INTERACTION = {})); | ||
/** | ||
* Event types for all drawing tools events | ||
* The drawing tools events are used to notify about drawing tools changes, like cancel, finish, update, inserted, removed, drag start, move and end. | ||
* The events that are sent with the drawing tools events are of type {@link IDrawingToolsEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
var EVENTTYPE_DRAWING_TOOLS; | ||
(function (EVENTTYPE_DRAWING_TOOLS) { | ||
EVENTTYPE_VIEWPORT["VIEWPORT_VISIBLE"] = "viewport.visible"; | ||
/** | ||
* The CANCEL-event is sent when the drawing process has been canceled. | ||
* The VIEWPORT_HIDDEN-event is sent when the viewport has become hidden. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["CANCEL"] = "drawing_tools.cancel"; | ||
/** | ||
* The FINISH-event is sent when the drawing process has been finished. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["FINISH"] = "drawing_tools.finish"; | ||
/** | ||
* The UPDATE-event is sent when the drawing process has been updated. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["UPDATE"] = "drawing_tools.update"; | ||
/** | ||
* The INSERTED-event is sent when a point has been inserted. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["INSERTED"] = "drawing_tools.inserted"; | ||
/** | ||
* The REMOVED-event is sent when a point has been removed. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["REMOVED"] = "drawing_tools.removed"; | ||
/** | ||
* The DRAG_START-event is sent when the dragging of a point has started. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["DRAG_START"] = "drawing_tools.drag.start"; | ||
/** | ||
* The DRAG_MOVE-event is sent when a point is being dragged. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["DRAG_MOVE"] = "drawing_tools.drag.move"; | ||
/** | ||
* The DRAG_END-event is sent when the dragging of a point has ended. | ||
*/ | ||
EVENTTYPE_DRAWING_TOOLS["DRAG_END"] = "drawing_tools.drag.end"; | ||
})(EVENTTYPE_DRAWING_TOOLS = exports.EVENTTYPE_DRAWING_TOOLS || (exports.EVENTTYPE_DRAWING_TOOLS = {})); | ||
EVENTTYPE_VIEWPORT["VIEWPORT_HIDDEN"] = "viewport.hidden"; | ||
})(EVENTTYPE_VIEWPORT = exports.EVENTTYPE_VIEWPORT || (exports.EVENTTYPE_VIEWPORT = {})); | ||
// #endregion Enums (10) | ||
// #region Variables (1) | ||
/** | ||
@@ -271,2 +304,3 @@ * Definition of the event types. | ||
}; | ||
// #endregion Variables (1) | ||
//# sourceMappingURL=EventTypes.js.map |
{ | ||
"name": "@shapediver/viewer.shared.services", | ||
"version": "3.0.6", | ||
"version": "3.1.0", | ||
"description": "", | ||
@@ -45,3 +45,3 @@ "keywords": [], | ||
"@shapediver/viewer.settings": "1.0.2", | ||
"@shapediver/viewer.shared.build-data": "3.0.6", | ||
"@shapediver/viewer.shared.build-data": "3.1.0", | ||
"@types/dompurify": "^2.3.1", | ||
@@ -56,3 +56,3 @@ "@types/ua-parser-js": "^0.7.36", | ||
}, | ||
"gitHead": "c9a43ef749feeeb9b4825b6a25b37a06a62e78e9" | ||
"gitHead": "dd31ab0806a3c45b52a52ce9df975199c170a3e8" | ||
} |
@@ -0,1 +1,9 @@ | ||
// #region Type aliases (1) | ||
export type MainEventTypes = typeof EVENTTYPE_CAMERA | typeof EVENTTYPE_OUTPUT | typeof EVENTTYPE_RENDERING | typeof EVENTTYPE_SCENE | typeof EVENTTYPE_SESSION | typeof EVENTTYPE_PARAMETER | typeof EVENTTYPE_VIEWPORT | typeof EVENTTYPE_INTERACTION | typeof EVENTTYPE_DRAWING_TOOLS | typeof EVENTTYPE_TASK; | ||
// #endregion Type aliases (1) | ||
// #region Enums (10) | ||
/** | ||
@@ -24,98 +32,118 @@ * Event types for all camera events | ||
/** | ||
* Event types for all rendering events | ||
* The rendering events are used to notify about specific rendering events, like the finishing of the beauty rendering. | ||
* The events that are sent with the rendering events are of type {@link IRenderingEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
* Event types for all drawing tools events | ||
* The drawing tools events are used to notify about drawing tools changes, like cancel, finish, update, inserted, removed, drag start, move and end. | ||
* The events that are sent with the drawing tools events are of type {@link IDrawingToolsEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export enum EVENTTYPE_RENDERING { | ||
export enum EVENTTYPE_DRAWING_TOOLS { | ||
/** | ||
* The BEAUTY_RENDERING_FINISHED-event is sent when the beauty rendering has finished. | ||
* The CANCEL-event is sent when the drawing process has been canceled. | ||
*/ | ||
BEAUTY_RENDERING_FINISHED = 'rendering.beautyRenderingFinished' | ||
} | ||
/** | ||
* Event types for all scene events | ||
* The scene events are used to notify about scene changes, like bounding box changes or empty bounding boxes. | ||
* The events that are sent with the scene events are of type {@link ISceneEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export enum EVENTTYPE_SCENE { | ||
CANCEL = 'drawing_tools.cancel', | ||
/** | ||
* The SCENE_BOUNDING_BOX_CHANGE-event is sent when the bounding box of the scene has changed. | ||
* The FINISH-event is sent when the drawing process has been finished. | ||
*/ | ||
SCENE_BOUNDING_BOX_CHANGE = 'scene.boundingBoxChange', | ||
FINISH = 'drawing_tools.finish', | ||
/** | ||
* TheSCENE_BOUNDING_BOX_EMPTY-event is sent when the bounding box of the scene is empty. | ||
* The UPDATE-event is sent when the drawing process has been updated. | ||
*/ | ||
SCENE_BOUNDING_BOX_EMPTY = 'scene.boundingBoxEmpty' | ||
} | ||
/** | ||
* Event types for all viewport events | ||
* The viewport events are used to notify about viewport changes, like creation, update, closing, visibility changes or loading of settings. | ||
* The events that are sent with the viewport events are of type {@link IViewportEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export enum EVENTTYPE_VIEWPORT { | ||
UPDATE = 'drawing_tools.update', | ||
/** | ||
* The BUSY_MODE_ON-event is sent when the busy mode of the viewport has started. | ||
* The ADDED-event is sent when a point has been added. | ||
*/ | ||
BUSY_MODE_ON = 'viewport.busy.on', | ||
ADDED = 'drawing_tools.added', | ||
/** | ||
* The BUSY_MODE_OFF-event is sent when the busy mode of the viewport has ended. | ||
* The REMOVED-event is sent when a point has been removed. | ||
*/ | ||
BUSY_MODE_OFF = 'viewport.busy.off', | ||
REMOVED = 'drawing_tools.removed', | ||
/** | ||
* The VIEWPORT_CREATED-event is sent when the viewport has been created. | ||
* The MOVED-event is sent when a point has been moved. | ||
*/ | ||
VIEWPORT_CREATED = 'viewport.created', | ||
MOVED = 'drawing_tools.moved', | ||
/** | ||
* The VIEWPORT_UPDATED-event is sent when the viewport has been updated. | ||
* The SELECTED-event is sent when a point has been selected. | ||
*/ | ||
VIEWPORT_UPDATED = 'viewport.updated', | ||
SELECTED = 'drawing_tools.selected', | ||
/** | ||
* The VIEWPORT_CLOSED-event is sent when the viewport has been closed. | ||
* The DESELECTED-event is sent when a point has been deselected. | ||
*/ | ||
VIEWPORT_CLOSED = 'viewport.closed', | ||
DESELECTED = 'drawing_tools.deselected', | ||
/** | ||
* The VIEWPORT_SETTINGS_LOADED-event is sent when the settings of the viewport have been loaded. | ||
* The GEOMETRY_CHANGED-event is sent when the geometry has been changed. | ||
*/ | ||
VIEWPORT_SETTINGS_LOADED = 'viewport.settingsLoaded', | ||
GEOMETRY_CHANGED = 'drawing_tools.geometry.changed', | ||
/** | ||
* The VIEWPORT_VISIBLE-event is sent when the viewport has become visible. | ||
* The DRAG_START-event is sent when the dragging of a point has started. | ||
*/ | ||
VIEWPORT_VISIBLE = 'viewport.visible', | ||
DRAG_START = 'drawing_tools.drag.start', | ||
/** | ||
* The VIEWPORT_HIDDEN-event is sent when the viewport has become hidden. | ||
* The DRAG_MOVE-event is sent when a point is being dragged. | ||
*/ | ||
VIEWPORT_HIDDEN = 'viewport.hidden', | ||
DRAG_MOVE = 'drawing_tools.drag.move', | ||
/** | ||
* The DRAG_END-event is sent when the dragging of a point has ended. | ||
*/ | ||
DRAG_END = 'drawing_tools.drag.end', | ||
/** | ||
* The MINIMUM_POINTS-event is sent when the minimum number of points has not been met. | ||
*/ | ||
MINIMUM_POINTS = 'drawing_tools.minimumPoints', | ||
/** | ||
* The MAXIMUM_POINTS-event is sent when the maximum number of points has been exceeded. | ||
*/ | ||
MAXIMUM_POINTS = 'drawing_tools.maximumPoints', | ||
/** | ||
* The UNCLOSED_LOOP-event is sent when the loop is not closed, but should be. | ||
*/ | ||
UNCLOSED_LOOP = 'drawing_tools.unclosedLoop', | ||
} | ||
/** | ||
* Event types for all session events | ||
* The session events are used to notify about session changes, like creation, customization, closing, loading of initial outputs or delayed loading of SDTF. | ||
* The events that are sent with the session events are of type {@link ISessionEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
* Event types for all interaction events | ||
* The interaction events are used to notify about interaction changes, like drag start, move and end, hover on and off, select on and off. | ||
* The events that are sent with the interaction events are of type {@link IInteractionEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export enum EVENTTYPE_SESSION { | ||
export enum EVENTTYPE_INTERACTION { | ||
/** | ||
* The SESSION_CREATED-event is sent when the session has been created. | ||
* The DRAG_START-event is sent when the dragging of an object has started. | ||
*/ | ||
SESSION_CREATED = 'session.created', | ||
DRAG_START = 'interaction.drag.start', | ||
/** | ||
* The SESSION_CUSTOMIZED-event is sent when the session has been customized. | ||
* The DRAG_MOVE-event is sent when an object is being dragged. | ||
*/ | ||
SESSION_CUSTOMIZED = 'session.customized', | ||
DRAG_MOVE = 'interaction.drag.move', | ||
/** | ||
* The SESSION_CLOSED-event is sent when the session has been closed. | ||
* The DRAG_END-event is sent when the dragging of an object has ended. | ||
*/ | ||
SESSION_CLOSED = 'session.closed', | ||
DRAG_END = 'interaction.drag.end', | ||
/** | ||
* The SESSION_INITIAL_OUTPUTS_LOADED-event is sent when the initial outputs of the session have been loaded. | ||
* The HOVER_ON-event is sent when an object has been hovered. | ||
*/ | ||
SESSION_INITIAL_OUTPUTS_LOADED = 'session.initialOutputsLoaded', | ||
HOVER_ON = 'interaction.hover.on', | ||
/** | ||
* The SESSION_SDTF_DELAYED_LOADED-event is sent when the SDTF of the session has been delayed loaded. | ||
* The HOVER_OFF-event is sent when an object has been unhovered. | ||
*/ | ||
SESSION_SDTF_DELAYED_LOADED = 'session.sdtfDelayedLoaded', | ||
HOVER_OFF = 'interaction.hover.off', | ||
/** | ||
* The SELECT_ON-event is sent when an object has been selected. | ||
*/ | ||
SELECT_ON = 'interaction.select.on', | ||
/** | ||
* The SELECT_OFF-event is sent when an object has been deselected. | ||
*/ | ||
SELECT_OFF = 'interaction.select.off', | ||
} | ||
/** | ||
* Event types for all output events | ||
* The output events are used to notify about output changes, like updated outputs. | ||
* The events that are sent with the output events are of type {@link IOutputEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export enum EVENTTYPE_OUTPUT { | ||
/** | ||
* The OUTPUT_UPDATED-event is sent when an output has been updated. | ||
*/ | ||
OUTPUT_UPDATED = 'output.updated' | ||
} | ||
/** | ||
* Event types for all parameter events | ||
@@ -137,113 +165,125 @@ * The parameter events are used to notify about parameter changes, like value changes or session value changes. | ||
/** | ||
* Event types for all output events | ||
* The output events are used to notify about output changes, like updated outputs. | ||
* The events that are sent with the output events are of type {@link IOutputEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
* Event types for all rendering events | ||
* The rendering events are used to notify about specific rendering events, like the finishing of the beauty rendering. | ||
* The events that are sent with the rendering events are of type {@link IRenderingEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export enum EVENTTYPE_OUTPUT { | ||
export enum EVENTTYPE_RENDERING { | ||
/** | ||
* The OUTPUT_UPDATED-event is sent when an output has been updated. | ||
* The BEAUTY_RENDERING_FINISHED-event is sent when the beauty rendering has finished. | ||
*/ | ||
OUTPUT_UPDATED = 'output.updated' | ||
BEAUTY_RENDERING_FINISHED = 'rendering.beautyRenderingFinished' | ||
} | ||
/** | ||
* Event types for all task events | ||
* The task events are used to notify about task changes, like start, process, end or cancel of a task. | ||
* The events that are sent with the task events are of type {@link ITaskEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
* Event types for all scene events | ||
* The scene events are used to notify about scene changes, like bounding box changes or empty bounding boxes. | ||
* The events that are sent with the scene events are of type {@link ISceneEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export enum EVENTTYPE_TASK { | ||
export enum EVENTTYPE_SCENE { | ||
/** | ||
* The TASK_START-event is sent when a task has started. | ||
* The SCENE_BOUNDING_BOX_CHANGE-event is sent when the bounding box of the scene has changed. | ||
*/ | ||
TASK_START = 'task.start', | ||
SCENE_BOUNDING_BOX_CHANGE = 'scene.boundingBoxChange', | ||
/** | ||
* The TASK_PROCESS-event is sent when the process of a task has been updated. | ||
* TheSCENE_BOUNDING_BOX_EMPTY-event is sent when the bounding box of the scene is empty. | ||
*/ | ||
TASK_PROCESS = 'task.process', | ||
/** | ||
* The TASK_END-event is sent when a task has ended. | ||
*/ | ||
TASK_END = 'task.end', | ||
/** | ||
* The TASK_CANCEL-event is sent when a task has been canceled. | ||
*/ | ||
TASK_CANCEL = 'task.cancel', | ||
SCENE_BOUNDING_BOX_EMPTY = 'scene.boundingBoxEmpty' | ||
} | ||
/** | ||
* Event types for all interaction events | ||
* The interaction events are used to notify about interaction changes, like drag start, move and end, hover on and off, select on and off. | ||
* The events that are sent with the interaction events are of type {@link IInteractionEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
* Event types for all session events | ||
* The session events are used to notify about session changes, like creation, customization, closing, loading of initial outputs or delayed loading of SDTF. | ||
* The events that are sent with the session events are of type {@link ISessionEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export enum EVENTTYPE_INTERACTION { | ||
export enum EVENTTYPE_SESSION { | ||
/** | ||
* The DRAG_START-event is sent when the dragging of an object has started. | ||
* The SESSION_CREATED-event is sent when the session has been created. | ||
*/ | ||
DRAG_START = 'interaction.drag.start', | ||
SESSION_CREATED = 'session.created', | ||
/** | ||
* The DRAG_MOVE-event is sent when an object is being dragged. | ||
* The SESSION_CUSTOMIZED-event is sent when the session has been customized. | ||
*/ | ||
DRAG_MOVE = 'interaction.drag.move', | ||
SESSION_CUSTOMIZED = 'session.customized', | ||
/** | ||
* The DRAG_END-event is sent when the dragging of an object has ended. | ||
* The SESSION_CLOSED-event is sent when the session has been closed. | ||
*/ | ||
DRAG_END = 'interaction.drag.end', | ||
SESSION_CLOSED = 'session.closed', | ||
/** | ||
* The HOVER_ON-event is sent when an object has been hovered. | ||
* The SESSION_INITIAL_OUTPUTS_LOADED-event is sent when the initial outputs of the session have been loaded. | ||
*/ | ||
HOVER_ON = 'interaction.hover.on', | ||
SESSION_INITIAL_OUTPUTS_LOADED = 'session.initialOutputsLoaded', | ||
/** | ||
* The HOVER_OFF-event is sent when an object has been unhovered. | ||
* The SESSION_SDTF_DELAYED_LOADED-event is sent when the SDTF of the session has been delayed loaded. | ||
*/ | ||
HOVER_OFF = 'interaction.hover.off', | ||
SESSION_SDTF_DELAYED_LOADED = 'session.sdtfDelayedLoaded', | ||
} | ||
/** | ||
* Event types for all task events | ||
* The task events are used to notify about task changes, like start, process, end or cancel of a task. | ||
* The events that are sent with the task events are of type {@link ITaskEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export enum EVENTTYPE_TASK { | ||
/** | ||
* The SELECT_ON-event is sent when an object has been selected. | ||
* The TASK_START-event is sent when a task has started. | ||
*/ | ||
SELECT_ON = 'interaction.select.on', | ||
TASK_START = 'task.start', | ||
/** | ||
* The SELECT_OFF-event is sent when an object has been deselected. | ||
* The TASK_PROCESS-event is sent when the process of a task has been updated. | ||
*/ | ||
SELECT_OFF = 'interaction.select.off', | ||
TASK_PROCESS = 'task.process', | ||
/** | ||
* The TASK_END-event is sent when a task has ended. | ||
*/ | ||
TASK_END = 'task.end', | ||
/** | ||
* The TASK_CANCEL-event is sent when a task has been canceled. | ||
*/ | ||
TASK_CANCEL = 'task.cancel', | ||
} | ||
/** | ||
* Event types for all drawing tools events | ||
* The drawing tools events are used to notify about drawing tools changes, like cancel, finish, update, inserted, removed, drag start, move and end. | ||
* The events that are sent with the drawing tools events are of type {@link IDrawingToolsEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
* Event types for all viewport events | ||
* The viewport events are used to notify about viewport changes, like creation, update, closing, visibility changes or loading of settings. | ||
* The events that are sent with the viewport events are of type {@link IViewportEvent}. The {@link EventResponseMapping} can used to map the event type to the corresponding event interface. | ||
*/ | ||
export enum EVENTTYPE_DRAWING_TOOLS { | ||
export enum EVENTTYPE_VIEWPORT { | ||
/** | ||
* The CANCEL-event is sent when the drawing process has been canceled. | ||
* The BUSY_MODE_ON-event is sent when the busy mode of the viewport has started. | ||
*/ | ||
CANCEL = 'drawing_tools.cancel', | ||
BUSY_MODE_ON = 'viewport.busy.on', | ||
/** | ||
* The FINISH-event is sent when the drawing process has been finished. | ||
* The BUSY_MODE_OFF-event is sent when the busy mode of the viewport has ended. | ||
*/ | ||
FINISH = 'drawing_tools.finish', | ||
BUSY_MODE_OFF = 'viewport.busy.off', | ||
/** | ||
* The UPDATE-event is sent when the drawing process has been updated. | ||
* The VIEWPORT_CREATED-event is sent when the viewport has been created. | ||
*/ | ||
UPDATE = 'drawing_tools.update', | ||
VIEWPORT_CREATED = 'viewport.created', | ||
/** | ||
* The INSERTED-event is sent when a point has been inserted. | ||
* The VIEWPORT_UPDATED-event is sent when the viewport has been updated. | ||
*/ | ||
INSERTED = 'drawing_tools.inserted', | ||
VIEWPORT_UPDATED = 'viewport.updated', | ||
/** | ||
* The REMOVED-event is sent when a point has been removed. | ||
* The VIEWPORT_CLOSED-event is sent when the viewport has been closed. | ||
*/ | ||
REMOVED = 'drawing_tools.removed', | ||
VIEWPORT_CLOSED = 'viewport.closed', | ||
/** | ||
* The DRAG_START-event is sent when the dragging of a point has started. | ||
* The VIEWPORT_SETTINGS_LOADED-event is sent when the settings of the viewport have been loaded. | ||
*/ | ||
DRAG_START = 'drawing_tools.drag.start', | ||
VIEWPORT_SETTINGS_LOADED = 'viewport.settingsLoaded', | ||
/** | ||
* The DRAG_MOVE-event is sent when a point is being dragged. | ||
* The VIEWPORT_VISIBLE-event is sent when the viewport has become visible. | ||
*/ | ||
DRAG_MOVE = 'drawing_tools.drag.move', | ||
VIEWPORT_VISIBLE = 'viewport.visible', | ||
/** | ||
* The DRAG_END-event is sent when the dragging of a point has ended. | ||
* The VIEWPORT_HIDDEN-event is sent when the viewport has become hidden. | ||
*/ | ||
DRAG_END = 'drawing_tools.drag.end', | ||
VIEWPORT_HIDDEN = 'viewport.hidden', | ||
} | ||
// #endregion Enums (10) | ||
// #region Variables (1) | ||
/** | ||
@@ -254,7 +294,7 @@ * Definition of the event types. | ||
*/ | ||
export const EVENTTYPE = { | ||
CAMERA: EVENTTYPE_CAMERA, | ||
export const EVENTTYPE = { | ||
CAMERA: EVENTTYPE_CAMERA, | ||
OUTPUT: EVENTTYPE_OUTPUT, | ||
RENDERING: EVENTTYPE_RENDERING, | ||
SCENE: EVENTTYPE_SCENE, | ||
RENDERING: EVENTTYPE_RENDERING, | ||
SCENE: EVENTTYPE_SCENE, | ||
SESSION: EVENTTYPE_SESSION, | ||
@@ -268,2 +308,2 @@ PARAMETER: EVENTTYPE_PARAMETER, | ||
export type MainEventTypes = typeof EVENTTYPE_CAMERA | typeof EVENTTYPE_OUTPUT | typeof EVENTTYPE_RENDERING | typeof EVENTTYPE_SCENE | typeof EVENTTYPE_SESSION | typeof EVENTTYPE_PARAMETER | typeof EVENTTYPE_VIEWPORT | typeof EVENTTYPE_INTERACTION | typeof EVENTTYPE_DRAWING_TOOLS | typeof EVENTTYPE_TASK; | ||
// #endregion Variables (1) |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
380194
1.07%6113
1.63%+ Added
- Removed