rendx-grid-plugin 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-present wei.liang (https://github.com/weiliang0121)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/main.cjs

@@ -0,0 +1,146 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), setter ? setter.call(obj, value) : member.set(obj, value), value);
+var __privateMethod = (obj, member, method) => (__accessCheck(obj, member, "access private method"), method);
+
+// src/main.ts
+var main_exports = {};
+__export(main_exports, {
+  gridPlugin: () => gridPlugin
+});
+module.exports = __toCommonJS(main_exports);
+
+// src/grid.ts
+var DEFAULTS = {
+  spacing: 20,
+  dotRadius: 1,
+  color: "#d0d0d0",
+  zIndex: -1
+};
+var _app, _canvas, _ctx, _options, _GridPlugin_instances, createCanvas_fn;
+var GridPlugin = class {
+  constructor(options = {}) {
+    __privateAdd(this, _GridPlugin_instances);
+    this.name = "grid";
+    __privateAdd(this, _app, null);
+    __privateAdd(this, _canvas, null);
+    __privateAdd(this, _ctx, null);
+    __privateAdd(this, _options);
+    __privateSet(this, _options, { ...DEFAULTS, ...options });
+  }
+  install(app) {
+    __privateSet(this, _app, app);
+    const container = app.container;
+    if (!container) {
+      throw new Error(
+        "[rendx-grid-plugin] App must be mounted before calling use(). Call app.mount(el) first, then app.use(gridPlugin(...))."
+      );
+    }
+    __privateMethod(this, _GridPlugin_instances, createCanvas_fn).call(this, container);
+    this.draw();
+  }
+  /** 绘制点阵网格 */
+  draw() {
+    const ctx = __privateGet(this, _ctx);
+    const canvas = __privateGet(this, _canvas);
+    if (!ctx || !canvas) return;
+    const { width, height } = __privateGet(this, _app).cfg;
+    const w = width ?? 800;
+    const h = height ?? 600;
+    const { spacing, dotRadius, color } = __privateGet(this, _options);
+    ctx.clearRect(0, 0, w, h);
+    ctx.fillStyle = color;
+    for (let x = spacing; x < w; x += spacing) {
+      for (let y = spacing; y < h; y += spacing) {
+        ctx.beginPath();
+        ctx.arc(x, y, dotRadius, 0, Math.PI * 2);
+        ctx.fill();
+      }
+    }
+  }
+  /** 调整网格 Canvas 尺寸并重绘（由 App.resize 或外部触发） */
+  resize(width, height) {
+    const canvas = __privateGet(this, _canvas);
+    const ctx = __privateGet(this, _ctx);
+    if (!canvas || !ctx) return;
+    const ratio = window.devicePixelRatio || 1;
+    canvas.width = width * ratio;
+    canvas.height = height * ratio;
+    canvas.style.width = `${width}px`;
+    canvas.style.height = `${height}px`;
+    ctx.scale(ratio, ratio);
+    this.draw();
+  }
+  /** 更新配置并重绘 */
+  update(options) {
+    Object.assign(__privateGet(this, _options), options);
+    if (options.zIndex !== void 0 && __privateGet(this, _canvas)) {
+      __privateGet(this, _canvas).style.zIndex = String(options.zIndex);
+    }
+    this.draw();
+  }
+  dispose() {
+    if (__privateGet(this, _canvas)) {
+      __privateGet(this, _canvas).remove();
+      __privateSet(this, _canvas, null);
+      __privateSet(this, _ctx, null);
+    }
+    __privateSet(this, _app, null);
+  }
+};
+_app = new WeakMap();
+_canvas = new WeakMap();
+_ctx = new WeakMap();
+_options = new WeakMap();
+_GridPlugin_instances = new WeakSet();
+createCanvas_fn = function(container) {
+  const { width, height } = __privateGet(this, _app).cfg;
+  const w = width ?? 800;
+  const h = height ?? 600;
+  const canvas = document.createElement("canvas");
+  const ratio = window.devicePixelRatio || 1;
+  canvas.width = w * ratio;
+  canvas.height = h * ratio;
+  canvas.style.position = "absolute";
+  canvas.style.left = "0";
+  canvas.style.top = "0";
+  canvas.style.width = `${w}px`;
+  canvas.style.height = `${h}px`;
+  canvas.style.zIndex = String(__privateGet(this, _options).zIndex);
+  canvas.style.pointerEvents = "none";
+  container.insertBefore(canvas, container.firstChild);
+  const ctx = canvas.getContext("2d");
+  if (!ctx) throw new Error("[rendx-grid-plugin] Could not get 2d context");
+  ctx.scale(ratio, ratio);
+  __privateSet(this, _canvas, canvas);
+  __privateSet(this, _ctx, ctx);
+};
+function gridPlugin(options) {
+  return new GridPlugin(options);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  gridPlugin
+});

package/dist/main.d.cts

@@ -0,0 +1,40 @@
+import { Plugin, App } from 'rendx-engine';
+
+interface GridPluginOptions {
+    /** 点阵间距（px），默认 20 */
+    spacing?: number;
+    /** 点半径（px），默认 1 */
+    dotRadius?: number;
+    /** 点颜色，默认 '#d0d0d0' */
+    color?: string;
+    /** 层级 z-index，默认 -1（在所有渲染层下方） */
+    zIndex?: number;
+}
+declare class GridPlugin implements Plugin {
+    #private;
+    name: string;
+    constructor(options?: GridPluginOptions);
+    install(app: App): void;
+    /** 绘制点阵网格 */
+    draw(): void;
+    /** 调整网格 Canvas 尺寸并重绘（由 App.resize 或外部触发） */
+    resize(width: number, height: number): void;
+    /** 更新配置并重绘 */
+    update(options: Partial<GridPluginOptions>): void;
+    dispose(): void;
+}
+/**
+ * 创建点阵网格背景插件
+ *
+ * @example
+ * ```ts
+ * import {gridPlugin} from 'rendx-grid-plugin';
+ *
+ * const app = new App({width: 800, height: 600});
+ * app.mount(container);
+ * app.use(gridPlugin({spacing: 20, color: '#ccc'}));
+ * ```
+ */
+declare function gridPlugin(options?: GridPluginOptions): GridPlugin;
+
+export { type GridPluginOptions, gridPlugin };

package/dist/main.d.ts

@@ -0,0 +1,40 @@
+import { Plugin, App } from 'rendx-engine';
+
+interface GridPluginOptions {
+    /** 点阵间距（px），默认 20 */
+    spacing?: number;
+    /** 点半径（px），默认 1 */
+    dotRadius?: number;
+    /** 点颜色，默认 '#d0d0d0' */
+    color?: string;
+    /** 层级 z-index，默认 -1（在所有渲染层下方） */
+    zIndex?: number;
+}
+declare class GridPlugin implements Plugin {
+    #private;
+    name: string;
+    constructor(options?: GridPluginOptions);
+    install(app: App): void;
+    /** 绘制点阵网格 */
+    draw(): void;
+    /** 调整网格 Canvas 尺寸并重绘（由 App.resize 或外部触发） */
+    resize(width: number, height: number): void;
+    /** 更新配置并重绘 */
+    update(options: Partial<GridPluginOptions>): void;
+    dispose(): void;
+}
+/**
+ * 创建点阵网格背景插件
+ *
+ * @example
+ * ```ts
+ * import {gridPlugin} from 'rendx-grid-plugin';
+ *
+ * const app = new App({width: 800, height: 600});
+ * app.mount(container);
+ * app.use(gridPlugin({spacing: 20, color: '#ccc'}));
+ * ```
+ */
+declare function gridPlugin(options?: GridPluginOptions): GridPlugin;
+
+export { type GridPluginOptions, gridPlugin };

package/dist/main.js

@@ -0,0 +1,120 @@
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), setter ? setter.call(obj, value) : member.set(obj, value), value);
+var __privateMethod = (obj, member, method) => (__accessCheck(obj, member, "access private method"), method);
+
+// src/grid.ts
+var DEFAULTS = {
+  spacing: 20,
+  dotRadius: 1,
+  color: "#d0d0d0",
+  zIndex: -1
+};
+var _app, _canvas, _ctx, _options, _GridPlugin_instances, createCanvas_fn;
+var GridPlugin = class {
+  constructor(options = {}) {
+    __privateAdd(this, _GridPlugin_instances);
+    this.name = "grid";
+    __privateAdd(this, _app, null);
+    __privateAdd(this, _canvas, null);
+    __privateAdd(this, _ctx, null);
+    __privateAdd(this, _options);
+    __privateSet(this, _options, { ...DEFAULTS, ...options });
+  }
+  install(app) {
+    __privateSet(this, _app, app);
+    const container = app.container;
+    if (!container) {
+      throw new Error(
+        "[rendx-grid-plugin] App must be mounted before calling use(). Call app.mount(el) first, then app.use(gridPlugin(...))."
+      );
+    }
+    __privateMethod(this, _GridPlugin_instances, createCanvas_fn).call(this, container);
+    this.draw();
+  }
+  /** 绘制点阵网格 */
+  draw() {
+    const ctx = __privateGet(this, _ctx);
+    const canvas = __privateGet(this, _canvas);
+    if (!ctx || !canvas) return;
+    const { width, height } = __privateGet(this, _app).cfg;
+    const w = width ?? 800;
+    const h = height ?? 600;
+    const { spacing, dotRadius, color } = __privateGet(this, _options);
+    ctx.clearRect(0, 0, w, h);
+    ctx.fillStyle = color;
+    for (let x = spacing; x < w; x += spacing) {
+      for (let y = spacing; y < h; y += spacing) {
+        ctx.beginPath();
+        ctx.arc(x, y, dotRadius, 0, Math.PI * 2);
+        ctx.fill();
+      }
+    }
+  }
+  /** 调整网格 Canvas 尺寸并重绘（由 App.resize 或外部触发） */
+  resize(width, height) {
+    const canvas = __privateGet(this, _canvas);
+    const ctx = __privateGet(this, _ctx);
+    if (!canvas || !ctx) return;
+    const ratio = window.devicePixelRatio || 1;
+    canvas.width = width * ratio;
+    canvas.height = height * ratio;
+    canvas.style.width = `${width}px`;
+    canvas.style.height = `${height}px`;
+    ctx.scale(ratio, ratio);
+    this.draw();
+  }
+  /** 更新配置并重绘 */
+  update(options) {
+    Object.assign(__privateGet(this, _options), options);
+    if (options.zIndex !== void 0 && __privateGet(this, _canvas)) {
+      __privateGet(this, _canvas).style.zIndex = String(options.zIndex);
+    }
+    this.draw();
+  }
+  dispose() {
+    if (__privateGet(this, _canvas)) {
+      __privateGet(this, _canvas).remove();
+      __privateSet(this, _canvas, null);
+      __privateSet(this, _ctx, null);
+    }
+    __privateSet(this, _app, null);
+  }
+};
+_app = new WeakMap();
+_canvas = new WeakMap();
+_ctx = new WeakMap();
+_options = new WeakMap();
+_GridPlugin_instances = new WeakSet();
+createCanvas_fn = function(container) {
+  const { width, height } = __privateGet(this, _app).cfg;
+  const w = width ?? 800;
+  const h = height ?? 600;
+  const canvas = document.createElement("canvas");
+  const ratio = window.devicePixelRatio || 1;
+  canvas.width = w * ratio;
+  canvas.height = h * ratio;
+  canvas.style.position = "absolute";
+  canvas.style.left = "0";
+  canvas.style.top = "0";
+  canvas.style.width = `${w}px`;
+  canvas.style.height = `${h}px`;
+  canvas.style.zIndex = String(__privateGet(this, _options).zIndex);
+  canvas.style.pointerEvents = "none";
+  container.insertBefore(canvas, container.firstChild);
+  const ctx = canvas.getContext("2d");
+  if (!ctx) throw new Error("[rendx-grid-plugin] Could not get 2d context");
+  ctx.scale(ratio, ratio);
+  __privateSet(this, _canvas, canvas);
+  __privateSet(this, _ctx, ctx);
+};
+function gridPlugin(options) {
+  return new GridPlugin(options);
+}
+export {
+  gridPlugin
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "rendx-grid-plugin",
+  "version": "0.1.0",
+  "description": "Grid overlay plugin for Rendx engine",
+  "license": "MIT",
+  "author": "wei.liang (https://github.com/weiliang0121)",
+  "type": "module",
+  "keywords": [
+    "rendx",
+    "2d",
+    "canvas",
+    "rendering",
+    "visualization",
+    "scene-graph"
+  ],
+  "homepage": "https://weiliang0121.github.io/rendx/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/weiliang0121/rendx.git",
+    "directory": "packages/grid-plugin"
+  },
+  "main": "dist/main.cjs",
+  "module": "dist/main.js",
+  "types": "dist/main.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/main.d.ts",
+      "import": "./dist/main.js",
+      "require": "./dist/main.cjs"
+    }
+  },
+  "dependencies": {
+    "rendx-engine": "^0.2.0"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  }
+}