import { interpolate, interpolateZoom } from 'd3-interpolate' import { zoomIdentity } from 'd3-zoom' import { computed } from 'vue' import type { D3Selection, GraphNode, Project, State, TransitionOptions, ViewportFunctions } from '../types' import { clampPosition, getRectOfNodes, getTransformForBounds, pointToRendererPoint, rendererPointToPoint, warn } from '../utils' export interface ViewportHelper extends ViewportFunctions { viewportInitialized: boolean screenToFlowCoordinate: Project flowToScreenCoordinate: Project } const DEFAULT_PADDING = 0.1 // taken from d3-ease: https://github.com/d3/d3-ease/blob/main/src/cubic.js // eslint-disable-next-line no-cond-assign const defaultEase = (t: number) => ((t *= 2) <= 1 ? t * t * t : (t -= 2) * t * t + 2) / 2 function noop() { warn('Viewport not initialized yet.') return Promise.resolve(false) } const initialViewportHelper: ViewportHelper = { zoomIn: noop, zoomOut: noop, zoomTo: noop, fitView: noop, setCenter: noop, fitBounds: noop, project: (position) => position, screenToFlowCoordinate: (position) => position, flowToScreenCoordinate: (position) => position, setViewport: noop, setTransform: noop, getViewport: () => ({ x: 0, y: 0, zoom: 1 }), getTransform: () => ({ x: 0, y: 0, zoom: 1 }), viewportInitialized: false, } /** * Composable that provides viewport helper functions. * * @internal * @param state */ export function useViewportHelper(state: State) { function zoom(scale: number, transitionOptions?: TransitionOptions) { return new Promise((resolve) => { if (state.d3Selection && state.d3Zoom) { state.d3Zoom.interpolate(transitionOptions?.interpolate === 'linear' ? interpolate : interpolateZoom).scaleBy( getD3Transition(state.d3Selection, transitionOptions?.duration, transitionOptions?.ease, () => { resolve(true) }), scale, ) } else { resolve(false) } }) } function transformViewport(x: number, y: number, zoom: number, transitionOptions?: TransitionOptions) { return new Promise((resolve) => { // enforce translate extent const { x: clampedX, y: clampedY } = clampPosition({ x: -x, y: -y }, state.translateExtent) const nextTransform = zoomIdentity.translate(-clampedX, -clampedY).scale(zoom) if (state.d3Selection && state.d3Zoom) { state.d3Zoom?.interpolate(transitionOptions?.interpolate === 'linear' ? interpolate : interpolateZoom).transform( getD3Transition(state.d3Selection, transitionOptions?.duration, transitionOptions?.ease, () => { resolve(true) }), nextTransform, ) } else { resolve(false) } }) } return computed(() => { const isInitialized = state.d3Zoom && state.d3Selection && state.dimensions.width && state.dimensions.height if (!isInitialized) { return initialViewportHelper } return { viewportInitialized: true, // todo: allow passing scale as option zoomIn: (options) => { return zoom(1.2, options) }, zoomOut: (options) => { return zoom(1 / 1.2, options) }, zoomTo: (zoomLevel, options) => { return new Promise((resolve) => { if (state.d3Selection && state.d3Zoom) { state.d3Zoom.interpolate(options?.interpolate === 'linear' ? interpolate : interpolateZoom).scaleTo( getD3Transition(state.d3Selection, options?.duration, options?.ease, () => { resolve(true) }), zoomLevel, ) } else { resolve(false) } }) }, setViewport: (transform, options) => { return transformViewport(transform.x, transform.y, transform.zoom, options) }, setTransform: (transform, options) => { return transformViewport(transform.x, transform.y, transform.zoom, options) }, getViewport: () => ({ x: state.viewport.x, y: state.viewport.y, zoom: state.viewport.zoom, }), getTransform: () => { return { x: state.viewport.x, y: state.viewport.y, zoom: state.viewport.zoom, } }, fitView: ( options = { padding: DEFAULT_PADDING, includeHiddenNodes: false, duration: 0, }, ) => { const nodesToFit: GraphNode[] = [] for (const node of state.nodes) { const isVisible = node.dimensions.width && node.dimensions.height && (options?.includeHiddenNodes || !node.hidden) if (isVisible) { if (!options.nodes?.length || (options.nodes?.length && options.nodes.includes(node.id))) { nodesToFit.push(node) } } } if (!nodesToFit.length) { return Promise.resolve(false) } const bounds = getRectOfNodes(nodesToFit) const { x, y, zoom } = getTransformForBounds( bounds, state.dimensions.width, state.dimensions.height, options.minZoom ?? state.minZoom, options.maxZoom ?? state.maxZoom, options.padding ?? DEFAULT_PADDING, ) return transformViewport(x, y, zoom, options) }, setCenter: (x, y, options) => { const nextZoom = typeof options?.zoom !== 'undefined' ? options.zoom : state.maxZoom const centerX = state.dimensions.width / 2 - x * nextZoom const centerY = state.dimensions.height / 2 - y * nextZoom return transformViewport(centerX, centerY, nextZoom, options) }, fitBounds: (bounds, options = { padding: DEFAULT_PADDING }) => { const { x, y, zoom } = getTransformForBounds( bounds, state.dimensions.width, state.dimensions.height, state.minZoom, state.maxZoom, options.padding ?? DEFAULT_PADDING, ) return transformViewport(x, y, zoom, options) }, project: (position) => pointToRendererPoint(position, state.viewport, state.snapToGrid, state.snapGrid), screenToFlowCoordinate: (position) => { if (state.vueFlowRef) { const { x: domX, y: domY } = state.vueFlowRef.getBoundingClientRect() const correctedPosition = { x: position.x - domX, y: position.y - domY, } return pointToRendererPoint(correctedPosition, state.viewport, state.snapToGrid, state.snapGrid) } return { x: 0, y: 0 } }, flowToScreenCoordinate: (position) => { if (state.vueFlowRef) { const { x: domX, y: domY } = state.vueFlowRef.getBoundingClientRect() const correctedPosition = { x: position.x + domX, y: position.y + domY, } return rendererPointToPoint(correctedPosition, state.viewport) } return { x: 0, y: 0 } }, } }) } export function getD3Transition(selection: D3Selection, duration = 0, ease = defaultEase, onEnd = () => {}) { const hasDuration = typeof duration === 'number' && duration > 0 if (!hasDuration) { onEnd() } return hasDuration ? selection.transition().duration(duration).ease(ease).on('end', onEnd) : selection }