Skip to content

Visualize Your Ideas With Code

feat: add coordinates to preview (#737)

Logan Zehm330c1f962fb9
diff --git a/packages/2d/src/scenes/Scene2D.ts b/packages/2d/src/scenes/Scene2D.ts
index e1c961bc..7980c64c 100644
--- a/packages/2d/src/scenes/Scene2D.ts
+++ b/packages/2d/src/scenes/Scene2D.ts
@@ -8,7 +8,7 @@ import {
SceneRenderEvent,
ThreadGeneratorFactory,
} from '@motion-canvas/core/lib/scenes';
-import {Vector2} from '@motion-canvas/core/lib/types';
+import {Vector2} from '@motion-canvas/core';
import {Node, View2D} from '../components';
export class Scene2D extends GeneratorScene<View2D> implements Inspectable {
@@ -117,6 +117,12 @@ export class Scene2D extends GeneratorScene<View2D> implements Inspectable {
}
}
+ public transformMousePosition(x: number, y: number): Vector2 | null {
+ return new Vector2(x, y)
+ .scale(this.resolutionScale)
+ .transformAsPoint(this.getView().localToParent().inverse());
+ }
+
public registerNode(node: Node, key?: string): string {
const className = node.constructor?.name ?? 'unknown';
this.nodeCounters[className] ??= 0;
diff --git a/packages/core/src/app/SettingsMetadata.ts b/packages/core/src/app/SettingsMetadata.ts
index ff4438fb..49496cf9 100644
--- a/packages/core/src/app/SettingsMetadata.ts
+++ b/packages/core/src/app/SettingsMetadata.ts
@@ -20,6 +20,9 @@ export function createSettingsMetadata() {
font: new BoolMetaField('legacy font', false).describe(
"Use the 'JetBrains Mono' font for the user interface.",
),
+ coordinates: new BoolMetaField('coordinates', true).describe(
+ 'Display mouse coordinates within the preview window.',
+ ),
}),
defaults: new ObjectMetaField('Defaults', {
background: new ColorMetaField('background', null).describe(
diff --git a/packages/core/src/scenes/Inspectable.ts b/packages/core/src/scenes/Inspectable.ts
index d4f79cc5..8ec9089b 100644
--- a/packages/core/src/scenes/Inspectable.ts
+++ b/packages/core/src/scenes/Inspectable.ts
@@ -1,3 +1,5 @@
+import {Vector2} from '../types/Vector';
+
/**
* Represents an element to inspect.
*
@@ -67,6 +69,14 @@ export interface Inspectable {
matrix: DOMMatrix,
context: CanvasRenderingContext2D,
): void;
+
+ /**
+ * Transform the absolute mouse coordinates into the scene's coordinate system.
+ *
+ * @param x - The x coordinate.
+ * @param y - The y coordinate.
+ */
+ transformMousePosition(x: number, y: number): Vector2 | null;
}
export function isInspectable(value: any): value is Inspectable {
diff --git a/packages/ui/src/components/viewport/Coordinates.tsx b/packages/ui/src/components/viewport/Coordinates.tsx
new file mode 100644
index 00000000..d95eb487
--- /dev/null
+++ b/packages/ui/src/components/viewport/Coordinates.tsx
@@ -0,0 +1,98 @@
+import {useEffect, useState} from 'react';
+import {useCallback, useContext} from 'preact/hooks';
+import {
+ useCurrentScene,
+ useDocumentEvent,
+ useSharedSettings,
+} from '../../hooks';
+import {ViewportContext} from './ViewportContext';
+import {isInspectable} from '@motion-canvas/core';
+import styles from '../controls/Controls.module.scss';
+
+export function Coordinates() {
+ const [mousePos, setMousePos] = useState({x: 0, y: 0});
+ const [hover, setHover] = useState(true);
+
+ const state = useContext(ViewportContext);
+ const settings = {
+ ...useSharedSettings(),
+ };
+ const scene = useCurrentScene();
+
+ useEffect(() => {
+ const handleMouseMove = (event: {x: number; y: number}) => {
+ if (!isInspectable(scene)) return;
+ const absoluteCoords = {
+ x: event.x - state.size.x,
+ y: event.y - state.size.y,
+ };
+
+ absoluteCoords.x -= state.x + state.width / 2;
+ absoluteCoords.y -= state.y + state.height / 2;
+ absoluteCoords.x /= state.zoom;
+ absoluteCoords.y /= state.zoom;
+ absoluteCoords.x += settings.size.width / 2;
+ absoluteCoords.y += settings.size.height / 2;
+
+ const point = scene.transformMousePosition(
+ absoluteCoords.x,
+ absoluteCoords.y,
+ );
+
+ point.x = Math.round(point.x);
+ point.y = Math.round(point.y);
+
+ // These coordinates are used purely for bounds detection of the preview window.
+ const boundX = Math.round(
+ ((event.x - state.size.x) / state.width - 0.5) * state.width,
+ );
+ const boundY = Math.round(
+ ((event.y - state.size.y) / state.height - 0.5) * state.height,
+ );
+ if (
+ Math.abs(boundX) > state.width / 2 ||
+ Math.abs(boundY) > state.height / 2
+ ) {
+ setHover?.(false);
+ } else {
+ // Only need to set position coordinates if hovering over the overlay
+ setHover?.(true);
+
+ setMousePos({
+ x: point.x,
+ y: point.y,
+ });
+ }
+ };
+
+ document.addEventListener('mousemove', handleMouseMove);
+
+ return () => {
+ document.removeEventListener('mousemove', handleMouseMove);
+ };
+ }, [state]);
+
+ // Below method is used for the copy to clipboard keybind
+ useDocumentEvent(
+ 'keydown',
+ useCallback(
+ async event => {
+ if (document.activeElement.tagName !== 'INPUT' && event.key === 'p') {
+ const positionString = `${mousePos.x}, ${mousePos.y}`;
+ await window.navigator.clipboard.writeText(positionString);
+ }
+ },
+ [mousePos],
+ ),
+ );
+
+ return (
+ <>
+ {hover && (
+ <div title={'Coordinates'} className={styles.input}>
+ ({mousePos.x}, {mousePos.y})
+ </div>
+ )}
+ </>
+ );
+}
diff --git a/packages/ui/src/components/viewport/EditorPreview.tsx b/packages/ui/src/components/viewport/EditorPreview.tsx
index ca87ef8e..25089d03 100644
--- a/packages/ui/src/components/viewport/EditorPreview.tsx
+++ b/packages/ui/src/components/viewport/EditorPreview.tsx
@@ -9,12 +9,13 @@ import {
useSize,
useStorage,
useSubscribable,
+ useSubscribableValue,
} from '../../hooks';
import {Debug} from './Debug';
import {Grid} from './Grid';
import styles from './Viewport.module.scss';
import {ViewportContext, ViewportState} from './ViewportContext';
-import {isInspectable} from '@motion-canvas/core/lib/scenes/Inspectable';
+import {isInspectable} from '@motion-canvas/core';
import {useApplication, useInspection} from '../../contexts';
import {highlight} from '../animations';
import {PreviewStage} from './PreviewStage';
@@ -23,11 +24,15 @@ import {Button, Select} from '../controls';
import {Recenter, Grid as GridIcon} from '../icons';
import {ButtonCheckbox} from '../controls/ButtonCheckbox';
import {ColorPicker} from './ColorPicker';
+import {Coordinates} from './Coordinates';
const ZOOM_SPEED = 0.1;
export function EditorPreview() {
- const {player} = useApplication();
+ const {player, settings: appSettings} = useApplication();
+ const coordinateSetting = useSubscribableValue(
+ appSettings.appearance.coordinates.onChanged,
+ );
const scene = useCurrentScene();
const {setInspectedElement} = useInspection();
const containerRef = useRef<HTMLDivElement>();
@@ -49,6 +54,7 @@ export function EditorPreview() {
const state: ViewportState = useMemo(() => {
const state = {
grid,
+ size,
width: size.width,
height: size.height,
...position,
@@ -246,6 +252,7 @@ export function EditorPreview() {
<GridIcon />
</ButtonCheckbox>
<ColorPicker />
+ {coordinateSetting && <Coordinates />}
</div>
</div>
</ViewportContext.Provider>
diff --git a/packages/ui/src/components/viewport/ViewportContext.ts b/packages/ui/src/components/viewport/ViewportContext.ts
index a4b4b787..fc608c9a 100644
--- a/packages/ui/src/components/viewport/ViewportContext.ts
+++ b/packages/ui/src/components/viewport/ViewportContext.ts
@@ -5,6 +5,7 @@ export interface ViewportState {
height: number;
x: number;
y: number;
+ size: {x: number; y: number};
zoom: number;
grid: boolean;
}
@@ -14,6 +15,7 @@ const ViewportContext = createContext<ViewportState>({
height: 1080,
x: 0,
y: 0,
+ size: {x: 0, y: 0},
zoom: 1,
grid: false,
});
diff --git a/packages/ui/src/contexts/shortcuts.tsx b/packages/ui/src/contexts/shortcuts.tsx
index 6524581e..1d9d2113 100644
--- a/packages/ui/src/contexts/shortcuts.tsx
+++ b/packages/ui/src/contexts/shortcuts.tsx
@@ -30,6 +30,7 @@ const InitialShortcuts: ShortcutsByModule = {
{key: '=', action: 'Zoom in'},
{key: '-', action: 'Zoom out'},
{key: "'", action: 'Toggle grid'},
+ {key: 'P', action: 'Copy coordinates'},
{
key: 'I',
action: 'Use color picker',