Ma/ueblueprint
1
0
Fork 0
mirror of https://github.com/barsdeveloper/ueblueprint.git synced 2026-06-11 04:53:13 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix other interface classes naming convention

Browse Source
This commit is contained in:
barsdeveloper
2022-02-27 13:02:21 +01:00
parent e8946745d6
commit b48b1228f4
29 changed files with 535 additions and 535 deletions
Download Patch File Download Diff File Expand all files Collapse all files

278
js/input/mouse/MouseClickDrag.js → js/input/mouse/IMouseClickDrag.js Executable file → Normal file
View File

@@ -1,139 +1,139 @@
import Configuration from "../../Configuration"
import Pointing from "./Pointing"
/**
* This class manages the ui gesture of mouse click and drag. Tha actual operations are implemented by the subclasses.
*/
export default class MouseClickDrag extends Pointing {
/** @type {(e: MouseEvent) => void} */
#mouseDownHandler
/** @type {(e: MouseEvent) => void} */
#mouseStartedMovingHandler
/** @type {(e: MouseEvent) => void} */
#mouseMoveHandler
/** @type {(e: MouseEvent) => void} */
#mouseUpHandler
/** @type {Boolean} */
#trackingMouse = false
constructor(target, blueprint, options) {
super(target, blueprint, options)
this.clickButton = options?.clickButton ?? 0
this.exitAnyButton = options?.exitAnyButton ?? true
this.moveEverywhere = options?.moveEverywhere ?? false
this.looseTarget = options?.looseTarget ?? false
this.consumeClickEvent = options?.consumeClickEvent ?? true
this.started = false
this.clickedPosition = [0, 0]
const movementListenedElement = this.moveEverywhere ? document.documentElement : this.movementSpace
let self = this
this.#mouseDownHandler = e => {
this.blueprint.setFocused(true)
switch (e.button) {
case self.clickButton:
// Either doesn't matter or consider the click only when clicking on the parent, not descandants
if (self.looseTarget || e.target == e.currentTarget) {
e.preventDefault()
if (this.consumeClickEvent) {
e.stopImmediatePropagation() // Captured, don't call anyone else
}
self.started = false
// Attach the listeners
movementListenedElement.addEventListener("mousemove", self.#mouseStartedMovingHandler)
document.addEventListener("mouseup", self.#mouseUpHandler)
self.clickedPosition = self.locationFromEvent(e)
self.clicked(self.clickedPosition)
}
break
default:
if (!self.exitAnyButton) {
self.#mouseUpHandler(e)
}
break
}
}
this.#mouseStartedMovingHandler = e => {
e.preventDefault()
// Delegate from now on to self.#mouseMoveHandler
movementListenedElement.removeEventListener("mousemove", self.#mouseStartedMovingHandler)
movementListenedElement.addEventListener("mousemove", self.#mouseMoveHandler)
// Do actual actions
self.startDrag()
self.started = true
const dragEvent = self.getEvent(Configuration.trackingMouseEventName.begin)
// Handler calls e.preventDefault() when it receives the event, this means dispatchEvent returns false
self.#trackingMouse = this.target.dispatchEvent(dragEvent) == false
}
this.#mouseMoveHandler = e => {
e.preventDefault()
const location = self.locationFromEvent(e)
const movement = [e.movementX, e.movementY]
self.dragTo(location, movement)
if (self.#trackingMouse) {
self.blueprint.entity.mousePosition = self.locationFromEvent(e)
}
}
this.#mouseUpHandler = e => {
if (!self.exitAnyButton || e.button == self.clickButton) {
e.preventDefault()
// Remove the handlers of "mousemove" and "mouseup"
movementListenedElement.removeEventListener("mousemove", self.#mouseStartedMovingHandler)
movementListenedElement.removeEventListener("mousemove", self.#mouseMoveHandler)
document.removeEventListener("mouseup", self.#mouseUpHandler)
self.endDrag()
if (self.#trackingMouse) {
const dragEvent = self.getEvent(Configuration.trackingMouseEventName.end)
this.target.dispatchEvent(dragEvent)
self.#trackingMouse = false
}
}
}
this.target.addEventListener("mousedown", this.#mouseDownHandler)
if (this.clickButton == 2) {
this.target.addEventListener("contextmenu", e => e.preventDefault())
}
}
getEvent(eventName) {
return new CustomEvent(eventName, {
detail: {
tracker: this
},
bubbles: true,
cancelable: true
})
}
unlistenDOMElement() {
super.unlistenDOMElement()
this.target.removeEventListener("mousedown", this.#mouseDownHandler)
if (this.clickButton == 2) {
this.target.removeEventListener("contextmenu", e => e.preventDefault())
}
}
/* Subclasses will override the following methods */
clicked(location) {
}
startDrag() {
}
dragTo(location, movement) {
}
endDrag() {
}
}
import Configuration from "../../Configuration"
import IPointing from "./IPointing"
/**
* This class manages the ui gesture of mouse click and drag. Tha actual operations are implemented by the subclasses.
*/
export default class IMouseClickDrag extends IPointing {
/** @type {(e: MouseEvent) => void} */
#mouseDownHandler
/** @type {(e: MouseEvent) => void} */
#mouseStartedMovingHandler
/** @type {(e: MouseEvent) => void} */
#mouseMoveHandler
/** @type {(e: MouseEvent) => void} */
#mouseUpHandler
/** @type {Boolean} */
#trackingMouse = false
constructor(target, blueprint, options) {
super(target, blueprint, options)
this.clickButton = options?.clickButton ?? 0
this.exitAnyButton = options?.exitAnyButton ?? true
this.moveEverywhere = options?.moveEverywhere ?? false
this.looseTarget = options?.looseTarget ?? false
this.consumeClickEvent = options?.consumeClickEvent ?? true
this.started = false
this.clickedPosition = [0, 0]
const movementListenedElement = this.moveEverywhere ? document.documentElement : this.movementSpace
let self = this
this.#mouseDownHandler = e => {
this.blueprint.setFocused(true)
switch (e.button) {
case self.clickButton:
// Either doesn't matter or consider the click only when clicking on the parent, not descandants
if (self.looseTarget || e.target == e.currentTarget) {
e.preventDefault()
if (this.consumeClickEvent) {
e.stopImmediatePropagation() // Captured, don't call anyone else
}
self.started = false
// Attach the listeners
movementListenedElement.addEventListener("mousemove", self.#mouseStartedMovingHandler)
document.addEventListener("mouseup", self.#mouseUpHandler)
self.clickedPosition = self.locationFromEvent(e)
self.clicked(self.clickedPosition)
}
break
default:
if (!self.exitAnyButton) {
self.#mouseUpHandler(e)
}
break
}
}
this.#mouseStartedMovingHandler = e => {
e.preventDefault()
// Delegate from now on to self.#mouseMoveHandler
movementListenedElement.removeEventListener("mousemove", self.#mouseStartedMovingHandler)
movementListenedElement.addEventListener("mousemove", self.#mouseMoveHandler)
// Do actual actions
self.startDrag()
self.started = true
const dragEvent = self.getEvent(Configuration.trackingMouseEventName.begin)
// Handler calls e.preventDefault() when it receives the event, this means dispatchEvent returns false
self.#trackingMouse = this.target.dispatchEvent(dragEvent) == false
}
this.#mouseMoveHandler = e => {
e.preventDefault()
const location = self.locationFromEvent(e)
const movement = [e.movementX, e.movementY]
self.dragTo(location, movement)
if (self.#trackingMouse) {
self.blueprint.entity.mousePosition = self.locationFromEvent(e)
}
}
this.#mouseUpHandler = e => {
if (!self.exitAnyButton || e.button == self.clickButton) {
e.preventDefault()
// Remove the handlers of "mousemove" and "mouseup"
movementListenedElement.removeEventListener("mousemove", self.#mouseStartedMovingHandler)
movementListenedElement.removeEventListener("mousemove", self.#mouseMoveHandler)
document.removeEventListener("mouseup", self.#mouseUpHandler)
self.endDrag()
if (self.#trackingMouse) {
const dragEvent = self.getEvent(Configuration.trackingMouseEventName.end)
this.target.dispatchEvent(dragEvent)
self.#trackingMouse = false
}
}
}
this.target.addEventListener("mousedown", this.#mouseDownHandler)
if (this.clickButton == 2) {
this.target.addEventListener("contextmenu", e => e.preventDefault())
}
}
getEvent(eventName) {
return new CustomEvent(eventName, {
detail: {
tracker: this
},
bubbles: true,
cancelable: true
})
}
unlistenDOMElement() {
super.unlistenDOMElement()
this.target.removeEventListener("mousedown", this.#mouseDownHandler)
if (this.clickButton == 2) {
this.target.removeEventListener("contextmenu", e => e.preventDefault())
}
}
/* Subclasses will override the following methods */
clicked(location) {
}
startDrag() {
}
dragTo(location, movement) {
}
endDrag() {
}
}

96
js/input/mouse/MouseWheel.js → js/input/mouse/IMouseWheel.js Executable file → Normal file
View File

@@ -1,48 +1,48 @@
import Pointing from "./Pointing"
export default class MouseWheel extends Pointing {
/** @type {(e: WheelEvent) => void} */
#mouseWheelHandler
/** @type {(e: WheelEvent) => void} */
#mouseParentWheelHandler
/**
*
* @param {HTMLElement} target
* @param {import("../../Blueprint").default} blueprint
* @param {Object} options
*/
constructor(target, blueprint, options) {
options.wantsFocusCallback = true
super(target, blueprint, options)
this.looseTarget = options?.looseTarget ?? true
let self = this
this.#mouseWheelHandler = e => {
e.preventDefault()
const location = self.locationFromEvent(e)
self.wheel(Math.sign(e.deltaY), location)
}
this.#mouseParentWheelHandler = e => e.preventDefault()
if (this.blueprint.focused) {
this.movementSpace.addEventListener("wheel", this.#mouseWheelHandler, false)
}
}
listenEvents() {
this.movementSpace.addEventListener("wheel", this.#mouseWheelHandler, false)
this.movementSpace.parentElement?.addEventListener("wheel", this.#mouseParentWheelHandler)
}
unlistenEvents() {
this.movementSpace.removeEventListener("wheel", this.#mouseWheelHandler, false)
this.movementSpace.parentElement?.removeEventListener("wheel", this.#mouseParentWheelHandler)
}
/* Subclasses will override the following method */
wheel(variation, location) {
}
}
import IPointing from "./IPointing"
export default class IMouseWheel extends IPointing {
/** @type {(e: WheelEvent) => void} */
#mouseWheelHandler
/** @type {(e: WheelEvent) => void} */
#mouseParentWheelHandler
/**
*
* @param {HTMLElement} target
* @param {import("../../Blueprint").default} blueprint
* @param {Object} options
*/
constructor(target, blueprint, options) {
options.wantsFocusCallback = true
super(target, blueprint, options)
this.looseTarget = options?.looseTarget ?? true
let self = this
this.#mouseWheelHandler = e => {
e.preventDefault()
const location = self.locationFromEvent(e)
self.wheel(Math.sign(e.deltaY), location)
}
this.#mouseParentWheelHandler = e => e.preventDefault()
if (this.blueprint.focused) {
this.movementSpace.addEventListener("wheel", this.#mouseWheelHandler, false)
}
}
listenEvents() {
this.movementSpace.addEventListener("wheel", this.#mouseWheelHandler, false)
this.movementSpace.parentElement?.addEventListener("wheel", this.#mouseParentWheelHandler)
}
unlistenEvents() {
this.movementSpace.removeEventListener("wheel", this.#mouseWheelHandler, false)
this.movementSpace.parentElement?.removeEventListener("wheel", this.#mouseParentWheelHandler)
}
/* Subclasses will override the following method */
wheel(variation, location) {
}
}

44
js/input/mouse/Pointing.js → js/input/mouse/IPointing.js Executable file → Normal file
View File

@@ -1,22 +1,22 @@
import Context from "../Context"
import Utility from "../../Utility"
export default class Pointing extends Context {
constructor(target, blueprint, options) {
super(target, blueprint, options)
this.movementSpace = this.blueprint?.getGridDOMElement() ?? document.documentElement
}
/**
*
* @param {MouseEvent} mouseEvent
* @returns
*/
locationFromEvent(mouseEvent) {
return this.blueprint.compensateTranslation(
Utility.convertLocation(
[mouseEvent.clientX, mouseEvent.clientY],
this.movementSpace))
}
}
import IContext from "../IContext"
import Utility from "../../Utility"
export default class IPointing extends IContext {
constructor(target, blueprint, options) {
super(target, blueprint, options)
this.movementSpace = this.blueprint?.getGridDOMElement() ?? document.documentElement
}
/**
*
* @param {MouseEvent} mouseEvent
* @returns
*/
locationFromEvent(mouseEvent) {
return this.blueprint.compensateTranslation(
Utility.convertLocation(
[mouseEvent.clientX, mouseEvent.clientY],
this.movementSpace))
}
}

4
js/input/mouse/MouseCreateLink.js
View File

@@ -1,9 +1,9 @@
import LinkElement from "../../element/LinkElement"
import LinkMessageElement from "../../element/LinkMessageElement"
import MouseClickDrag from "./MouseClickDrag"
import IMouseClickDrag from "./IMouseClickDrag"
/** @typedef {import("../../element/PinElement").default} PinElement */
export default class MouseCreateLink extends MouseClickDrag {
export default class MouseCreateLink extends IMouseClickDrag {
/** @type {NodeListOf<PinElement>} */
#listenedPins

6
js/input/mouse/MouseMoveNodes.js
View File

@@ -1,10 +1,10 @@
import MouseClickDrag from "./MouseClickDrag"
import IMouseClickDrag from "./IMouseClickDrag"
import Utility from "../../Utility"
/**
* @typedef {import("../../element/ISelectableDraggableElement").ISelectableDraggableElement} ISelectableDraggableElement
* @typedef {import("../../element/ISelectableDraggableElement").default} ISelectableDraggableElement
*/
export default class MouseMoveNodes extends MouseClickDrag {
export default class MouseMoveNodes extends IMouseClickDrag {
/**
*

4
js/input/mouse/MouseScrollGraph.js
View File

@@ -1,6 +1,6 @@
import MouseClickDrag from "./MouseClickDrag"
import IMouseClickDrag from "./IMouseClickDrag"
export default class MouseScrollGraph extends MouseClickDrag {
export default class MouseScrollGraph extends IMouseClickDrag {
startDrag() {
this.blueprint.template.applyStartDragScrolling(this.blueprint)

6
js/input/mouse/MouseTracking.js
View File

@@ -1,9 +1,9 @@
import Configuration from "../../Configuration"
import Pointing from "./Pointing"
import IPointing from "./IPointing"
export default class MouseTracking extends Pointing {
export default class MouseTracking extends IPointing {
/** @type {Pointing} */
/** @type {IPointing} */
#mouseTracker = null
/** @type {(e: MouseEvent) => void} */

4
js/input/mouse/Select.js
View File

@@ -1,6 +1,6 @@
import MouseClickDrag from "./MouseClickDrag"
import IMouseClickDrag from "./IMouseClickDrag"
export default class Select extends MouseClickDrag {
export default class Select extends IMouseClickDrag {
constructor(target, blueprint, options) {
super(target, blueprint, options)

4
js/input/mouse/Unfocus.js
View File

@@ -1,6 +1,6 @@
import Context from "../Context"
import IContext from "../IContext"
export default class Unfocus extends Context {
export default class Unfocus extends IContext {
/** @type {(e: WheelEvent) => void} */
#clickHandler

4
js/input/mouse/Zoom.js
View File

@@ -1,6 +1,6 @@
import MouseWheel from "./MouseWheel"
import IMouseWheel from "./IMouseWheel"
export default class Zoom extends MouseWheel {
export default class Zoom extends IMouseWheel {
wheel(variation, location) {
let zoomLevel = this.blueprint.getZoom()