Compare commits
2 Commits
master
...
xian-ncc-d
Author | SHA1 | Date | |
---|---|---|---|
|
ec89e355e6 | ||
|
f9bb2279e8 |
7
.eslintignore
Normal file
7
.eslintignore
Normal file
@ -0,0 +1,7 @@
|
||||
/dist
|
||||
/src-capacitor
|
||||
/src-cordova
|
||||
/.quasar
|
||||
/node_modules
|
||||
.eslintrc.js
|
||||
/src-ssr
|
21
.eslintrc
21
.eslintrc
@ -1,21 +0,0 @@
|
||||
{
|
||||
"root": true,
|
||||
"env": {
|
||||
"browser": true,
|
||||
"es2021": true
|
||||
},
|
||||
"plugins": ["@typescript-eslint", "prettier"],
|
||||
"extends": [
|
||||
"eslint:recommended",
|
||||
"plugin:@typescript-eslint/eslint-recommended",
|
||||
"plugin:@typescript-eslint/recommended",
|
||||
"prettier"
|
||||
],
|
||||
"parserOptions": {
|
||||
"ecmaVersion": "latest",
|
||||
"sourceType": "module"
|
||||
},
|
||||
"rules": {
|
||||
"prettier/prettier": "error"
|
||||
}
|
||||
}
|
89
.eslintrc.js
Normal file
89
.eslintrc.js
Normal file
@ -0,0 +1,89 @@
|
||||
module.exports = {
|
||||
// https://eslint.org/docs/user-guide/configuring#configuration-cascading-and-hierarchy
|
||||
// This option interrupts the configuration hierarchy at this file
|
||||
// Remove this if you have an higher level ESLint config file (it usually happens into a monorepos)
|
||||
root: true,
|
||||
|
||||
// https://eslint.vuejs.org/user-guide/#how-to-use-a-custom-parser
|
||||
// Must use parserOptions instead of "parser" to allow vue-eslint-parser to keep working
|
||||
// `parser: 'vue-eslint-parser'` is already included with any 'plugin:vue/**' config and should be omitted
|
||||
parserOptions: {
|
||||
parser: require.resolve('@typescript-eslint/parser'),
|
||||
extraFileExtensions: ['.vue'],
|
||||
},
|
||||
|
||||
env: {
|
||||
browser: true,
|
||||
es2021: true,
|
||||
node: true,
|
||||
'vue/setup-compiler-macros': true,
|
||||
},
|
||||
|
||||
// Rules order is important, please avoid shuffling them
|
||||
extends: [
|
||||
// Base ESLint recommended rules
|
||||
// 'eslint:recommended',
|
||||
|
||||
// https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#usage
|
||||
// ESLint typescript rules
|
||||
'plugin:@typescript-eslint/recommended',
|
||||
|
||||
// Uncomment any of the lines below to choose desired strictness,
|
||||
// but leave only one uncommented!
|
||||
// See https://eslint.vuejs.org/rules/#available-rules
|
||||
'plugin:vue/vue3-essential', // Priority A: Essential (Error Prevention)
|
||||
// 'plugin:vue/vue3-strongly-recommended', // Priority B: Strongly Recommended (Improving Readability)
|
||||
// 'plugin:vue/vue3-recommended', // Priority C: Recommended (Minimizing Arbitrary Choices and Cognitive Overhead)
|
||||
|
||||
// https://github.com/prettier/eslint-config-prettier#installation
|
||||
// usage with Prettier, provided by 'eslint-config-prettier'.
|
||||
'prettier',
|
||||
],
|
||||
|
||||
plugins: [
|
||||
// required to apply rules which need type information
|
||||
'@typescript-eslint',
|
||||
|
||||
// https://eslint.vuejs.org/user-guide/#why-doesn-t-it-work-on-vue-files
|
||||
// required to lint *.vue files
|
||||
'vue',
|
||||
|
||||
// https://github.com/typescript-eslint/typescript-eslint/issues/389#issuecomment-509292674
|
||||
// Prettier has not been included as plugin to avoid performance impact
|
||||
// add it as an extension for your IDE
|
||||
],
|
||||
|
||||
globals: {
|
||||
ga: 'readonly', // Google Analytics
|
||||
cordova: 'readonly',
|
||||
__statics: 'readonly',
|
||||
__QUASAR_SSR__: 'readonly',
|
||||
__QUASAR_SSR_SERVER__: 'readonly',
|
||||
__QUASAR_SSR_CLIENT__: 'readonly',
|
||||
__QUASAR_SSR_PWA__: 'readonly',
|
||||
process: 'readonly',
|
||||
Capacitor: 'readonly',
|
||||
chrome: 'readonly',
|
||||
},
|
||||
|
||||
// add your custom rules here
|
||||
rules: {
|
||||
'prefer-promise-reject-errors': 'off',
|
||||
|
||||
quotes: ['warn', 'single', { avoidEscape: true }],
|
||||
|
||||
// this rule, if on, would require explicit return type on the `render` function
|
||||
'@typescript-eslint/explicit-function-return-type': 'off',
|
||||
|
||||
// in plain CommonJS modules, you can't use `import foo = require('foo')` to pass this rule, so it has to be disabled
|
||||
'@typescript-eslint/no-var-requires': 'off',
|
||||
'@typescript-eslint/no-namespace': 'off',
|
||||
|
||||
// The core 'no-unused-vars' rules (in the eslint:recommended ruleset)
|
||||
// does not work with type definitions
|
||||
'no-unused-vars': 'off',
|
||||
|
||||
// allow debugger during development only
|
||||
'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
|
||||
},
|
||||
};
|
15
.vscode/extensions.json
vendored
Normal file
15
.vscode/extensions.json
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
{
|
||||
"recommendations": [
|
||||
"dbaeumer.vscode-eslint",
|
||||
"esbenp.prettier-vscode",
|
||||
"editorconfig.editorconfig",
|
||||
"vue.volar",
|
||||
"wayou.vscode-todo-highlight"
|
||||
],
|
||||
"unwantedRecommendations": [
|
||||
"octref.vetur",
|
||||
"hookyqr.beautify",
|
||||
"dbaeumer.jshint",
|
||||
"ms-vscode.vscode-typescript-tslint-plugin"
|
||||
]
|
||||
}
|
16
.vscode/settings.json
vendored
Normal file
16
.vscode/settings.json
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
{
|
||||
"editor.bracketPairColorization.enabled": true,
|
||||
"editor.guides.bracketPairs": true,
|
||||
"editor.formatOnSave": true,
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
||||
"editor.codeActionsOnSave": [
|
||||
"source.fixAll.eslint"
|
||||
],
|
||||
"eslint.validate": [
|
||||
"javascript",
|
||||
"javascriptreact",
|
||||
"typescript",
|
||||
"vue"
|
||||
],
|
||||
"typescript.tsdk": "node_modules/typescript/lib"
|
||||
}
|
63
README.md
63
README.md
@ -3,28 +3,19 @@
|
||||
图形应用基础框架,基于 pixi.js([官网](https://pixijs.com/), [API Docs](https://pixijs.download/release/docs/index.html))
|
||||
viewport 使用的 github 开源的 pixi-viewport[pixi-viewport](https://github.com/davidfig/pixi-viewport)
|
||||
|
||||
# 发布版本说明
|
||||
测试好可以发布时执行yarn run build进行构建,然后再提交push后,在gitea.joylink.club中进行版本发布
|
||||
```
|
||||
yarn run build
|
||||
```
|
||||
|
||||
# 路线图
|
||||
|
||||
- ~~图形的位置、旋转属性使用 pixijs 的 transform 变换(完成)~~
|
||||
- ~~图形对象的拖拽使用原始的 transform(图形的变换使用原始的变换)(完成)~~
|
||||
- ~~图形交互抽象(完成)~~
|
||||
- ~~图形子元素变换处理和存储(完成)~~
|
||||
- ~~图形复制功能(完成)~~
|
||||
- ~~绘制应用图形外包围框及旋转缩放功能(完成)~~
|
||||
- ~~绘制增加吸附功能(移动到特定位置附近吸附)(完成)~~
|
||||
- 图形的位置、旋转属性使用 pixijs 的 transform 变换(完成)
|
||||
- 图形对象的拖拽使用原始的 transform(图形的变换使用原始的变换)(完成)
|
||||
- 图形交互抽象(完成)
|
||||
- 图形子元素变换处理和存储(完成)
|
||||
- 图形复制功能(完成)
|
||||
- 绘制应用图形外包围框及旋转缩放功能(完成)
|
||||
- 绘制增加吸附功能(移动到特定位置附近吸附)(完成)
|
||||
- 图形动画抽象
|
||||
- 添加公用动画逻辑(如按指定路径位移,按角度旋转、按比例缩放、透明度控制等)
|
||||
- 菜单事件及处理,功能:菜单更新、菜单项显隐控制、菜单执行前后事件回调
|
||||
- 打包
|
||||
- 分割
|
||||
- globalMixin相关的编译配置(当前需打包完后手动修改index.d.ts第一行)
|
||||
-
|
||||
- 添加拖拽轨迹限制功能
|
||||
- 添加图形对象"可编辑属性"定义功能
|
||||
|
||||
@ -42,3 +33,43 @@ yarn run build
|
||||
> - "static":发出(emit)事件并进行命中测试。与 v7 中的 interactive=true 相同
|
||||
|
||||
> - "dynamic":发出(emit)事件并进行命中测试,但也会接收模拟的交互事件,以便在鼠标不移动时进行交互
|
||||
|
||||
## Install the dependencies
|
||||
|
||||
```bash
|
||||
yarn
|
||||
# or
|
||||
npm install
|
||||
```
|
||||
|
||||
### Start the app in development mode (hot-code reloading, error reporting, etc.)
|
||||
|
||||
```bash
|
||||
quasar dev
|
||||
```
|
||||
|
||||
### Lint the files
|
||||
|
||||
```bash
|
||||
yarn lint
|
||||
# or
|
||||
npm run lint
|
||||
```
|
||||
|
||||
### Format the files
|
||||
|
||||
```bash
|
||||
yarn format
|
||||
# or
|
||||
npm run format
|
||||
```
|
||||
|
||||
### Build the app for production
|
||||
|
||||
```bash
|
||||
quasar build
|
||||
```
|
||||
|
||||
### Customize the configuration
|
||||
|
||||
See [Configuring quasar.config.js](https://v2.quasar.dev/quasar-cli-vite/quasar-config-js).
|
||||
|
21
index.html
Normal file
21
index.html
Normal file
@ -0,0 +1,21 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title><%= productName %></title>
|
||||
|
||||
<meta charset="utf-8">
|
||||
<meta name="description" content="<%= productDescription %>">
|
||||
<meta name="format-detection" content="telephone=no">
|
||||
<meta name="msapplication-tap-highlight" content="no">
|
||||
<meta name="viewport" content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width<% if (ctx.mode.cordova || ctx.mode.capacitor) { %>, viewport-fit=cover<% } %>">
|
||||
|
||||
<link rel="icon" type="image/png" sizes="128x128" href="icons/favicon-128x128.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="icons/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="icons/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="icons/favicon-16x16.png">
|
||||
<link rel="icon" type="image/ico" href="favicon.ico">
|
||||
</head>
|
||||
<body>
|
||||
<!-- quasar:entry-point -->
|
||||
</body>
|
||||
</html>
|
42
lib/app/BasicOperation.d.ts
vendored
42
lib/app/BasicOperation.d.ts
vendored
@ -1,42 +0,0 @@
|
||||
import { GraphicData, JlGraphic } from '../core';
|
||||
import { JlOperation } from '../operation';
|
||||
import { ICanvasProperties, IGraphicApp, IJlCanvas } from './JlGraphicApp';
|
||||
/**
|
||||
* 更新画布操作
|
||||
*/
|
||||
export declare class UpdateCanvasOperation extends JlOperation {
|
||||
obj: IJlCanvas;
|
||||
old: ICanvasProperties;
|
||||
data: ICanvasProperties;
|
||||
description: string;
|
||||
constructor(app: IGraphicApp, obj: IJlCanvas, old: ICanvasProperties, data: ICanvasProperties);
|
||||
undo(): JlGraphic[];
|
||||
redo(): JlGraphic[];
|
||||
}
|
||||
/**
|
||||
* 创建图形操作
|
||||
*/
|
||||
export declare class GraphicCreateOperation extends JlOperation {
|
||||
obj: JlGraphic[];
|
||||
description: string;
|
||||
constructor(app: IGraphicApp, obj: JlGraphic[]);
|
||||
undo(): JlGraphic[] | void;
|
||||
redo(): JlGraphic[];
|
||||
}
|
||||
/**
|
||||
* 删除图形操作
|
||||
*/
|
||||
export declare class GraphicDeleteOperation extends JlOperation {
|
||||
obj: JlGraphic[];
|
||||
constructor(app: IGraphicApp, obj: JlGraphic[]);
|
||||
undo(): JlGraphic[];
|
||||
redo(): void;
|
||||
}
|
||||
export declare class GraphicDataUpdateOperation extends JlOperation {
|
||||
obj: JlGraphic[];
|
||||
oldData: GraphicData[];
|
||||
newData: GraphicData[];
|
||||
constructor(app: IGraphicApp, obj: JlGraphic[], oldData: GraphicData[], newData: GraphicData[]);
|
||||
undo(): void | JlGraphic[];
|
||||
redo(): void | JlGraphic[];
|
||||
}
|
150
lib/app/JlDrawApp.d.ts
vendored
150
lib/app/JlDrawApp.d.ts
vendored
@ -1,150 +0,0 @@
|
||||
import { BitmapFont, BitmapText, Container, FederatedMouseEvent, Point } from 'pixi.js';
|
||||
import { GraphicData, GraphicTemplate, JlGraphic } from '../core/JlGraphic';
|
||||
import { AppInteractionPlugin, InteractionPlugin, KeyListener } from '../plugins';
|
||||
import { GraphicApp, GraphicAppOptions, ICanvasProperties, IGraphicApp, IJlCanvas } from './JlGraphicApp';
|
||||
/**
|
||||
* 图形绘制助手
|
||||
*/
|
||||
export declare abstract class GraphicDrawAssistant<GT extends GraphicTemplate, GD extends GraphicData> extends AppInteractionPlugin {
|
||||
readonly __GraphicDrawAssistant = true;
|
||||
app: IDrawApp;
|
||||
type: string;
|
||||
description: string;
|
||||
icon: string;
|
||||
container: Container;
|
||||
graphicTemplate: GT;
|
||||
escListener: KeyListener;
|
||||
onEsc(): void;
|
||||
constructor(graphicApp: IDrawApp, graphicTemplate: GT, icon: string, description: string);
|
||||
get canvas(): IJlCanvas;
|
||||
bind(): void;
|
||||
unbind(): void;
|
||||
onLeftDown(e: FederatedMouseEvent): void;
|
||||
onMouseMove(e: FederatedMouseEvent): void;
|
||||
onLeftUp(e: FederatedMouseEvent): void;
|
||||
onRightDown(e: FederatedMouseEvent): void;
|
||||
onRightUp(e: FederatedMouseEvent): void;
|
||||
onRightClick(e: FederatedMouseEvent): void;
|
||||
/**
|
||||
* 获取下一个id
|
||||
*/
|
||||
nextId(): number;
|
||||
clearCache(): void;
|
||||
/**
|
||||
* 重绘
|
||||
* @param cp 鼠标所在画布坐标
|
||||
*/
|
||||
abstract redraw(cp: Point): void;
|
||||
abstract prepareData(data: GD): boolean;
|
||||
toCanvasCoordinates(p: Point): Point;
|
||||
/**
|
||||
* 保存创建的图形对象
|
||||
*/
|
||||
storeGraphic(...graphics: JlGraphic[]): void;
|
||||
/**
|
||||
* 创建并添加到图形App
|
||||
*/
|
||||
createAndStore(finish: boolean): JlGraphic | null;
|
||||
/**
|
||||
* 绘制完成
|
||||
*/
|
||||
finish(...graphics: JlGraphic[]): void;
|
||||
}
|
||||
/**
|
||||
* 绘制助手类型
|
||||
*/
|
||||
export type DrawAssistant = GraphicDrawAssistant<GraphicTemplate, GraphicData>;
|
||||
/**
|
||||
* 绘制配置选项
|
||||
*/
|
||||
export type DrawAppOptions = GraphicAppOptions;
|
||||
/**
|
||||
* 绘制应用接口
|
||||
*/
|
||||
export interface IDrawApp extends IGraphicApp {
|
||||
/**
|
||||
* 是否正在绘制图形
|
||||
*/
|
||||
get drawing(): boolean;
|
||||
/**
|
||||
* 更新绘制中状态
|
||||
*/
|
||||
set drawing(value: boolean);
|
||||
/**
|
||||
* 设置配置选项
|
||||
* @param options
|
||||
*/
|
||||
setOptions(options: DrawAppOptions): void;
|
||||
/**
|
||||
* 获取绘制助手
|
||||
*/
|
||||
getDrawAssistant<DA extends DrawAssistant>(graphicType: string): DA;
|
||||
/**
|
||||
* 更新画布并记录
|
||||
* @param data
|
||||
*/
|
||||
updateCanvasAndRecord(data: ICanvasProperties): void;
|
||||
/**
|
||||
* 更新图形并记录
|
||||
* @param g
|
||||
* @param data
|
||||
*/
|
||||
updateGraphicAndRecord(g: JlGraphic, data: GraphicData): void;
|
||||
/**
|
||||
* 绑定form表单对象
|
||||
* @param form
|
||||
*/
|
||||
bindFormData(form: GraphicData): void;
|
||||
/**
|
||||
* 解绑form表单对象
|
||||
* @param form
|
||||
*/
|
||||
unbindFormData(form: GraphicData): void;
|
||||
}
|
||||
/**
|
||||
* 绘制应用
|
||||
*/
|
||||
export declare class JlDrawApp extends GraphicApp implements IDrawApp {
|
||||
font: BitmapFont;
|
||||
coordinates: BitmapText;
|
||||
scaleText: BitmapText;
|
||||
drawAssistants: DrawAssistant[];
|
||||
_drawing: boolean;
|
||||
private debouncedFormDataUpdator;
|
||||
get drawing(): boolean;
|
||||
set drawing(value: boolean);
|
||||
constructor(options: DrawAppOptions);
|
||||
setOptions(options: DrawAppOptions): void;
|
||||
registerInteractionPlugin(...plugins: InteractionPlugin[]): void;
|
||||
getDrawAssistant<DA extends DrawAssistant>(graphicType: string): DA;
|
||||
private appOperationRecord;
|
||||
/**
|
||||
* 绘制状态信息显示
|
||||
*/
|
||||
private appendDrawStatesDisplay;
|
||||
bindKeyboardOperation(): void;
|
||||
/**
|
||||
* 图形对象存储处理,默认添加图形交互
|
||||
* @param graphic
|
||||
*/
|
||||
beforeGraphicStore(graphic: JlGraphic): void;
|
||||
formData: GraphicData | undefined;
|
||||
/**
|
||||
* 绑定form表单对象
|
||||
* @param form
|
||||
*/
|
||||
bindFormData(form: GraphicData): void;
|
||||
/**
|
||||
* 移除form绑定
|
||||
* @param form
|
||||
*/
|
||||
unbindFormData(form: GraphicData): void;
|
||||
private formDataSyncListen;
|
||||
/**
|
||||
* 处理表单数据更新(使用debounce限流)
|
||||
*/
|
||||
private handleFormDataUpdate;
|
||||
private doFormDataUpdate;
|
||||
updateCanvasAndRecord(data: ICanvasProperties): void;
|
||||
updateGraphicAndRecord(g: JlGraphic, data: GraphicData): void;
|
||||
}
|
618
lib/app/JlGraphicApp.d.ts
vendored
618
lib/app/JlGraphicApp.d.ts
vendored
@ -1,618 +0,0 @@
|
||||
/// <reference types="node" />
|
||||
import EventEmitter from 'eventemitter3';
|
||||
import { Viewport } from 'pixi-viewport';
|
||||
import { Application, Container, DisplayObject, Graphics, Point } from 'pixi.js';
|
||||
import { GraphicQueryStore } from '../core/GraphicStore';
|
||||
import { GraphicData, GraphicState, GraphicTemplate, GraphicTransform, JlGraphic } from '../core/JlGraphic';
|
||||
import { AbsorbablePosition } from '../graphic';
|
||||
import { AppWsMsgBroker, GraphicQuery, ICreateOnNotFound, type AppStateSubscription, type MessageCliOption } from '../message';
|
||||
import { OperationRecord } from '../operation/JlOperation';
|
||||
import { AnimationManager, IMouseToolOptions } from '../plugins';
|
||||
import { GraphicCopyPlugin } from '../plugins/CopyPlugin';
|
||||
import { AppDragEvent, InteractionPlugin } from '../plugins/InteractionPlugin';
|
||||
import { JlGraphicAppKeyboardPlugin, KeyListener } from '../plugins/KeyboardPlugin';
|
||||
import { ContextMenu, ContextMenuPlugin } from '../ui/ContextMenu';
|
||||
import { MenuItemOptions } from '../ui/Menu';
|
||||
export declare const AppConsts: {
|
||||
viewportname: string;
|
||||
canvasname: string;
|
||||
AssistantAppendsName: string;
|
||||
assistantElementColor: string;
|
||||
};
|
||||
/**
|
||||
* 画布属性
|
||||
*/
|
||||
export interface ICanvasProperties {
|
||||
width: number;
|
||||
height: number;
|
||||
backgroundColor: string;
|
||||
viewportTransform: GraphicTransform;
|
||||
gridBackground?: IGridBackground;
|
||||
}
|
||||
export interface IGridBackground {
|
||||
hasGrid: boolean;
|
||||
lineColor: string;
|
||||
space: number;
|
||||
}
|
||||
export declare class CanvasData implements ICanvasProperties {
|
||||
width: number;
|
||||
height: number;
|
||||
backgroundColor: string;
|
||||
viewportTransform: GraphicTransform;
|
||||
gridBackground: IGridBackground | undefined;
|
||||
constructor(properties?: ICanvasProperties);
|
||||
copyFrom(properties: ICanvasProperties): boolean;
|
||||
clone(): CanvasData;
|
||||
}
|
||||
export interface IJlCanvas extends Container {
|
||||
/**
|
||||
* 获取画布属性
|
||||
*/
|
||||
get properties(): ICanvasProperties;
|
||||
/**
|
||||
* 获取所属场景
|
||||
*/
|
||||
get scene(): IGraphicScene;
|
||||
/**
|
||||
* 更新画布属性
|
||||
* @param properties
|
||||
*/
|
||||
update(properties: ICanvasProperties): void;
|
||||
/**
|
||||
* 添加辅助附加元素
|
||||
* @param appends
|
||||
*/
|
||||
addAssistantAppends(...appends: DisplayObject[]): void;
|
||||
/**
|
||||
* 移除辅助附加元素
|
||||
* @param appends
|
||||
*/
|
||||
removeAssistantAppends(...appends: DisplayObject[]): void;
|
||||
/**
|
||||
* 保存画布及视口缩放数据
|
||||
*/
|
||||
saveData(): ICanvasProperties;
|
||||
}
|
||||
export declare class JlCanvas extends Container implements IJlCanvas {
|
||||
__JlCanvas: boolean;
|
||||
type: string;
|
||||
scene: IGraphicScene;
|
||||
_properties: CanvasData;
|
||||
bg: Graphics;
|
||||
gridBackgroundLine: Container<DisplayObject>;
|
||||
nonInteractiveContainer: Container;
|
||||
assistantAppendContainer: Container;
|
||||
constructor(scene: IGraphicScene, properties?: CanvasData);
|
||||
/**
|
||||
* 图形重绘(数据/状态变化时触发)
|
||||
*/
|
||||
repaint(): void;
|
||||
get width(): number;
|
||||
get height(): number;
|
||||
get backgroundColor(): string;
|
||||
get gridBackground(): IGridBackground | undefined;
|
||||
doRepaint(): void;
|
||||
get properties(): CanvasData;
|
||||
saveData(): CanvasData;
|
||||
update(properties: ICanvasProperties): void;
|
||||
addChild<U extends DisplayObject[]>(...children: U): U[0];
|
||||
removeChild<U extends DisplayObject[]>(...children: U): U[0];
|
||||
/**
|
||||
* 添加无交互Child
|
||||
*/
|
||||
addNonInteractiveChild(...obj: DisplayObject[]): void;
|
||||
removeGraphic(...obj: DisplayObject[]): void;
|
||||
/**
|
||||
* 移除无交互Child
|
||||
*/
|
||||
removeNonInteractiveChild(...obj: DisplayObject[]): void;
|
||||
addAssistantAppends(...appends: DisplayObject[]): void;
|
||||
removeAssistantAppends(...appends: DisplayObject[]): void;
|
||||
/**
|
||||
* 暂停所有可交互对象
|
||||
*/
|
||||
pauseInteractiveChildren(): void;
|
||||
/**
|
||||
* 恢复所有可交互对象
|
||||
*/
|
||||
resumeInteractiveChildren(): void;
|
||||
}
|
||||
/**
|
||||
* 选中改变事件
|
||||
*/
|
||||
export declare class SelectedChangeEvent {
|
||||
graphic: JlGraphic;
|
||||
select: boolean;
|
||||
constructor(graphic: JlGraphic, select: boolean);
|
||||
}
|
||||
/**
|
||||
* 应用事件
|
||||
*/
|
||||
export interface GraphicAppEvents extends GlobalMixins.GraphicAppEvents {
|
||||
graphicstored: [graphic: JlGraphic];
|
||||
graphicdeleted: [graphic: JlGraphic];
|
||||
postdataloaded: [];
|
||||
loadfinish: [];
|
||||
'interaction-plugin-resume': [plugin: InteractionPlugin];
|
||||
'interaction-plugin-pause': [plugin: InteractionPlugin];
|
||||
'options-update': [options: GraphicAppOptions];
|
||||
graphicselectedchange: [graphic: JlGraphic, selected: boolean];
|
||||
graphicchildselectedchange: [child: DisplayObject, selected: boolean];
|
||||
graphicselected: [graphics: JlGraphic[]];
|
||||
'viewport-scaled': [vp: Viewport];
|
||||
drag_op_start: [event: AppDragEvent];
|
||||
drag_op_move: [event: AppDragEvent];
|
||||
drag_op_end: [event: AppDragEvent];
|
||||
'pre-menu-handle': [menu: MenuItemOptions];
|
||||
'post-menu-handle': [menu: MenuItemOptions];
|
||||
'websocket-connect-state-change': [connected: boolean];
|
||||
'websocket-error': [err: Error];
|
||||
destroy: [app: IGraphicApp];
|
||||
}
|
||||
/**
|
||||
* 图形数据存储
|
||||
*/
|
||||
export interface IGraphicStorage {
|
||||
/**
|
||||
* 画布属性
|
||||
*/
|
||||
canvasProperty?: ICanvasProperties;
|
||||
/**
|
||||
* 图形数据
|
||||
*/
|
||||
datas: GraphicData[];
|
||||
}
|
||||
/**
|
||||
* 图形App构造参数
|
||||
*/
|
||||
export interface IGraphicAppConfig {
|
||||
/**
|
||||
* 数据加载
|
||||
* @returns
|
||||
*/
|
||||
dataLoader?: () => Promise<IGraphicStorage>;
|
||||
/**
|
||||
* 最大保存的操作记录数,默认100,越大越占用内存资源
|
||||
*/
|
||||
maxOperationRecords?: number;
|
||||
/**
|
||||
* 拖拽触发移动门槛
|
||||
*/
|
||||
threshold?: number;
|
||||
/**
|
||||
* 通用鼠标工具选项
|
||||
*/
|
||||
mouseToolOptions?: IMouseToolOptions;
|
||||
/**
|
||||
* 可吸附位置列表
|
||||
*/
|
||||
absorbablePositions?: AbsorbablePosition[];
|
||||
/**
|
||||
* 超出屏幕显示范围是否剪裁,默认true
|
||||
*/
|
||||
cullable?: boolean;
|
||||
/**
|
||||
* 是否支持删除操作
|
||||
*/
|
||||
isSupportDeletion?: (g: JlGraphic) => boolean;
|
||||
/**
|
||||
* 辅助元素颜色,默认蓝色
|
||||
*/
|
||||
assistantElementColor?: string;
|
||||
}
|
||||
/**
|
||||
* 图形添加到容器选项
|
||||
*/
|
||||
export interface IInteractiveGraphicOptions {
|
||||
/**
|
||||
* 包含添加到可交互容器的图形类型,和Excludes同时只能存在一个
|
||||
*/
|
||||
interactiveGraphicTypeIncludes?: string[];
|
||||
/**
|
||||
* 不包含添加到可交互容器的图形类型,和Includes同时只能存在一个
|
||||
*/
|
||||
interactiveGraphicTypeExcludes?: string[];
|
||||
}
|
||||
export type GraphicAppOptions = IGraphicAppConfig & IInteractiveGraphicOptions;
|
||||
/**
|
||||
* 图形场景接口
|
||||
*/
|
||||
export interface IGraphicScene extends EventEmitter<GraphicAppEvents> {
|
||||
/**
|
||||
* 获取图形应用对象
|
||||
*/
|
||||
get app(): GraphicApp;
|
||||
/**
|
||||
* 获取pixijs应用对象
|
||||
*/
|
||||
get pixi(): Application;
|
||||
/**
|
||||
* 获取视口对象
|
||||
*/
|
||||
get viewport(): Viewport;
|
||||
/**
|
||||
* 获取画布对象
|
||||
*/
|
||||
get canvas(): IJlCanvas;
|
||||
/**
|
||||
* 获取dom
|
||||
*/
|
||||
get dom(): HTMLElement | undefined;
|
||||
/**
|
||||
* 获取图形查询仓库
|
||||
*/
|
||||
get queryStore(): GraphicQueryStore;
|
||||
/**
|
||||
* 获取选中的图形对象
|
||||
*/
|
||||
get selectedGraphics(): JlGraphic[];
|
||||
/**
|
||||
* 获取动画管理器
|
||||
*/
|
||||
get animationManager(): AnimationManager;
|
||||
/**
|
||||
* 获取配置选项
|
||||
*/
|
||||
get appOptions(): GraphicAppOptions;
|
||||
/**
|
||||
* 设置配置选项
|
||||
* @param options
|
||||
*/
|
||||
setOptions(options: GraphicAppOptions): void;
|
||||
/**
|
||||
* 注册菜单
|
||||
* @param menu
|
||||
*/
|
||||
registerMenu(menu: ContextMenu): void;
|
||||
/**
|
||||
* 将屏幕点转换为画布坐标
|
||||
* @param p 屏幕坐标
|
||||
*/
|
||||
toCanvasCoordinates(p: Point): Point;
|
||||
/**
|
||||
* 加载/重新加载数据(若已经加载过,则不会重新加载)
|
||||
*/
|
||||
reload(): Promise<void>;
|
||||
/**
|
||||
* 强制重新加载,无论是否已经加载过
|
||||
*/
|
||||
forceReload(): Promise<void>;
|
||||
/**
|
||||
* 绑定到dom
|
||||
* @param dom
|
||||
*/
|
||||
bindDom(dom: HTMLElement): void;
|
||||
/**
|
||||
* 从dom节点移除
|
||||
*/
|
||||
unbindDom(): void;
|
||||
/**
|
||||
* 注册图形模板
|
||||
* @param graphicTemplates
|
||||
*/
|
||||
registerGraphicTemplates(...graphicTemplates: GraphicTemplate[]): void;
|
||||
/**
|
||||
* 处理图形状态
|
||||
* @param graphicStates
|
||||
*/
|
||||
handleGraphicStates(graphicStates: GraphicState[], queryer?: GraphicQuery, createOnNotFound?: ICreateOnNotFound): void;
|
||||
/**
|
||||
* 根据类型获取图形模板
|
||||
* @param type
|
||||
*/
|
||||
getGraphicTemplatesByType<GT extends GraphicTemplate>(type: string): GT;
|
||||
/**
|
||||
* 添加图形
|
||||
* @param graphics
|
||||
*/
|
||||
addGraphics(...graphics: JlGraphic[]): void;
|
||||
/**
|
||||
* 删除图形
|
||||
* @param graphics
|
||||
*/
|
||||
deleteGraphics(...graphics: JlGraphic[]): JlGraphic[];
|
||||
/**
|
||||
* 检测并构建关系
|
||||
*/
|
||||
detectRelations(): void;
|
||||
/**
|
||||
* 注册交互插件
|
||||
* @param plugins
|
||||
*/
|
||||
registerInteractionPlugin(...plugins: InteractionPlugin[]): void;
|
||||
/**
|
||||
* 暂停交互插件
|
||||
*/
|
||||
pauseAppInteractionPlugins(): void;
|
||||
/**
|
||||
* 根据name获取交互插件
|
||||
* @param name
|
||||
*/
|
||||
interactionPlugin<P = InteractionPlugin>(name: string): P;
|
||||
/**
|
||||
* 更新选中图形对象
|
||||
* @param graphics
|
||||
*/
|
||||
updateSelected(...graphics: JlGraphic[]): void;
|
||||
/**
|
||||
* 选中所有图形
|
||||
*/
|
||||
selectAllGraphics(): void;
|
||||
/**
|
||||
* 使所选图形居中
|
||||
* @param group
|
||||
*/
|
||||
makeGraphicCenterShow(...group: JlGraphic[]): void;
|
||||
/**
|
||||
* 销毁
|
||||
*/
|
||||
destroy(): void;
|
||||
/**
|
||||
* 订阅websocket消息
|
||||
*/
|
||||
subscribe(sub: AppStateSubscription): void;
|
||||
/**
|
||||
* 取消websocket订阅
|
||||
*/
|
||||
unsubscribe(destination: string): void;
|
||||
/**
|
||||
* 发布websocket消息
|
||||
*/
|
||||
publishMessage(destination: string, message: Uint8Array): void;
|
||||
}
|
||||
declare abstract class GraphicSceneBase extends EventEmitter<GraphicAppEvents> implements IGraphicScene {
|
||||
private graphicStore;
|
||||
_options: GraphicAppOptions;
|
||||
pixi: Application;
|
||||
viewport: Viewport;
|
||||
canvas: JlCanvas;
|
||||
_loaded: boolean;
|
||||
_dom?: HTMLElement;
|
||||
_viewportResizer?: NodeJS.Timeout;
|
||||
graphicTemplateMap: Map<string, GraphicTemplate>;
|
||||
interactionPluginMap: Map<string, InteractionPlugin>;
|
||||
graphicCopyPlugin: GraphicCopyPlugin;
|
||||
animationManager: AnimationManager;
|
||||
menuPlugin: ContextMenuPlugin;
|
||||
private debounceEmitFunc;
|
||||
wsMsgBroker: AppWsMsgBroker;
|
||||
constructor(options: GraphicAppOptions);
|
||||
get appOptions(): GraphicAppOptions;
|
||||
abstract get app(): GraphicApp;
|
||||
get dom(): HTMLElement | undefined;
|
||||
get queryStore(): GraphicQueryStore;
|
||||
get selectedGraphics(): JlGraphic[];
|
||||
private load;
|
||||
/**
|
||||
* 重新加载数据
|
||||
*/
|
||||
reload(): Promise<void>;
|
||||
forceReload(): Promise<void>;
|
||||
/**
|
||||
* 更新选项
|
||||
* @param options
|
||||
*/
|
||||
setOptions(options: GraphicAppOptions): void;
|
||||
toCanvasCoordinates(p: Point): Point;
|
||||
/**
|
||||
* 注册菜单
|
||||
* @param menu
|
||||
*/
|
||||
registerMenu(menu: ContextMenu): void;
|
||||
/**
|
||||
* 注册图形对象模板
|
||||
* @param graphicTemplates
|
||||
*/
|
||||
registerGraphicTemplates(...graphicTemplates: GraphicTemplate[]): void;
|
||||
getGraphicTemplatesByType<GT extends GraphicTemplate>(type: string): GT;
|
||||
private updateViewport;
|
||||
/**
|
||||
* 暂停
|
||||
*/
|
||||
private pause;
|
||||
/**
|
||||
* 恢复
|
||||
*/
|
||||
private resume;
|
||||
bindDom(dom: HTMLElement): void;
|
||||
unbindDom(): void;
|
||||
/**
|
||||
* 加载图形,GraphicApp默认添加到无交互容器,DrawApp默认添加到交互容器,如需定制,提供选项配置
|
||||
* @param protos
|
||||
* @param options 添加到可交互/不可交互容器选项配置
|
||||
*/
|
||||
loadGraphic(protos: GraphicData[]): Promise<void>;
|
||||
/**
|
||||
* 添加图形前处理
|
||||
* @param graphic
|
||||
*/
|
||||
beforeGraphicStore(graphic: JlGraphic): void;
|
||||
/**
|
||||
* 执行添加图形对象
|
||||
* @param graphic
|
||||
*/
|
||||
private doAddGraphics;
|
||||
private doDeleteGraphics;
|
||||
/**
|
||||
* 存储图形
|
||||
* @param graphics 图形对象
|
||||
*/
|
||||
addGraphics(...graphics: JlGraphic[]): void;
|
||||
/**
|
||||
* 删除图形
|
||||
* @param graphics 图形对象
|
||||
*/
|
||||
deleteGraphics(...graphics: JlGraphic[]): JlGraphic[];
|
||||
/**
|
||||
* 检测并构建关系
|
||||
*/
|
||||
detectRelations(): void;
|
||||
/**
|
||||
* 全选
|
||||
*/
|
||||
selectAllGraphics(filter?: (g: JlGraphic) => boolean): void;
|
||||
/**
|
||||
* 更新选中
|
||||
*/
|
||||
updateSelected(...graphics: JlGraphic[]): void;
|
||||
private doEmitAppGraphicSelected;
|
||||
/**
|
||||
* 更新画布
|
||||
* @param param
|
||||
*/
|
||||
updateCanvas(param: ICanvasProperties): void;
|
||||
/**
|
||||
* 使图形居中显示(所有图形的外包围盒)
|
||||
*/
|
||||
makeGraphicCenterShow(...group: JlGraphic[]): void;
|
||||
/**
|
||||
* 注册交互插件,会替换旧的
|
||||
*/
|
||||
registerInteractionPlugin(...plugins: InteractionPlugin[]): void;
|
||||
/**
|
||||
* 根据名称获取交互插件
|
||||
* @param name
|
||||
* @returns
|
||||
*/
|
||||
interactionPlugin<P = InteractionPlugin>(name: string): P;
|
||||
/**
|
||||
* 停止应用交互插件
|
||||
*/
|
||||
pauseAppInteractionPlugins(): void;
|
||||
private doPauseInteractionPlugin;
|
||||
/**
|
||||
* 移除交互插件
|
||||
*/
|
||||
removeInteractionPlugin(plugin: InteractionPlugin): void;
|
||||
private checkWsMsgCli;
|
||||
/**
|
||||
* 订阅websocket消息
|
||||
*/
|
||||
subscribe(sub: AppStateSubscription): void;
|
||||
/**
|
||||
* 取消websocket订阅
|
||||
*/
|
||||
unsubscribe(destination: string): void;
|
||||
/**
|
||||
* 发布websocket消息
|
||||
*/
|
||||
publishMessage(destination: string, message: Uint8Array): void;
|
||||
/**
|
||||
* 处理图形状态
|
||||
* @param graphicStates
|
||||
*/
|
||||
handleGraphicStates(graphicStates: GraphicState[], queryer?: GraphicQuery, createOnNotFound?: ICreateOnNotFound): void;
|
||||
/**
|
||||
* 销毁
|
||||
*/
|
||||
destroy(): void;
|
||||
}
|
||||
/**
|
||||
* 图形应用接口
|
||||
*/
|
||||
export interface IGraphicApp extends IGraphicScene {
|
||||
get opRecord(): OperationRecord;
|
||||
/**
|
||||
* 实例化一个场景
|
||||
* @param code 场景标识
|
||||
* @returns
|
||||
*/
|
||||
initScene(code: string, options: GraphicAppOptions): IGraphicScene;
|
||||
/**
|
||||
* 获取场景
|
||||
* @param code
|
||||
* @returns
|
||||
*/
|
||||
getScene(code: string): IGraphicScene;
|
||||
/**
|
||||
* 切换场景
|
||||
* @param dom
|
||||
*/
|
||||
switchScene(code: string, dom: HTMLElement): void;
|
||||
/**
|
||||
* 移除指定code场景
|
||||
* @param code
|
||||
*/
|
||||
removeScene(code: string): void;
|
||||
/**
|
||||
* 添加图形并记录
|
||||
* @param graphics
|
||||
*/
|
||||
addGraphicAndRecord(...graphics: JlGraphic[]): void;
|
||||
/**
|
||||
* 删除图形并记录
|
||||
* @param graphics
|
||||
*/
|
||||
deleteGraphicAndRecord(...graphics: JlGraphic[]): void;
|
||||
/**
|
||||
* 启动websocket消息客户端
|
||||
*/
|
||||
enableWsMassaging(options: MessageCliOption): void;
|
||||
/**
|
||||
* 添加键盘监听器,如果是相同的按键,新注册的会覆盖旧的,当移除新的时,旧的自动生效
|
||||
* @param keyListeners
|
||||
*/
|
||||
addKeyboardListener(...keyListeners: KeyListener[]): void;
|
||||
/**
|
||||
* 移除键盘监听器
|
||||
* @param keyListeners
|
||||
*/
|
||||
removeKeyboardListener(...keyListeners: KeyListener[]): void;
|
||||
}
|
||||
/**
|
||||
* 图形app基类
|
||||
*/
|
||||
export declare class GraphicApp extends GraphicSceneBase implements IGraphicApp {
|
||||
/**
|
||||
* 场景列表
|
||||
*/
|
||||
scenes: Map<string, JlScene>;
|
||||
opRecord: OperationRecord;
|
||||
keyboardPlugin: JlGraphicAppKeyboardPlugin;
|
||||
constructor(options: GraphicAppOptions);
|
||||
get app(): GraphicApp;
|
||||
setOptions(options: GraphicAppOptions): void;
|
||||
addGraphicAndRecord(...graphics: JlGraphic[]): void;
|
||||
deleteGraphicAndRecord(...graphics: JlGraphic[]): void;
|
||||
/**
|
||||
* 实例化一个场景
|
||||
* @param code 场景标识
|
||||
* @returns
|
||||
*/
|
||||
initScene(code: string, options: GraphicAppOptions): IGraphicScene;
|
||||
/**
|
||||
* 获取场景
|
||||
* @param code
|
||||
* @returns
|
||||
*/
|
||||
getScene(code: string): IGraphicScene;
|
||||
switchScene(code: string, dom: HTMLElement): void;
|
||||
removeScene(code: string): void;
|
||||
/**
|
||||
* 启动websocket消息客户端
|
||||
*/
|
||||
enableWsMassaging(options: MessageCliOption): void;
|
||||
/**
|
||||
* 添加键盘监听器,如果是相同的按键,新注册的会覆盖旧的,当移除新的时,旧的自动生效
|
||||
* @param keyListeners
|
||||
*/
|
||||
addKeyboardListener(...keyListeners: KeyListener[]): void;
|
||||
/**
|
||||
* 移除键盘监听器
|
||||
* @param keyListeners
|
||||
*/
|
||||
removeKeyboardListener(...keyListeners: KeyListener[]): void;
|
||||
/**
|
||||
* 销毁
|
||||
*/
|
||||
destroy(): void;
|
||||
}
|
||||
/**
|
||||
* 场景
|
||||
*/
|
||||
export default class JlScene extends GraphicSceneBase {
|
||||
code: string;
|
||||
app: GraphicApp;
|
||||
constructor(app: GraphicApp, code: string, options: GraphicAppOptions);
|
||||
}
|
||||
export {};
|
17
lib/app/index.d.ts
vendored
17
lib/app/index.d.ts
vendored
@ -1,17 +0,0 @@
|
||||
import { DrawAppOptions, DrawAssistant, GraphicDrawAssistant, IDrawApp } from './JlDrawApp';
|
||||
import { AppConsts, GraphicAppOptions, ICanvasProperties, IGraphicApp, IGraphicScene, IGraphicStorage, IJlCanvas, IGridBackground } from './JlGraphicApp';
|
||||
import { GraphicDataUpdateOperation } from './BasicOperation';
|
||||
/**
|
||||
* 实例化图形app
|
||||
* @param options
|
||||
* @returns
|
||||
*/
|
||||
export declare function newGraphicApp(options: GraphicAppOptions): IGraphicApp;
|
||||
/**
|
||||
* 实例化绘图app
|
||||
* @param options
|
||||
* @returns
|
||||
*/
|
||||
export declare function newDrawApp(options: DrawAppOptions): IDrawApp;
|
||||
export { AppConsts, GraphicDrawAssistant, GraphicDataUpdateOperation };
|
||||
export type { DrawAssistant, ICanvasProperties, IDrawApp, IGraphicApp, IGraphicScene, IGraphicStorage, IJlCanvas, IGridBackground };
|
82
lib/core/GraphicRelation.d.ts
vendored
82
lib/core/GraphicRelation.d.ts
vendored
@ -1,82 +0,0 @@
|
||||
import { JlGraphic } from './JlGraphic';
|
||||
/**
|
||||
* 图形关系数据
|
||||
*/
|
||||
export declare class GraphicRelationParam {
|
||||
g: JlGraphic;
|
||||
param: any;
|
||||
constructor(g: JlGraphic, param?: any);
|
||||
isTheGraphic(g: JlGraphic): boolean;
|
||||
getGraphic<G extends JlGraphic>(): G;
|
||||
getParam<P>(): P;
|
||||
equals(other: GraphicRelationParam): boolean;
|
||||
}
|
||||
/**
|
||||
* 图形关系
|
||||
*/
|
||||
export declare class GraphicRelation {
|
||||
rp1: GraphicRelationParam;
|
||||
rp2: GraphicRelationParam;
|
||||
constructor(rp1: GraphicRelationParam, rp2: GraphicRelationParam);
|
||||
contains(g: JlGraphic): boolean;
|
||||
/**
|
||||
* 获取给定图形的关系参数
|
||||
* @param g
|
||||
* @returns
|
||||
*/
|
||||
getRelationParam(g: JlGraphic): GraphicRelationParam;
|
||||
/**
|
||||
* 获取关联的另一个图形的关系参数
|
||||
* @param g
|
||||
* @returns
|
||||
*/
|
||||
getOtherRelationParam(g: JlGraphic): GraphicRelationParam;
|
||||
/**
|
||||
* 获取关联的另一个图形对象
|
||||
* @param g
|
||||
* @returns graphic
|
||||
*/
|
||||
getOtherGraphic<G extends JlGraphic>(g: JlGraphic): G;
|
||||
equals(orp1: GraphicRelationParam, orp2: GraphicRelationParam): boolean;
|
||||
isEqualOther(other: GraphicRelation): boolean;
|
||||
}
|
||||
/**
|
||||
* 图形关系管理
|
||||
*/
|
||||
export declare class RelationManage {
|
||||
relations: GraphicRelation[];
|
||||
isContainsRelation(rp1: GraphicRelationParam, rp2: GraphicRelationParam): boolean;
|
||||
addRelation(rp1: GraphicRelationParam | JlGraphic, rp2: GraphicRelationParam | JlGraphic): void;
|
||||
/**
|
||||
* 获取图形的所有关系
|
||||
* @param g
|
||||
* @returns
|
||||
*/
|
||||
getRelationsOfGraphic(g: JlGraphic): GraphicRelation[];
|
||||
/**
|
||||
* 获取指定图形的指定关系图形类型的所有关系
|
||||
* @param g 指定图形
|
||||
* @param type 关联图形的类型
|
||||
* @returns
|
||||
*/
|
||||
getRelationsOfGraphicAndOtherType(g: JlGraphic, type: string): GraphicRelation[];
|
||||
/**
|
||||
* 删除关系
|
||||
* @param relation
|
||||
*/
|
||||
private deleteRelation;
|
||||
/**
|
||||
* 删除指定图形的所有关系
|
||||
* @param g
|
||||
*/
|
||||
deleteRelationOfGraphic(g: JlGraphic): void;
|
||||
/**
|
||||
* 删除指定图形的所有关系
|
||||
* @param g
|
||||
*/
|
||||
deleteRelationOfGraphicAndOtherType(g: JlGraphic, type: string): void;
|
||||
/**
|
||||
* 清空
|
||||
*/
|
||||
clear(): void;
|
||||
}
|
92
lib/core/GraphicStore.d.ts
vendored
92
lib/core/GraphicStore.d.ts
vendored
@ -1,92 +0,0 @@
|
||||
import { RelationManage } from './GraphicRelation';
|
||||
import { JlGraphic } from './JlGraphic';
|
||||
export interface GraphicQueryStore {
|
||||
/**
|
||||
* 获取所有图形对象
|
||||
*/
|
||||
getAllGraphics(): JlGraphic[];
|
||||
/**
|
||||
* 根据id获取图形
|
||||
*/
|
||||
queryById<T extends JlGraphic>(id: number | string): T;
|
||||
/**
|
||||
* 根据id模糊查询图形
|
||||
* @param id
|
||||
*/
|
||||
queryByIdAmbiguous(id: number | string): JlGraphic[];
|
||||
/**
|
||||
* 根据类型获取图形列表
|
||||
*/
|
||||
queryByType<T extends JlGraphic>(type: string): T[];
|
||||
/**
|
||||
* 根据code查询
|
||||
* @param code
|
||||
*/
|
||||
queryByCode(code: string): JlGraphic[] | undefined;
|
||||
/**
|
||||
* 根据code模糊查询图形
|
||||
* @param code
|
||||
* @param type
|
||||
*/
|
||||
queryByCodeAmbiguous(code: string): JlGraphic[];
|
||||
/**
|
||||
* 根据id或code查询图形
|
||||
* @param v
|
||||
*/
|
||||
queryByIdOrCode(v: string | number): JlGraphic[];
|
||||
/**
|
||||
* 根据id或code及类型查询图形
|
||||
* @param v
|
||||
* @param type
|
||||
*/
|
||||
queryByIdOrCodeAndType(v: string | number, type: string): JlGraphic[];
|
||||
/**
|
||||
* 根据code和类型获取图形
|
||||
* @param code
|
||||
* @param type
|
||||
*/
|
||||
queryByCodeAndType<T extends JlGraphic>(code: string, type: string): T | undefined;
|
||||
/**
|
||||
* 根据code和类型模糊查询图形
|
||||
* @param code
|
||||
* @param type
|
||||
*/
|
||||
queryByCodeAndTypeAmbiguous<T extends JlGraphic>(code: string, type: string): T[];
|
||||
checkIdExist(v: number): boolean;
|
||||
}
|
||||
/**
|
||||
* 图形存储
|
||||
*/
|
||||
export declare class GraphicStore implements GraphicQueryStore {
|
||||
store: Map<number, JlGraphic>;
|
||||
relationManage: RelationManage;
|
||||
constructor();
|
||||
/**
|
||||
* 获取所有图形对象
|
||||
*/
|
||||
getAllGraphics(): JlGraphic[];
|
||||
queryById<T extends JlGraphic>(id: number | string): T;
|
||||
queryByIdAmbiguous(id: number | string): JlGraphic[];
|
||||
queryByType<T extends JlGraphic>(type: string): T[];
|
||||
queryByCode(code: string): JlGraphic[] | undefined;
|
||||
queryByCodeAmbiguous(code: string): JlGraphic[];
|
||||
queryByIdOrCode(s: string | number): JlGraphic[];
|
||||
queryByIdOrCodeAndType(s: string | number, type: string): JlGraphic[];
|
||||
queryByCodeAndType<T extends JlGraphic>(code: string, type: string): T | undefined;
|
||||
queryByCodeAndTypeAmbiguous<T extends JlGraphic>(code: string, type: string): T[];
|
||||
/**
|
||||
* 存储图形对象
|
||||
* @param graphics 要存储的图形
|
||||
*/
|
||||
storeGraphics(graphic: JlGraphic): boolean;
|
||||
/**
|
||||
* 删除图形
|
||||
* @param graph 要删除的图形
|
||||
*/
|
||||
deleteGraphics(graphic: JlGraphic): JlGraphic | undefined;
|
||||
/**
|
||||
* 清空
|
||||
*/
|
||||
clear(): void;
|
||||
checkIdExist(id: number): boolean;
|
||||
}
|
12
lib/core/IdGenerator.d.ts
vendored
12
lib/core/IdGenerator.d.ts
vendored
@ -1,12 +0,0 @@
|
||||
/**
|
||||
* ID生成器
|
||||
*/
|
||||
export declare class IdGenerator {
|
||||
serial: number;
|
||||
type: string;
|
||||
constructor(type: string);
|
||||
next(): number;
|
||||
getType(): string;
|
||||
initSerial(serial: number): void;
|
||||
}
|
||||
export declare const GraphicIdGenerator: IdGenerator;
|
284
lib/core/JlGraphic.d.ts
vendored
284
lib/core/JlGraphic.d.ts
vendored
@ -1,284 +0,0 @@
|
||||
import { Container, DisplayObject, IPointData, Rectangle } from 'pixi.js';
|
||||
import { GraphicRelation, RelationManage } from './GraphicRelation';
|
||||
import { GraphicQueryStore } from './GraphicStore';
|
||||
export interface IGraphicTransform {
|
||||
position: IPointData;
|
||||
scale: IPointData;
|
||||
rotation: number;
|
||||
skew: IPointData;
|
||||
}
|
||||
/**
|
||||
* 图形变换数据
|
||||
*/
|
||||
export declare class GraphicTransform {
|
||||
position: IPointData;
|
||||
scale: IPointData;
|
||||
rotation: number;
|
||||
skew: IPointData;
|
||||
constructor(position: IPointData, scale: IPointData, rotation: number, skew: IPointData);
|
||||
static default(): GraphicTransform;
|
||||
static fromObject(obj: DisplayObject): GraphicTransform;
|
||||
static from(transform: IGraphicTransform | undefined): GraphicTransform;
|
||||
}
|
||||
export interface IChildTransform {
|
||||
name: string;
|
||||
transform: IGraphicTransform;
|
||||
}
|
||||
/**
|
||||
* 图形子元素变换
|
||||
*/
|
||||
export declare class ChildTransform {
|
||||
name: string;
|
||||
transform: GraphicTransform;
|
||||
constructor(name: string, transform: GraphicTransform);
|
||||
static fromChild(child: DisplayObject): ChildTransform;
|
||||
static from(ct: IChildTransform): ChildTransform;
|
||||
}
|
||||
/**
|
||||
* 图形数据
|
||||
*/
|
||||
export interface GraphicData {
|
||||
get id(): number;
|
||||
set id(v: number);
|
||||
get graphicType(): string;
|
||||
set graphicType(v: string);
|
||||
get transform(): GraphicTransform;
|
||||
set transform(v: GraphicTransform);
|
||||
get childTransforms(): ChildTransform[] | undefined;
|
||||
set childTransforms(v: ChildTransform[] | undefined);
|
||||
/**
|
||||
* 克隆消息
|
||||
*/
|
||||
clone(): GraphicData;
|
||||
/**
|
||||
* 从给定数据拷贝
|
||||
* @param data
|
||||
*/
|
||||
copyFrom(data: GraphicData): void;
|
||||
/**
|
||||
* 是否相等
|
||||
* @param other
|
||||
*/
|
||||
eq(other: GraphicData): boolean;
|
||||
}
|
||||
/**
|
||||
* 图形状态
|
||||
*/
|
||||
export interface GraphicState {
|
||||
get code(): string;
|
||||
get graphicType(): string;
|
||||
remove?: boolean;
|
||||
/**
|
||||
* 克隆消息
|
||||
*/
|
||||
clone(): GraphicState;
|
||||
/**
|
||||
* 从给定数据拷贝
|
||||
* @param data
|
||||
*/
|
||||
copyFrom(data: GraphicState): void;
|
||||
/**
|
||||
* 是否相等
|
||||
* @param data
|
||||
*/
|
||||
eq(data: GraphicState): boolean;
|
||||
}
|
||||
export interface GraphicAnimationOptions {
|
||||
name: string;
|
||||
run?: (dt: number) => void;
|
||||
}
|
||||
export declare class GraphicAnimation {
|
||||
options: GraphicAnimationOptions;
|
||||
_running: boolean;
|
||||
/**
|
||||
* 倍速
|
||||
*/
|
||||
_xSpeed: number;
|
||||
constructor(options: GraphicAnimationOptions);
|
||||
static init(options: GraphicAnimationOptions): GraphicAnimation;
|
||||
pause(): GraphicAnimation;
|
||||
resume(): GraphicAnimation;
|
||||
get name(): string;
|
||||
get running(): boolean;
|
||||
get xSpeed(): number;
|
||||
set xSpeed(v: number);
|
||||
run(dt: number): GraphicAnimation;
|
||||
}
|
||||
/**
|
||||
* 图形对象基类
|
||||
*/
|
||||
export declare abstract class JlGraphic extends Container {
|
||||
readonly __JlGraphic: true;
|
||||
readonly type: string;
|
||||
private _id;
|
||||
private _code;
|
||||
_datas?: GraphicData;
|
||||
_states?: GraphicState;
|
||||
private _relationManage?;
|
||||
private _queryStore?;
|
||||
constructor(type: string);
|
||||
/**
|
||||
* 添加图形动画,只有在画布上才能添加
|
||||
* @param animation
|
||||
*/
|
||||
addAnimation(animation: GraphicAnimation): void;
|
||||
removeAnimation(name: string): void;
|
||||
animation(name: string): GraphicAnimation | undefined;
|
||||
removeAllAnimation(): void;
|
||||
/**
|
||||
* 更新选中状态
|
||||
* @param selected
|
||||
* @returns 是否更新
|
||||
*/
|
||||
updateSelected(selected: boolean): boolean;
|
||||
invertSelected(): void;
|
||||
fireSelected(): void;
|
||||
hasSelectedChilds(): boolean;
|
||||
setChildSelected(child: DisplayObject): boolean;
|
||||
invertChildSelected(child: DisplayObject): boolean;
|
||||
removeAllChildSelected(): void;
|
||||
fireChildSelected(child: DisplayObject): void;
|
||||
exitChildEdit(): void;
|
||||
/**
|
||||
* 是否此对象id/code
|
||||
*/
|
||||
isIdOrCode(s: string | number): boolean;
|
||||
/**
|
||||
* 获取图形id,如果图形数据对象存在,则返回图形数据对象id
|
||||
*/
|
||||
get id(): number;
|
||||
/**
|
||||
* 设置图形id,如果图形数据存在,则同时设置图形数据id
|
||||
*/
|
||||
set id(v: number);
|
||||
/**
|
||||
* 获取图形业务code,如果业务code在图形数据或图形状态中,则需要重写此方法
|
||||
*/
|
||||
get code(): string;
|
||||
/**
|
||||
* 设置图形业务code,如果业务code在图形数据或图形状态中,则需要重写此方法
|
||||
*/
|
||||
set code(v: string);
|
||||
getDatas<D extends GraphicData>(): D;
|
||||
getStates<S extends GraphicState>(): S;
|
||||
get queryStore(): GraphicQueryStore;
|
||||
set queryStore(v: GraphicQueryStore);
|
||||
get relationManage(): RelationManage;
|
||||
set relationManage(v: RelationManage);
|
||||
/**
|
||||
* 构建图形关系
|
||||
* @param g
|
||||
*/
|
||||
buildRelation(): void;
|
||||
/**
|
||||
* 从数据加载恢复图形关系
|
||||
*/
|
||||
loadRelations(): void;
|
||||
/**
|
||||
* 获取当前图形的所有图形关系
|
||||
* @returns
|
||||
*/
|
||||
getAllRelations(): GraphicRelation[];
|
||||
/**
|
||||
* 获取当前图形的所有指定类型图形关系
|
||||
* @param type
|
||||
* @returns
|
||||
*/
|
||||
queryRelationByType(type: string): GraphicRelation[];
|
||||
/**
|
||||
* 删除当前图形关联的指定类型的关系
|
||||
* @param type
|
||||
*/
|
||||
deleteRelationByType(type: string): void;
|
||||
/**
|
||||
* 构建并保存关系数据到datas中
|
||||
*/
|
||||
saveRelations(): void;
|
||||
/**
|
||||
* 保存数据,复制,非原始数据
|
||||
* @returns
|
||||
*/
|
||||
saveData<D extends GraphicData>(): D;
|
||||
/**
|
||||
* 构建子元素变换列表
|
||||
* @returns
|
||||
*/
|
||||
private buildChildTransforms;
|
||||
/**
|
||||
* 加载数据
|
||||
* @param data
|
||||
*/
|
||||
loadData(data: GraphicData): void;
|
||||
private loadTransformFrom;
|
||||
/**
|
||||
* 更新图形数据
|
||||
* @param data
|
||||
* @returns
|
||||
*/
|
||||
updateData(data: GraphicData): boolean;
|
||||
/**
|
||||
* 图形数据更新
|
||||
*/
|
||||
onDataChange(newVal: GraphicData, old?: GraphicData): void;
|
||||
/**
|
||||
* 加载状态
|
||||
* @param state
|
||||
*/
|
||||
loadState(state: GraphicState): void;
|
||||
/**
|
||||
* 更新状态
|
||||
* @param state
|
||||
* @returns
|
||||
*/
|
||||
updateStates(state: GraphicState): boolean;
|
||||
/**
|
||||
* 图形状态更新处理
|
||||
*/
|
||||
onStateChange(newVal: GraphicState, old?: GraphicState): void;
|
||||
repaint(): void;
|
||||
/**
|
||||
* 处理重绘逻辑
|
||||
*/
|
||||
abstract doRepaint(): void;
|
||||
/**
|
||||
* 处理删除逻辑
|
||||
*/
|
||||
onDelete(): void;
|
||||
/**
|
||||
* 框选检测,默认取图形包围盒判定,若需要精细判定-子类重写此方法
|
||||
* @param box
|
||||
* @returns
|
||||
*/
|
||||
boxIntersectCheck(box: Rectangle): boolean;
|
||||
}
|
||||
export type CreateData = () => GraphicData;
|
||||
export type CreateState = () => GraphicState;
|
||||
export interface IGraphicTemplateOptions {
|
||||
dataTemplate?: GraphicData;
|
||||
stateTemplate?: GraphicState;
|
||||
}
|
||||
/**
|
||||
* 图形对象模板
|
||||
*/
|
||||
export declare abstract class JlGraphicTemplate<G extends JlGraphic> {
|
||||
readonly type: string;
|
||||
options: IGraphicTemplateOptions;
|
||||
constructor(type: string, options: IGraphicTemplateOptions);
|
||||
get datas(): GraphicData;
|
||||
get states(): GraphicState;
|
||||
/**
|
||||
* 初始化一个新的图形对象
|
||||
*/
|
||||
abstract new(): G;
|
||||
/**
|
||||
* 加载图形对象需要用到的资源
|
||||
*/
|
||||
loadAssets(): Promise<any>;
|
||||
/**
|
||||
* 克隆图形对象
|
||||
* @param graphic
|
||||
* @returns
|
||||
*/
|
||||
clone(graphic: G): G;
|
||||
}
|
||||
export type GraphicTemplate = JlGraphicTemplate<JlGraphic>;
|
4
lib/core/index.d.ts
vendored
4
lib/core/index.d.ts
vendored
@ -1,4 +0,0 @@
|
||||
export * from './JlGraphic';
|
||||
export * from './IdGenerator';
|
||||
export * from './GraphicRelation';
|
||||
export * from './GraphicStore';
|
91
lib/graphic/AbsorbablePosition.d.ts
vendored
91
lib/graphic/AbsorbablePosition.d.ts
vendored
@ -1,91 +0,0 @@
|
||||
import { Container, DisplayObject, Graphics, IPointData, Point } from 'pixi.js';
|
||||
import { VectorGraphic } from './VectorGraphic';
|
||||
/**
|
||||
* 抽象可吸附位置
|
||||
*/
|
||||
export interface AbsorbablePosition extends Container {
|
||||
/**
|
||||
* 是否与另一个可吸附位置重叠(相似,但可能范围不同)
|
||||
* @param other
|
||||
*/
|
||||
isOverlapping(other: AbsorbablePosition): boolean;
|
||||
/**
|
||||
* 与另一个相似的吸附位置比较范围大小
|
||||
* @param other
|
||||
* @returns >0此吸附范围大,<0另一个吸附范围大,=0两个吸附范围一样大
|
||||
*/
|
||||
compareTo(other: AbsorbablePosition): number;
|
||||
/**
|
||||
* 尝试吸附图形对象
|
||||
* @param objs 图形对象列表
|
||||
* @returns 如果吸附成功,返回true,否则false
|
||||
*/
|
||||
tryAbsorb(...objs: DisplayObject[]): void;
|
||||
}
|
||||
/**
|
||||
* 可吸附点图形参数
|
||||
*/
|
||||
export declare const AbsorbablePointParam: {
|
||||
lineWidth: number;
|
||||
lineColor: string;
|
||||
fillColor: string;
|
||||
radius: number;
|
||||
};
|
||||
/**
|
||||
* 可吸附点
|
||||
*/
|
||||
export declare class AbsorbablePoint extends Graphics implements AbsorbablePosition, VectorGraphic {
|
||||
_point: Point;
|
||||
absorbRange: number;
|
||||
scaledListenerOn: boolean;
|
||||
/**
|
||||
*
|
||||
* @param point 画布坐标
|
||||
* @param absorbRange
|
||||
*/
|
||||
constructor(point: IPointData, absorbRange?: number);
|
||||
compareTo(other: AbsorbablePosition): number;
|
||||
isOverlapping(other: AbsorbablePosition): boolean;
|
||||
tryAbsorb(...objs: DisplayObject[]): void;
|
||||
updateOnScaled(): void;
|
||||
}
|
||||
/**
|
||||
* 可吸附线
|
||||
*/
|
||||
export declare class AbsorbableLine extends Graphics implements AbsorbablePosition {
|
||||
p1: Point;
|
||||
p2: Point;
|
||||
absorbRange: number;
|
||||
_color: string;
|
||||
/**
|
||||
*
|
||||
* @param p1 画布坐标
|
||||
* @param p2 画布坐标
|
||||
* @param absorbRange
|
||||
*/
|
||||
constructor(p1: IPointData, p2: IPointData, absorbRange?: number);
|
||||
isOverlapping(other: AbsorbablePosition): boolean;
|
||||
compareTo(other: AbsorbablePosition): number;
|
||||
redraw(): void;
|
||||
tryAbsorb(...objs: DisplayObject[]): void;
|
||||
}
|
||||
/**
|
||||
* 可吸附圆
|
||||
*/
|
||||
export declare class AbsorbableCircle extends Graphics implements AbsorbablePosition {
|
||||
absorbRange: number;
|
||||
p0: Point;
|
||||
radius: number;
|
||||
_color: string;
|
||||
/**
|
||||
*
|
||||
* @param p 画布坐标
|
||||
* @param radius
|
||||
* @param absorbRange
|
||||
*/
|
||||
constructor(p: IPointData, radius: number, absorbRange?: number);
|
||||
isOverlapping(other: AbsorbablePosition): boolean;
|
||||
compareTo(other: AbsorbablePosition): number;
|
||||
redraw(): void;
|
||||
tryAbsorb(...objs: DisplayObject[]): void;
|
||||
}
|
39
lib/graphic/DashedLine.d.ts
vendored
39
lib/graphic/DashedLine.d.ts
vendored
@ -1,39 +0,0 @@
|
||||
import { Container, IPointData, Point } from 'pixi.js';
|
||||
export interface IDashedLineOptions {
|
||||
/**
|
||||
* 每小段长度,默认4
|
||||
*/
|
||||
length?: number;
|
||||
/**
|
||||
* 起始间隔,默认0
|
||||
*/
|
||||
startSpace?: number;
|
||||
/**
|
||||
* 间隔长度,默认4
|
||||
*/
|
||||
space?: number;
|
||||
/**
|
||||
* 线宽,默认1
|
||||
*/
|
||||
lineWidth?: number;
|
||||
/**
|
||||
* 线色,默认黑
|
||||
*/
|
||||
color?: string;
|
||||
}
|
||||
interface ICompleteDashedLineOptions extends IDashedLineOptions {
|
||||
length: number;
|
||||
startSpace: number;
|
||||
space: number;
|
||||
lineWidth: number;
|
||||
color: string;
|
||||
}
|
||||
export declare class DashedLine extends Container {
|
||||
p1: Point;
|
||||
p2: Point;
|
||||
_options: ICompleteDashedLineOptions;
|
||||
constructor(p1: IPointData, p2: IPointData, options?: IDashedLineOptions);
|
||||
setOptions(options: IDashedLineOptions): void;
|
||||
redraw(): void;
|
||||
}
|
||||
export {};
|
23
lib/graphic/DraggablePoint.d.ts
vendored
23
lib/graphic/DraggablePoint.d.ts
vendored
@ -1,23 +0,0 @@
|
||||
import { Graphics, IPointData } from 'pixi.js';
|
||||
import { VectorGraphic } from './VectorGraphic';
|
||||
/**
|
||||
* 拖拽点参数
|
||||
*/
|
||||
export declare const DraggablePointParam: {
|
||||
lineWidth: number;
|
||||
lineColor: number;
|
||||
fillColor: number;
|
||||
radius: number;
|
||||
};
|
||||
/**
|
||||
* 拖拽点,用于更新图形属性
|
||||
*/
|
||||
export declare class DraggablePoint extends Graphics implements VectorGraphic {
|
||||
scaledListenerOn: boolean;
|
||||
/**
|
||||
*
|
||||
* @param point 画布坐标点
|
||||
*/
|
||||
constructor(point: IPointData);
|
||||
updateOnScaled(): void;
|
||||
}
|
8
lib/graphic/VectorGraphic.d.ts
vendored
8
lib/graphic/VectorGraphic.d.ts
vendored
@ -1,8 +0,0 @@
|
||||
import { DisplayObject } from 'pixi.js';
|
||||
export interface VectorGraphic extends DisplayObject {
|
||||
scaledListenerOn: boolean;
|
||||
updateOnScaled(): void;
|
||||
}
|
||||
export declare class VectorGraphicUtil {
|
||||
static handle(obj: VectorGraphic): void;
|
||||
}
|
16
lib/graphic/VectorText.d.ts
vendored
16
lib/graphic/VectorText.d.ts
vendored
@ -1,16 +0,0 @@
|
||||
import { ICanvas, ITextStyle, Text, TextStyle } from 'pixi.js';
|
||||
import { VectorGraphic } from '.';
|
||||
/**
|
||||
* 矢量文字.实现原理:在缩放发生变化时,更新fontSize
|
||||
*/
|
||||
export declare class VectorText extends Text implements VectorGraphic {
|
||||
vectorFontSize: number;
|
||||
scaled: number;
|
||||
scaledListenerOn: boolean;
|
||||
constructor(text?: string | number, style?: Partial<ITextStyle> | TextStyle, canvas?: ICanvas);
|
||||
updateOnScaled(): void;
|
||||
/**
|
||||
* 设置矢量文字的字体大小
|
||||
*/
|
||||
setVectorFontSize(fontSize: number): void;
|
||||
}
|
5
lib/graphic/index.d.ts
vendored
5
lib/graphic/index.d.ts
vendored
@ -1,5 +0,0 @@
|
||||
export * from './VectorGraphic';
|
||||
export * from './VectorText';
|
||||
export * from './DraggablePoint';
|
||||
export * from './AbsorbablePosition';
|
||||
export * from './DashedLine';
|
7814
lib/index.js
7814
lib/index.js
File diff suppressed because it is too large
Load Diff
17
lib/math/Constants.d.ts
vendored
17
lib/math/Constants.d.ts
vendored
@ -1,17 +0,0 @@
|
||||
/**
|
||||
* 浮点数相等判断误差值
|
||||
*/
|
||||
export declare const epsilon = 0.00001;
|
||||
/**
|
||||
* 判断浮点数是不是0
|
||||
* @param v
|
||||
* @returns
|
||||
*/
|
||||
export declare function isZero(v: number): boolean;
|
||||
/**
|
||||
* 两浮点数是否相等
|
||||
* @param f1
|
||||
* @param f2
|
||||
* @returns
|
||||
*/
|
||||
export declare function floatEquals(f1: number, f2: number): boolean;
|
91
lib/math/Vector2.d.ts
vendored
91
lib/math/Vector2.d.ts
vendored
@ -1,91 +0,0 @@
|
||||
export declare class Vector2 {
|
||||
constructor(values?: [number, number]);
|
||||
static from(p: {
|
||||
x: number;
|
||||
y: number;
|
||||
}): Vector2;
|
||||
private values;
|
||||
static readonly zero: Vector2;
|
||||
static readonly one: Vector2;
|
||||
get x(): number;
|
||||
set x(value: number);
|
||||
get y(): number;
|
||||
set y(value: number);
|
||||
get xy(): [number, number];
|
||||
set xy(values: [number, number]);
|
||||
at(index: number): number;
|
||||
reset(): void;
|
||||
copy(dest?: Vector2): Vector2;
|
||||
negate(dest?: Vector2): Vector2;
|
||||
equals(vector: Vector2, threshold?: number): boolean;
|
||||
length(): number;
|
||||
squaredLength(): number;
|
||||
add(vector: Vector2): Vector2;
|
||||
subtract(vector: Vector2): Vector2;
|
||||
multiply(vector: Vector2): Vector2;
|
||||
divide(vector: Vector2): Vector2;
|
||||
scale(value: number, dest?: Vector2): Vector2;
|
||||
normalize(dest?: Vector2): Vector2;
|
||||
/**
|
||||
* 向量点乘
|
||||
* @param vector
|
||||
* @param vector2
|
||||
* @returns
|
||||
*/
|
||||
static dot(vector: Vector2, vector2: Vector2): number;
|
||||
/**
|
||||
* 向量长度
|
||||
* @param vector
|
||||
* @param vector2
|
||||
* @returns
|
||||
*/
|
||||
static distance(vector: Vector2, vector2: Vector2): number;
|
||||
/**
|
||||
* 向量长度平方
|
||||
* @param vector
|
||||
* @param vector2
|
||||
* @returns
|
||||
*/
|
||||
static squaredDistance(vector: Vector2, vector2: Vector2): number;
|
||||
/**
|
||||
* v2->v1的方向的单位向量
|
||||
* @param v1
|
||||
* @param v2
|
||||
* @param dest
|
||||
* @returns
|
||||
*/
|
||||
static direction(v1: Vector2, v2: Vector2, dest?: Vector2): Vector2;
|
||||
static mix(vector: Vector2, vector2: Vector2, time: number, dest?: Vector2): Vector2;
|
||||
/**
|
||||
* 向量加法
|
||||
* @param vector
|
||||
* @param vector2
|
||||
* @param dest
|
||||
* @returns
|
||||
*/
|
||||
static sum(vector: Vector2, vector2: Vector2, dest?: Vector2): Vector2;
|
||||
/**
|
||||
* 向量减法
|
||||
* @param vector
|
||||
* @param vector2
|
||||
* @param dest
|
||||
* @returns
|
||||
*/
|
||||
static difference(vector: Vector2, vector2: Vector2, dest?: Vector2): Vector2;
|
||||
/**
|
||||
* 向量乘法
|
||||
* @param vector
|
||||
* @param vector2
|
||||
* @param dest
|
||||
* @returns
|
||||
*/
|
||||
static product(vector: Vector2, vector2: Vector2, dest?: Vector2): Vector2;
|
||||
/**
|
||||
* 向量除法
|
||||
* @param vector
|
||||
* @param vector2
|
||||
* @param dest
|
||||
* @returns
|
||||
*/
|
||||
static quotient(vector: Vector2, vector2: Vector2, dest?: Vector2): Vector2;
|
||||
}
|
2
lib/math/index.d.ts
vendored
2
lib/math/index.d.ts
vendored
@ -1,2 +0,0 @@
|
||||
export * from './Constants';
|
||||
export * from './Vector2';
|
54
lib/message/BasicMessageClient.d.ts
vendored
54
lib/message/BasicMessageClient.d.ts
vendored
@ -1,54 +0,0 @@
|
||||
import EventEmitter from 'eventemitter3';
|
||||
import { IGraphicScene } from '../app';
|
||||
import { CompleteMessageCliOption, IMessageClient } from './MessageBroker';
|
||||
export interface MessageClientEvents {
|
||||
connected: [ctx: any];
|
||||
disconnected: [ctx: any];
|
||||
error: [err: any];
|
||||
}
|
||||
export type HandleMessage = (data: any) => void;
|
||||
export interface IMessageHandler {
|
||||
/**
|
||||
* id
|
||||
*/
|
||||
get App(): IGraphicScene;
|
||||
/**
|
||||
* 处理消息数据
|
||||
* @param data
|
||||
*/
|
||||
handle(data: any): void;
|
||||
}
|
||||
export declare abstract class MessageClient extends EventEmitter<MessageClientEvents> implements IMessageClient {
|
||||
options: CompleteMessageCliOption;
|
||||
subClients: SubscriptionClient[];
|
||||
constructor(options: CompleteMessageCliOption);
|
||||
/**
|
||||
* 订阅消息
|
||||
* @param destination
|
||||
* @param handle
|
||||
*/
|
||||
abstract subscribe(destination: string, handle: HandleMessage): boolean;
|
||||
unsubscribe(destination: string): void;
|
||||
abstract unsubscribe0(destination: string): void;
|
||||
getOrNewSubClient(destination: string): SubscriptionClient;
|
||||
addSubscription(destination: string, handler: IMessageHandler): void;
|
||||
removeSubscription(destination: string, handle: IMessageHandler): void;
|
||||
publishMessage(destination: string, message: Uint8Array): void;
|
||||
abstract get connected(): boolean;
|
||||
abstract close(): void;
|
||||
}
|
||||
export declare class SubscriptionClient {
|
||||
mc: MessageClient;
|
||||
destination: string;
|
||||
protocol: 'json' | 'protobuf';
|
||||
handlers: IMessageHandler[];
|
||||
subscripted: boolean;
|
||||
constructor(mc: MessageClient, destination: string, protocal: 'json' | 'protobuf');
|
||||
addHandler(handler: IMessageHandler): void;
|
||||
removeHandler(handler: IMessageHandler): void;
|
||||
trySubscribe(): void;
|
||||
unsubscribe(): void;
|
||||
publishMessage(destination: string, message: Uint8Array): void;
|
||||
handleMessage(data: any): void;
|
||||
onDisconnect(): void;
|
||||
}
|
154
lib/message/MessageBroker.d.ts
vendored
154
lib/message/MessageBroker.d.ts
vendored
@ -1,154 +0,0 @@
|
||||
import EventEmitter from 'eventemitter3';
|
||||
import { IGraphicScene } from '../app';
|
||||
import { GraphicQueryStore, GraphicState, JlGraphic } from '../core';
|
||||
import { IMessageHandler, MessageClientEvents } from './BasicMessageClient';
|
||||
export declare enum ClientEngine {
|
||||
Stomp = 0,
|
||||
MQTT = 1
|
||||
}
|
||||
export interface MessageCliOption {
|
||||
/**
|
||||
* 客户端引擎
|
||||
*/
|
||||
engine?: ClientEngine;
|
||||
/**
|
||||
* 消息协议,默认protobuf
|
||||
*/
|
||||
protocol?: 'json' | 'protobuf';
|
||||
/**
|
||||
* websocket url地址
|
||||
*/
|
||||
wsUrl: string;
|
||||
/**
|
||||
* 认证token
|
||||
*/
|
||||
token?: string;
|
||||
/**
|
||||
* 项目名称(可用于订阅客户端识别)
|
||||
*/
|
||||
clientName?: string;
|
||||
/**
|
||||
* 连接超时,默认30秒,ms
|
||||
*/
|
||||
connectTimeout?: number;
|
||||
/**
|
||||
* 心跳发送间隔,默认60秒,s
|
||||
*/
|
||||
heartbeat?: number;
|
||||
/**
|
||||
* 重试间隔,默认2秒,ms
|
||||
*/
|
||||
retryPeriod?: number;
|
||||
/**
|
||||
* 重试次数,默认100次
|
||||
*/
|
||||
retryTimes?: number;
|
||||
}
|
||||
export interface CompleteMessageCliOption extends MessageCliOption {
|
||||
protocol: 'json' | 'protobuf';
|
||||
connectTimeout: number;
|
||||
heartbeat: number;
|
||||
retryPeriod: number;
|
||||
retryTimes: number;
|
||||
}
|
||||
export interface IMessageClient extends EventEmitter<MessageClientEvents> {
|
||||
/**
|
||||
* 添加订阅
|
||||
* @param destination
|
||||
* @param handler
|
||||
*/
|
||||
addSubscription(destination: string, handler: IMessageHandler): void;
|
||||
/**
|
||||
* 移除订阅
|
||||
* @param destination
|
||||
* @param handler
|
||||
*/
|
||||
removeSubscription(destination: string, handler: IMessageHandler): void;
|
||||
/**
|
||||
* 发布消息
|
||||
* @param destination
|
||||
* @param message
|
||||
*/
|
||||
publishMessage(destination: string, message: Uint8Array): void;
|
||||
/**
|
||||
* 是否已经连接
|
||||
*/
|
||||
get connected(): boolean;
|
||||
/**
|
||||
* 关闭连接
|
||||
*/
|
||||
close(): void;
|
||||
}
|
||||
export declare class WsMsgCli {
|
||||
private static client;
|
||||
private static options;
|
||||
private static appMsgBroker;
|
||||
static new(options: MessageCliOption): void;
|
||||
static isInitiated(): boolean;
|
||||
static emitConnectStateChangeEvent(connected: boolean): void;
|
||||
static isConnected(): boolean;
|
||||
static registerSubscription(destination: string, handler: IMessageHandler): void;
|
||||
static unregisterSubscription(destination: string, handler: IMessageHandler): void;
|
||||
static registerAppMsgBroker(broker: AppWsMsgBroker): void;
|
||||
static publishMessage(destination: string, message: Uint8Array): void;
|
||||
static removeAppMsgBroker(broker: AppWsMsgBroker): void;
|
||||
static hasAppMsgBroker(): boolean;
|
||||
/**
|
||||
* 关闭websocket连接
|
||||
*/
|
||||
static close(): void;
|
||||
}
|
||||
export type GraphicStateMessageConvert = (message: Uint8Array) => GraphicState[];
|
||||
export type GraphicQuery = (state: GraphicState, store: GraphicQueryStore) => JlGraphic | undefined;
|
||||
export type SubscriptionMessageHandle = (message: Uint8Array) => void;
|
||||
export interface ICreateOnNotFound {
|
||||
graphicTypes?: string[];
|
||||
}
|
||||
export interface AppStateSubscription {
|
||||
/**
|
||||
* 订阅路径
|
||||
*/
|
||||
destination: string;
|
||||
/**
|
||||
* 图形状态消息转换
|
||||
*/
|
||||
messageConverter?: GraphicStateMessageConvert;
|
||||
/**
|
||||
* 根据状态查询图形对象,默认为根据code和type查询图形对象
|
||||
*/
|
||||
graphicQueryer?: GraphicQuery;
|
||||
/**
|
||||
* 当未根据状态找到图形对象时是否创建新对象
|
||||
* 值为设备类型列表
|
||||
*/
|
||||
createOnNotFound?: ICreateOnNotFound;
|
||||
/**
|
||||
* 订阅消息处理
|
||||
*/
|
||||
messageHandle?: SubscriptionMessageHandle;
|
||||
}
|
||||
declare class AppMessageHandler implements IMessageHandler {
|
||||
app: IGraphicScene;
|
||||
sub: AppStateSubscription;
|
||||
constructor(app: IGraphicScene, subOptions: AppStateSubscription);
|
||||
get App(): IGraphicScene;
|
||||
handle(data: any): void;
|
||||
}
|
||||
/**
|
||||
* 图形APP的websocket消息代理
|
||||
*/
|
||||
export declare class AppWsMsgBroker {
|
||||
app: IGraphicScene;
|
||||
subscriptions: Map<string, AppMessageHandler>;
|
||||
constructor(app: IGraphicScene);
|
||||
subscribe(sub: AppStateSubscription): void;
|
||||
unsbuscribe(destination: string): void;
|
||||
unsubscribeAll(): void;
|
||||
resubscribeAll(): void;
|
||||
publishMessage(destination: string, message: Uint8Array): void;
|
||||
/**
|
||||
* 取消所有订阅,从通用Stomp客户端移除此消息代理
|
||||
*/
|
||||
close(): void;
|
||||
}
|
||||
export {};
|
14
lib/message/MqttBroker.d.ts
vendored
14
lib/message/MqttBroker.d.ts
vendored
@ -1,14 +0,0 @@
|
||||
import mqtt from 'mqtt';
|
||||
import { HandleMessage, MessageClient } from './BasicMessageClient';
|
||||
import { CompleteMessageCliOption } from './MessageBroker';
|
||||
export declare class MqttMsgClient extends MessageClient {
|
||||
cli: mqtt.MqttClient;
|
||||
retryTimes: number;
|
||||
subMsgHandler: Map<string, HandleMessage>;
|
||||
constructor(options: CompleteMessageCliOption);
|
||||
subscribe(destination: string, handle: HandleMessage): boolean;
|
||||
unsubscribe0(destination: string): void;
|
||||
get connected(): boolean;
|
||||
close(): void;
|
||||
publishMessage(destination: string, message: Uint8Array): void;
|
||||
}
|
12
lib/message/WsMsgBroker.d.ts
vendored
12
lib/message/WsMsgBroker.d.ts
vendored
@ -1,12 +0,0 @@
|
||||
import { Client as StompClient } from '@stomp/stompjs';
|
||||
import { HandleMessage, MessageClient } from './BasicMessageClient';
|
||||
import { CompleteMessageCliOption } from './MessageBroker';
|
||||
export declare class StompMessagingClient extends MessageClient {
|
||||
cli: StompClient;
|
||||
constructor(options: CompleteMessageCliOption);
|
||||
get connected(): boolean;
|
||||
subscribe(destination: string, handle: HandleMessage): boolean;
|
||||
unsubscribe0(destination: string): void;
|
||||
publishMessage(destination: string, message: Uint8Array): void;
|
||||
close(): void;
|
||||
}
|
4
lib/message/index.d.ts
vendored
4
lib/message/index.d.ts
vendored
@ -1,4 +0,0 @@
|
||||
export * from './MessageBroker';
|
||||
export * from './MqttBroker';
|
||||
export * from './WsMsgBroker';
|
||||
export * from './BasicMessageClient';
|
42
lib/operation/JlOperation.d.ts
vendored
42
lib/operation/JlOperation.d.ts
vendored
@ -1,42 +0,0 @@
|
||||
import { IGraphicApp } from '../app/JlGraphicApp';
|
||||
import { JlGraphic } from '../core/JlGraphic';
|
||||
/**
|
||||
* 操作
|
||||
*/
|
||||
export declare abstract class JlOperation {
|
||||
type: string;
|
||||
app: IGraphicApp;
|
||||
obj?: any;
|
||||
data?: any;
|
||||
description?: string;
|
||||
constructor(app: IGraphicApp, type: string);
|
||||
undo1(): void;
|
||||
redo1(): void;
|
||||
abstract undo(): JlGraphic[] | void;
|
||||
abstract redo(): JlGraphic[] | void;
|
||||
}
|
||||
/**
|
||||
* 操作记录
|
||||
*/
|
||||
export declare class OperationRecord {
|
||||
undoStack: JlOperation[];
|
||||
redoStack: JlOperation[];
|
||||
private maxLen;
|
||||
constructor(maxLen?: number);
|
||||
get hasUndo(): boolean;
|
||||
get hasRedo(): boolean;
|
||||
setMaxLen(v: number): void;
|
||||
/**
|
||||
* 记录
|
||||
* @param op
|
||||
*/
|
||||
record(op: JlOperation): void;
|
||||
/**
|
||||
* 撤销
|
||||
*/
|
||||
undo(): void;
|
||||
/**
|
||||
* 重做
|
||||
*/
|
||||
redo(): void;
|
||||
}
|
1
lib/operation/index.d.ts
vendored
1
lib/operation/index.d.ts
vendored
@ -1 +0,0 @@
|
||||
export * from './JlOperation';
|
48
lib/plugins/AnimationManager.d.ts
vendored
48
lib/plugins/AnimationManager.d.ts
vendored
@ -1,48 +0,0 @@
|
||||
import { IGraphicScene } from '../app';
|
||||
import { GraphicAnimation, JlGraphic } from '../core';
|
||||
/**
|
||||
* 图形动画管理
|
||||
*/
|
||||
export declare class AnimationManager {
|
||||
app: IGraphicScene;
|
||||
_pause: boolean;
|
||||
/**
|
||||
* key - graphic.id
|
||||
*/
|
||||
graphicAnimationMap: Map<number, Map<string, GraphicAnimation>>;
|
||||
constructor(app: IGraphicScene);
|
||||
private run;
|
||||
pause(): void;
|
||||
resume(): void;
|
||||
destroy(): void;
|
||||
/**
|
||||
* 图形对象的所有动画map
|
||||
* @param graphic
|
||||
* @returns
|
||||
*/
|
||||
animationMap(graphic: JlGraphic): Map<string, GraphicAnimation>;
|
||||
/**
|
||||
* 注册图形动画
|
||||
* @param graphic
|
||||
* @param animation
|
||||
*/
|
||||
registerAnimation(graphic: JlGraphic, animation: GraphicAnimation): void;
|
||||
/**
|
||||
* 删除图形动画
|
||||
* @param graphic
|
||||
* @param name
|
||||
*/
|
||||
unregisterAnimation(graphic: JlGraphic, name: string): void;
|
||||
/**
|
||||
* 删除所有图形动画
|
||||
* @param graphic
|
||||
*/
|
||||
unregisterGraphicAnimations(graphic: JlGraphic): void;
|
||||
/**
|
||||
* 获取图形指定名称动画
|
||||
* @param graphic
|
||||
* @param name
|
||||
* @returns
|
||||
*/
|
||||
animation(graphic: JlGraphic, name: string): GraphicAnimation | undefined;
|
||||
}
|
82
lib/plugins/CommonMousePlugin.d.ts
vendored
82
lib/plugins/CommonMousePlugin.d.ts
vendored
@ -1,82 +0,0 @@
|
||||
import { DisplayObject, FederatedMouseEvent, Graphics, Point } from 'pixi.js';
|
||||
import { IGraphicScene } from '../app';
|
||||
import { JlGraphic } from '../core';
|
||||
import { AppDragEvent, AppInteractionPlugin } from './InteractionPlugin';
|
||||
type GraphicSelectFilter = (graphic: JlGraphic) => boolean;
|
||||
export interface IMouseToolOptions {
|
||||
/**
|
||||
* 是否启用框选,默认启用
|
||||
*/
|
||||
boxSelect?: boolean;
|
||||
/**
|
||||
* 是否启用视口拖拽(默认右键),默认启用
|
||||
*/
|
||||
viewportDrag?: boolean;
|
||||
/**
|
||||
* 是否启用左键视口拖拽
|
||||
*/
|
||||
viewportDragLeft?: boolean;
|
||||
/**
|
||||
* 是否启用鼠标滚轮缩放,默认启用
|
||||
*/
|
||||
wheelZoom?: boolean;
|
||||
/**
|
||||
* 可选择图形过滤器
|
||||
*/
|
||||
selectFilter?: GraphicSelectFilter;
|
||||
}
|
||||
declare class CompleteMouseToolOptions implements IMouseToolOptions {
|
||||
boxSelect: boolean;
|
||||
viewportDrag: boolean;
|
||||
viewportDragLeft: boolean;
|
||||
wheelZoom: boolean;
|
||||
selectFilter?: GraphicSelectFilter | undefined;
|
||||
constructor();
|
||||
update(options: IMouseToolOptions): void;
|
||||
}
|
||||
/**
|
||||
* 通用交互工具
|
||||
*/
|
||||
export declare class CommonMouseTool extends AppInteractionPlugin {
|
||||
static Name: string;
|
||||
static SelectBox: string;
|
||||
options: CompleteMouseToolOptions;
|
||||
box: Graphics;
|
||||
leftDownTarget: DisplayObject | null;
|
||||
drag: boolean;
|
||||
graphicSelect: boolean;
|
||||
rightTarget: DisplayObject | null;
|
||||
constructor(scene: IGraphicScene);
|
||||
static new(app: IGraphicScene): CommonMouseTool;
|
||||
bind(): void;
|
||||
unbind(): void;
|
||||
onDragStart(event: AppDragEvent): void;
|
||||
onDragMove(event: AppDragEvent): void;
|
||||
onDragEnd(event: AppDragEvent): void;
|
||||
setLeftCursor(e: FederatedMouseEvent): void;
|
||||
resumeLeftCursor(): void;
|
||||
setCursor(e: FederatedMouseEvent): void;
|
||||
resumeCursor(): void;
|
||||
onMouseDown(e: FederatedMouseEvent): void;
|
||||
/**
|
||||
* 选中处理
|
||||
* @param e
|
||||
*/
|
||||
onMouseUp(e: FederatedMouseEvent): void;
|
||||
/**
|
||||
* 清理缓存
|
||||
*/
|
||||
clearCache(): void;
|
||||
get boxSelect(): boolean | undefined;
|
||||
get selectFilter(): GraphicSelectFilter | undefined;
|
||||
/**
|
||||
* 框选图形绘制并检查
|
||||
*/
|
||||
boxSelectDraw(start: Point, end: Point): void;
|
||||
/**
|
||||
* 框选图形判断
|
||||
* @returns
|
||||
*/
|
||||
boxSelectGraphicCheck(): void;
|
||||
}
|
||||
export {};
|
35
lib/plugins/CopyPlugin.d.ts
vendored
35
lib/plugins/CopyPlugin.d.ts
vendored
@ -1,35 +0,0 @@
|
||||
import { Container, FederatedPointerEvent, Point } from 'pixi.js';
|
||||
import { IGraphicScene } from '../app';
|
||||
import { JlGraphic } from '../core';
|
||||
import { KeyListener } from './KeyboardPlugin';
|
||||
interface GraphicControler {
|
||||
controlerList: KeyListener[];
|
||||
check: () => boolean;
|
||||
moveLimitOption?: {
|
||||
moveLimitName: string;
|
||||
moveLimit: (e: FederatedPointerEvent) => void;
|
||||
};
|
||||
}
|
||||
/**
|
||||
* 图形复制插件
|
||||
*/
|
||||
export declare class GraphicCopyPlugin {
|
||||
container: Container;
|
||||
scene: IGraphicScene;
|
||||
keyListeners: KeyListener[];
|
||||
graphicControlers: GraphicControler[];
|
||||
copys: JlGraphic[];
|
||||
start?: Point;
|
||||
running: boolean;
|
||||
moveLimit?: string;
|
||||
constructor(scene: IGraphicScene);
|
||||
updateMoveLimit(limit?: string): void;
|
||||
init(): void;
|
||||
addGraphicControlers(graphicControlers: GraphicControler[]): void;
|
||||
clear(): void;
|
||||
onPointerMove(e: FederatedPointerEvent): void;
|
||||
onFinish(): void;
|
||||
saveCopyGraphic(): void;
|
||||
cancle(): void;
|
||||
}
|
||||
export {};
|
82
lib/plugins/GraphicEditPlugin.d.ts
vendored
82
lib/plugins/GraphicEditPlugin.d.ts
vendored
@ -1,82 +0,0 @@
|
||||
import { Container, DisplayObject, Graphics, IDestroyOptions, IPointData } from 'pixi.js';
|
||||
import { JlGraphic } from '../core';
|
||||
import { DraggablePoint } from '../graphic';
|
||||
export declare abstract class GraphicEditPlugin<DO extends DisplayObject = DisplayObject> extends Container {
|
||||
graphic: DO;
|
||||
constructor(g: DO);
|
||||
destroy(options?: boolean | IDestroyOptions | undefined): void;
|
||||
abstract updateEditedPointsPosition(): void;
|
||||
hideAll(): void;
|
||||
showAll(): void;
|
||||
}
|
||||
export interface ILineGraphic extends JlGraphic {
|
||||
get linePoints(): IPointData[];
|
||||
set linePoints(points: IPointData[]);
|
||||
}
|
||||
export declare abstract class LineEditPlugin extends GraphicEditPlugin<ILineGraphic> {
|
||||
linePoints: IPointData[];
|
||||
editedPoints: DraggablePoint[];
|
||||
constructor(g: ILineGraphic);
|
||||
destroy(options?: boolean | IDestroyOptions | undefined): void;
|
||||
reset(): void;
|
||||
abstract initEditPoints(): void;
|
||||
}
|
||||
export declare function getWayLineIndex(points: IPointData[], p: IPointData): {
|
||||
start: number;
|
||||
end: number;
|
||||
};
|
||||
export declare function getWaypointRangeIndex(points: IPointData[], curve: boolean, p: IPointData, lineWidth: number): {
|
||||
start: number;
|
||||
end: number;
|
||||
};
|
||||
export type onEditPointCreate = (g: ILineGraphic, dp: DraggablePoint, index: number) => void;
|
||||
export interface IEditPointOptions {
|
||||
/**
|
||||
* 编辑点创建处理
|
||||
*/
|
||||
onEditPointCreate?: onEditPointCreate;
|
||||
}
|
||||
/**
|
||||
* 折线编辑(兼容线段)
|
||||
*/
|
||||
export declare class PolylineEditPlugin extends LineEditPlugin {
|
||||
static Name: string;
|
||||
options: IEditPointOptions;
|
||||
constructor(g: ILineGraphic, options?: IEditPointOptions);
|
||||
initEditPoints(): void;
|
||||
updateEditedPointsPosition(): void;
|
||||
}
|
||||
export interface BezierCurveEditPointOptions extends IEditPointOptions {
|
||||
auxiliaryLineColor?: string;
|
||||
smooth?: boolean;
|
||||
symmetry?: boolean;
|
||||
}
|
||||
export interface ICompleteBezierCurveEditPointOptions extends BezierCurveEditPointOptions {
|
||||
smooth: boolean;
|
||||
}
|
||||
export declare function addWayPoint(graphic: ILineGraphic, curve: boolean, start: number, end: number, p: IPointData): void;
|
||||
export declare function addLineWayPoint(graphic: ILineGraphic, start: number, end: number, p: IPointData): void;
|
||||
export declare function addPolygonSegmentingPoint(graphic: ILineGraphic, start: number, end: number, knife?: number): void;
|
||||
export declare function addBezierWayPoint(graphic: ILineGraphic, start: number, end: number, p: IPointData): void;
|
||||
export declare function removeWayPoint(graphic: ILineGraphic, curve: boolean, i: number): void;
|
||||
export declare function removeLineWayPoint(graphic: ILineGraphic, i: number): void;
|
||||
export declare function removeBezierWayPoint(graphic: ILineGraphic, i: number): void;
|
||||
/**
|
||||
* 清除路径点(只留端点),适用于直线和贝塞尔曲线
|
||||
* @param graphic
|
||||
* @param curve
|
||||
*/
|
||||
export declare function clearWayPoint(graphic: ILineGraphic, curve: boolean): void;
|
||||
/**
|
||||
* 贝塞尔曲线编辑
|
||||
*/
|
||||
export declare class BezierCurveEditPlugin extends LineEditPlugin {
|
||||
static Name: string;
|
||||
options: ICompleteBezierCurveEditPointOptions;
|
||||
auxiliaryLines: Graphics[];
|
||||
constructor(g: ILineGraphic, options?: BezierCurveEditPointOptions);
|
||||
reset(): void;
|
||||
initEditPoints(): void;
|
||||
drawAuxiliaryLine(line: Graphics, p1: IPointData, p2: IPointData): void;
|
||||
updateEditedPointsPosition(): void;
|
||||
}
|
207
lib/plugins/GraphicTransformPlugin.d.ts
vendored
207
lib/plugins/GraphicTransformPlugin.d.ts
vendored
@ -1,207 +0,0 @@
|
||||
import { Container, DisplayObject, Graphics, IDestroyOptions, Point } from 'pixi.js';
|
||||
import { AppDragEvent, InteractionPluginBase, KeyListener } from '.';
|
||||
import { IGraphicScene } from '../app';
|
||||
import { AbsorbablePosition, VectorText } from '../graphic';
|
||||
import { DraggablePoint } from '../graphic/DraggablePoint';
|
||||
import { DebouncedFunction } from '../utils';
|
||||
export declare class ShiftData {
|
||||
/**
|
||||
* 起始位置
|
||||
*/
|
||||
startPosition: Point;
|
||||
/**
|
||||
* 上一次终点位置
|
||||
*/
|
||||
lastPosition?: Point;
|
||||
/**
|
||||
* 当前位置
|
||||
*/
|
||||
currentPosition?: Point;
|
||||
constructor(startPosition: Point, currentPosition?: Point, lastPosition?: Point);
|
||||
static new(startPosition: Point, currentPosition?: Point, lastPosition?: Point): ShiftData;
|
||||
get dx(): number;
|
||||
get dy(): number;
|
||||
get dsx(): number;
|
||||
get dsy(): number;
|
||||
}
|
||||
export declare class ScaleData {
|
||||
start: Point;
|
||||
current?: Point;
|
||||
last?: Point;
|
||||
constructor(start: Point, current?: Point, last?: Point);
|
||||
static new(start: Point, current?: Point, last?: Point): ScaleData;
|
||||
}
|
||||
export type TransformData = ShiftData | null;
|
||||
/**
|
||||
* 图形平移事件
|
||||
*/
|
||||
export declare class GraphicTransformEvent {
|
||||
/**
|
||||
* 图形对象
|
||||
*/
|
||||
target: DisplayObject;
|
||||
type: 'shift' | 'rotate' | 'scale' | 'skew';
|
||||
data: TransformData;
|
||||
constructor(target: DisplayObject, type: 'shift' | 'rotate' | 'scale' | 'skew', data: TransformData);
|
||||
getData<D extends TransformData>(): D;
|
||||
static shift(target: DisplayObject, data: ShiftData): GraphicTransformEvent;
|
||||
static scale(target: DisplayObject): GraphicTransformEvent;
|
||||
static rotate(target: DisplayObject): GraphicTransformEvent;
|
||||
static skew(target: DisplayObject): GraphicTransformEvent;
|
||||
isShift(): boolean;
|
||||
isRotate(): boolean;
|
||||
isScale(): boolean;
|
||||
isSkew(): boolean;
|
||||
}
|
||||
export declare class GraphicTransformPlugin extends InteractionPluginBase {
|
||||
static Name: string;
|
||||
/**
|
||||
* 可吸附位置列表
|
||||
*/
|
||||
absorbablePositions?: AbsorbablePosition[];
|
||||
apContainer: Container;
|
||||
static AbsorbablePosisiontsName: string;
|
||||
constructor(app: IGraphicScene);
|
||||
/**
|
||||
* 过滤重复的吸附位置
|
||||
* @param positions
|
||||
* @returns
|
||||
*/
|
||||
filterAbsorbablePositions(positions: AbsorbablePosition[]): AbsorbablePosition[];
|
||||
static new(app: IGraphicScene): GraphicTransformPlugin;
|
||||
bind(): void;
|
||||
unbind(): void;
|
||||
getDraggedTargets(e: AppDragEvent): DisplayObject[];
|
||||
onDragStart(e: AppDragEvent): void;
|
||||
onDragMove(e: AppDragEvent): void;
|
||||
onDragEnd(e: AppDragEvent): void;
|
||||
/**
|
||||
* 清理缓存
|
||||
*/
|
||||
clearCache(): void;
|
||||
onGraphicSelectedChange(g: DisplayObject, selected: boolean): void;
|
||||
}
|
||||
/**
|
||||
* 缩放、旋转辅助
|
||||
*/
|
||||
export declare class TransformPoints extends Container {
|
||||
static Name: string;
|
||||
static MinLength: number;
|
||||
static LeftTopName: string;
|
||||
static TopName: string;
|
||||
static RightTopName: string;
|
||||
static RightName: string;
|
||||
static RightBottomName: string;
|
||||
static BottomName: string;
|
||||
static LeftBottomName: string;
|
||||
static LeftName: string;
|
||||
static RotateName: string;
|
||||
obj: DisplayObject;
|
||||
ltScalePoint: DraggablePoint;
|
||||
ltLocal: Point;
|
||||
tScalePoint: DraggablePoint;
|
||||
tLocal: Point;
|
||||
tCanvas: Point;
|
||||
rtScalePoint: DraggablePoint;
|
||||
rtLocal: Point;
|
||||
rScalePoint: DraggablePoint;
|
||||
rLocal: Point;
|
||||
rbScalePoint: DraggablePoint;
|
||||
rbLocal: Point;
|
||||
bScalePoint: DraggablePoint;
|
||||
bLocal: Point;
|
||||
lbScalePoint: DraggablePoint;
|
||||
lbLocal: Point;
|
||||
lScalePoint: DraggablePoint;
|
||||
lLocal: Point;
|
||||
originScale: Point;
|
||||
scalePivot: Point;
|
||||
/**
|
||||
* 旋转拖拽点
|
||||
*/
|
||||
rotatePoint: DraggablePoint;
|
||||
/**
|
||||
* 旋转中心坐标
|
||||
*/
|
||||
rotatePivot: Point;
|
||||
/**
|
||||
* 起始旋转坐标
|
||||
*/
|
||||
rotateLastPoint: Point;
|
||||
/**
|
||||
* 起始图形角度
|
||||
*/
|
||||
startAngle: number;
|
||||
/**
|
||||
* 当前角度信息文本辅助
|
||||
*/
|
||||
angleAssistantText: VectorText;
|
||||
/**
|
||||
* 旋转角度步长
|
||||
*/
|
||||
angleStep: number;
|
||||
/**
|
||||
* 修改旋转步长键盘监听
|
||||
*/
|
||||
rotateAngleStepKeyListeners: KeyListener[];
|
||||
constructor(obj: DisplayObject);
|
||||
onObjTransformStart(): void;
|
||||
onObjTransformEnd(): void;
|
||||
onGraphicRepaint(): void;
|
||||
/**
|
||||
* 旋转开始
|
||||
* @param de
|
||||
*/
|
||||
onRotateStart(de: GraphicTransformEvent): void;
|
||||
updateAngleAssistantText(de: GraphicTransformEvent): void;
|
||||
/**
|
||||
* 旋转移动
|
||||
* @param de
|
||||
*/
|
||||
onRotateMove(de: GraphicTransformEvent): void;
|
||||
/**
|
||||
* 旋转结束
|
||||
* @param de
|
||||
*/
|
||||
onRotateEnd(): void;
|
||||
/**
|
||||
* 缩放开始
|
||||
*/
|
||||
onScaleDragStart(): void;
|
||||
onScaleDragMove(e: GraphicTransformEvent): void;
|
||||
onScaleDragEnd(): void;
|
||||
hideOthers(dg: DisplayObject): void;
|
||||
hideAll(): void;
|
||||
showAll(): void;
|
||||
getObjBounds(): {
|
||||
width: number;
|
||||
height: number;
|
||||
};
|
||||
/**
|
||||
* 更新位置和cursor
|
||||
* @returns
|
||||
*/
|
||||
update(): void;
|
||||
updateRotatePoint(): void;
|
||||
updateScalePoints(): void;
|
||||
}
|
||||
/**
|
||||
* 包围盒矩形图形,现使用外边框转画布多边形实现
|
||||
*/
|
||||
export declare class BoundsGraphic extends Graphics {
|
||||
static Name: string;
|
||||
static BoundsLineStyle: {
|
||||
width: number;
|
||||
color: string;
|
||||
alpha: number;
|
||||
};
|
||||
obj: DisplayObject;
|
||||
debouncedRedraw: DebouncedFunction<() => void>;
|
||||
constructor(graphic: DisplayObject);
|
||||
onObjTransformStart(): void;
|
||||
onObjTransformEnd(): void;
|
||||
onGraphicRepaint(): void;
|
||||
destroy(options?: boolean | IDestroyOptions | undefined): void;
|
||||
redraw(): void;
|
||||
doRedraw(): void;
|
||||
}
|
173
lib/plugins/InteractionPlugin.d.ts
vendored
173
lib/plugins/InteractionPlugin.d.ts
vendored
@ -1,173 +0,0 @@
|
||||
/// <reference types="node" />
|
||||
import { DisplayObject, FederatedMouseEvent, FederatedPointerEvent, Point } from 'pixi.js';
|
||||
import { IGraphicScene } from '../app/JlGraphicApp';
|
||||
import { JlGraphic } from '../core/JlGraphic';
|
||||
export declare enum InteractionPluginType {
|
||||
App = "app",
|
||||
Graphic = "graphic",
|
||||
Other = "other"
|
||||
}
|
||||
/**
|
||||
* 交互插件
|
||||
*/
|
||||
export interface InteractionPlugin {
|
||||
readonly _type: string;
|
||||
name: string;
|
||||
app: IGraphicScene;
|
||||
/**
|
||||
* 恢复
|
||||
*/
|
||||
resume(): void;
|
||||
/**
|
||||
* 停止
|
||||
*/
|
||||
pause(): void;
|
||||
/**
|
||||
* 是否生效
|
||||
*/
|
||||
isActive(): boolean;
|
||||
isAppPlugin(): boolean;
|
||||
isOtherPlugin(): boolean;
|
||||
isGraphicPlugin(): boolean;
|
||||
}
|
||||
export declare abstract class InteractionPluginBase implements InteractionPlugin {
|
||||
readonly _type: string;
|
||||
name: string;
|
||||
app: IGraphicScene;
|
||||
_pause: boolean;
|
||||
constructor(app: IGraphicScene, name: string, type: string);
|
||||
/**
|
||||
* 恢复
|
||||
*/
|
||||
resume(): void;
|
||||
/**
|
||||
* 停止
|
||||
*/
|
||||
pause(): void;
|
||||
abstract bind(): void;
|
||||
abstract unbind(): void;
|
||||
/**
|
||||
* 是否生效
|
||||
*/
|
||||
isActive(): boolean;
|
||||
isGraphicPlugin(): boolean;
|
||||
isAppPlugin(): boolean;
|
||||
isOtherPlugin(): boolean;
|
||||
}
|
||||
export declare abstract class OtherInteractionPlugin extends InteractionPluginBase {
|
||||
constructor(app: IGraphicScene, name: string);
|
||||
}
|
||||
export declare class AppDragEvent {
|
||||
app: IGraphicScene;
|
||||
type: 'start' | 'move' | 'end';
|
||||
target: DisplayObject;
|
||||
original: FederatedPointerEvent;
|
||||
start: Point;
|
||||
constructor(app: IGraphicScene, type: 'start' | 'move' | 'end', target: DisplayObject, original: FederatedPointerEvent, start: Point);
|
||||
get isMouse(): boolean;
|
||||
get isLeftButton(): boolean;
|
||||
get isRightButton(): boolean;
|
||||
get isMiddleButton(): boolean;
|
||||
get isTouch(): boolean;
|
||||
/**
|
||||
* 终点坐标(画布坐标)
|
||||
*/
|
||||
get end(): Point;
|
||||
get dx(): number;
|
||||
get dy(): number;
|
||||
get dsx(): number;
|
||||
get dsy(): number;
|
||||
/**
|
||||
* 转换为目标对象的位移距离
|
||||
*/
|
||||
toTargetShiftLen(target: DisplayObject): {
|
||||
dx: number;
|
||||
dy: number;
|
||||
};
|
||||
}
|
||||
/**
|
||||
* 拖拽操作插件
|
||||
*/
|
||||
export declare class DragPlugin extends OtherInteractionPlugin {
|
||||
static Name: string;
|
||||
private threshold;
|
||||
target: DisplayObject | null;
|
||||
start: Point | null;
|
||||
startClientPoint: Point | null;
|
||||
drag: boolean;
|
||||
constructor(app: IGraphicScene);
|
||||
static new(app: IGraphicScene): DragPlugin;
|
||||
bind(): void;
|
||||
unbind(): void;
|
||||
onPointerDown(e: FederatedPointerEvent): void;
|
||||
onPointerMove(e: FederatedPointerEvent): void;
|
||||
onPointerUp(e: FederatedPointerEvent): void;
|
||||
/**
|
||||
* 清理缓存
|
||||
*/
|
||||
clearCache(): void;
|
||||
}
|
||||
/**
|
||||
* 视口移动插件
|
||||
*/
|
||||
export declare class ViewportMovePlugin extends OtherInteractionPlugin {
|
||||
static Name: string;
|
||||
static MoveInterval: number;
|
||||
static TriggerRange: number;
|
||||
static DefaultMoveSpeed: number;
|
||||
moveHandler: NodeJS.Timeout | null;
|
||||
moveSpeedx: number;
|
||||
moveSpeedy: number;
|
||||
constructor(app: IGraphicScene);
|
||||
static new(app: IGraphicScene): ViewportMovePlugin;
|
||||
pause(): void;
|
||||
bind(): void;
|
||||
unbind(): void;
|
||||
startMove(moveSpeedx: number, moveSpeedy: number): void;
|
||||
stopMove(): void;
|
||||
private calculateBoundaryMoveSpeed;
|
||||
calculateMoveSpeed(dd: number): number;
|
||||
viewportMove(e: FederatedMouseEvent): void;
|
||||
}
|
||||
/**
|
||||
* 应用交互插件,同时只能生效一个
|
||||
*/
|
||||
export declare abstract class AppInteractionPlugin extends InteractionPluginBase {
|
||||
constructor(name: string, app: IGraphicScene);
|
||||
/**
|
||||
* 恢复,app交互插件同时只能生效一个
|
||||
*/
|
||||
resume(): void;
|
||||
}
|
||||
/**
|
||||
* 图形交互插件,可同时生效
|
||||
*/
|
||||
export declare abstract class GraphicInteractionPlugin<G extends JlGraphic> implements InteractionPlugin {
|
||||
readonly _type = InteractionPluginType.Graphic;
|
||||
app: IGraphicScene;
|
||||
name: string;
|
||||
_pause: boolean;
|
||||
constructor(name: string, app: IGraphicScene);
|
||||
isActive(): boolean;
|
||||
isAppPlugin(): boolean;
|
||||
isOtherPlugin(): boolean;
|
||||
isGraphicPlugin(): boolean;
|
||||
resume(): void;
|
||||
pause(): void;
|
||||
/**
|
||||
* 过滤需要的图形对象
|
||||
*/
|
||||
abstract filter(...grahpics: JlGraphic[]): G[] | undefined;
|
||||
binds(list?: G[]): void;
|
||||
unbinds(list?: G[]): void;
|
||||
/**
|
||||
* 绑定图形对象的交互处理
|
||||
* @param g 图形对象
|
||||
*/
|
||||
abstract bind(g: G): void;
|
||||
/**
|
||||
* 取消图形对象的交互处理
|
||||
* @param g 图形对象
|
||||
*/
|
||||
abstract unbind(g: G): void;
|
||||
}
|
81
lib/plugins/KeyboardPlugin.d.ts
vendored
81
lib/plugins/KeyboardPlugin.d.ts
vendored
@ -1,81 +0,0 @@
|
||||
import { IGraphicApp } from '../app/JlGraphicApp';
|
||||
export declare class GlobalKeyboardHelper {
|
||||
appKeyboardPluginMap: JlGraphicAppKeyboardPlugin[];
|
||||
constructor();
|
||||
registerGAKPlugin(plugin: JlGraphicAppKeyboardPlugin): void;
|
||||
removeGAKPlugin(plugin: JlGraphicAppKeyboardPlugin): void;
|
||||
}
|
||||
export declare class JlGraphicAppKeyboardPlugin {
|
||||
app: IGraphicApp;
|
||||
/**
|
||||
* 结构为Map<key.code|key.key|key.keyCode, Map<KeyListener.identifier, KeyListener>>
|
||||
*/
|
||||
keyListenerMap: Map<number | string, Map<string, KeyListener>>;
|
||||
keyListenerStackMap: Map<string, KeyListener[]>;
|
||||
constructor(app: IGraphicApp);
|
||||
private getOrInit;
|
||||
private getOrInitStack;
|
||||
/**
|
||||
* 注册按键监听,若有旧的,旧的入栈
|
||||
* @param keyListener
|
||||
*/
|
||||
addKeyListener(keyListener: KeyListener): void;
|
||||
/**
|
||||
* 移除按键监听,若是当前注册的监听,尝试从栈中取出作为按键监听器,若是旧的,则同时移除栈中的监听
|
||||
* @param keyListener
|
||||
*/
|
||||
removeKeyListener(keyListener: KeyListener): void;
|
||||
getKeyListenerBy(key: string | number): Map<string, KeyListener> | undefined;
|
||||
getKeyListener(e: KeyboardEvent): Map<string, KeyListener> | undefined;
|
||||
isKeyListened(key: string | number): boolean;
|
||||
/**
|
||||
* 获取所有注册监听的键值(组合键)
|
||||
*/
|
||||
getAllListenedKeys(): string[];
|
||||
}
|
||||
type KeyboardKeyHandler = (e: KeyboardEvent, app: IGraphicApp) => void;
|
||||
export declare enum CombinationKey {
|
||||
Ctrl = "Ctrl",
|
||||
Alt = "Alt",
|
||||
Shift = "Shift"
|
||||
}
|
||||
export interface KeyListenerOptions {
|
||||
value: string | number;
|
||||
combinations?: CombinationKey[];
|
||||
global?: boolean;
|
||||
onPress?: KeyboardKeyHandler;
|
||||
pressTriggerAsOriginalEvent?: boolean;
|
||||
onRelease?: KeyboardKeyHandler;
|
||||
}
|
||||
export interface ICompleteKeyListenerOptions {
|
||||
value: string | number;
|
||||
combinations: CombinationKey[];
|
||||
global: boolean;
|
||||
onPress?: KeyboardKeyHandler;
|
||||
pressTriggerAsOriginalEvent: boolean;
|
||||
onRelease?: KeyboardKeyHandler;
|
||||
}
|
||||
export declare class KeyListener {
|
||||
readonly options: ICompleteKeyListenerOptions;
|
||||
private isPress;
|
||||
constructor(options: KeyListenerOptions);
|
||||
static create(options: KeyListenerOptions): KeyListener;
|
||||
get value(): string | number;
|
||||
get combinations(): string[];
|
||||
get identifier(): string;
|
||||
get global(): boolean | undefined;
|
||||
get onPress(): KeyboardKeyHandler | undefined;
|
||||
set onPress(v: KeyboardKeyHandler | undefined);
|
||||
get onRelease(): KeyboardKeyHandler | undefined;
|
||||
set onRelease(v: KeyboardKeyHandler | undefined);
|
||||
get pressTriggerEveryTime(): boolean;
|
||||
set pressTriggerEveryTime(v: boolean);
|
||||
press(e: KeyboardEvent, app: IGraphicApp): void;
|
||||
/**
|
||||
* 检查组合键是否匹配
|
||||
*/
|
||||
checkCombinations(e: KeyboardEvent): boolean;
|
||||
release(e: KeyboardEvent, app: IGraphicApp): void;
|
||||
onRemove(): void;
|
||||
}
|
||||
export {};
|
7
lib/plugins/index.d.ts
vendored
7
lib/plugins/index.d.ts
vendored
@ -1,7 +0,0 @@
|
||||
export * from './AnimationManager';
|
||||
export * from './CommonMousePlugin';
|
||||
export * from './CopyPlugin';
|
||||
export * from './GraphicEditPlugin';
|
||||
export * from './GraphicTransformPlugin';
|
||||
export * from './InteractionPlugin';
|
||||
export * from './KeyboardPlugin';
|
164
lib/ui/ContextMenu.d.ts
vendored
164
lib/ui/ContextMenu.d.ts
vendored
@ -1,164 +0,0 @@
|
||||
/// <reference types="node" />
|
||||
import { Container, Graphics, Point, Rectangle, Text } from 'pixi.js';
|
||||
import { IGraphicScene } from '../app';
|
||||
import { OutOfBound } from '../utils';
|
||||
import { MenuCompletionItemStyle, MenuCompletionOptions, MenuCompletionStyleOptions, MenuGroupOptions, MenuItemOptions, MenuOptions } from './Menu';
|
||||
export declare class ContextMenuPlugin {
|
||||
app: IGraphicScene;
|
||||
contextMenuMap: Map<string, ContextMenu>;
|
||||
constructor(app: IGraphicScene);
|
||||
registerMenu(menu: ContextMenu): void;
|
||||
/**
|
||||
* 获取视口屏幕宽度
|
||||
*/
|
||||
get screenWidth(): number;
|
||||
/**
|
||||
* 获取视口屏幕高度
|
||||
*/
|
||||
get screenHeight(): number;
|
||||
/**
|
||||
* 打开菜单
|
||||
* @param menu
|
||||
* @param global
|
||||
*/
|
||||
open(menu: ContextMenu, global: Point): void;
|
||||
/**
|
||||
* 关闭菜单
|
||||
* @param menu
|
||||
*/
|
||||
close(menu: ContextMenu): void;
|
||||
/**
|
||||
* 关闭所有菜单
|
||||
*/
|
||||
closeAll(): void;
|
||||
/**
|
||||
* 越界检查
|
||||
* @param menu
|
||||
* @param global
|
||||
* @returns
|
||||
*/
|
||||
oob(menu: ContextMenu, global: Point): OutOfBound;
|
||||
}
|
||||
/**
|
||||
* 上下文菜单,多级嵌套
|
||||
*/
|
||||
export declare class ContextMenu extends Container {
|
||||
_plugin?: ContextMenuPlugin;
|
||||
parentMenuItem?: ContextMenuItem;
|
||||
openedSubMenu?: ContextMenu;
|
||||
menuOptions: MenuCompletionOptions;
|
||||
opened: boolean;
|
||||
bg: Graphics;
|
||||
title?: Text;
|
||||
groups: MenuGroup[];
|
||||
private padding;
|
||||
_active: boolean;
|
||||
timeoutCloseHandle?: NodeJS.Timeout;
|
||||
constructor(menuOptions: MenuOptions, parentMenuItem?: ContextMenuItem);
|
||||
static init(options: MenuOptions): ContextMenu;
|
||||
get style(): MenuCompletionStyleOptions;
|
||||
/**
|
||||
* 父级菜单
|
||||
*/
|
||||
get parentMenu(): ContextMenu | undefined;
|
||||
/**
|
||||
* 最顶级菜单
|
||||
*/
|
||||
get rootMenu(): ContextMenu;
|
||||
/**
|
||||
* 是否存在激活的菜单项
|
||||
* @returns
|
||||
*/
|
||||
hasActiveItem(): boolean;
|
||||
get active(): boolean;
|
||||
set active(v: boolean);
|
||||
onActiveChanged(): void;
|
||||
setOptions(menuOptions: MenuOptions): void;
|
||||
/**
|
||||
* 初始化
|
||||
*/
|
||||
init(): void;
|
||||
initGroups(): void;
|
||||
initTitle(): void;
|
||||
private calculateBorderInfo;
|
||||
updateBg(): void;
|
||||
update(): void;
|
||||
get menuName(): string;
|
||||
get plugin(): ContextMenuPlugin;
|
||||
set plugin(v: ContextMenuPlugin);
|
||||
/**
|
||||
* 显示菜单
|
||||
*/
|
||||
open(global: Point): void;
|
||||
/**
|
||||
* 关闭菜单
|
||||
*/
|
||||
close(): void;
|
||||
/**
|
||||
* 打开子菜单
|
||||
* @param subMenu
|
||||
* @param global
|
||||
*/
|
||||
private openSub;
|
||||
}
|
||||
declare class MenuGroup extends Container {
|
||||
private gutter;
|
||||
config: MenuGroupOptions;
|
||||
menu: ContextMenu;
|
||||
items: ContextMenuItem[];
|
||||
constructor(menu: ContextMenu, config: MenuGroupOptions);
|
||||
private init;
|
||||
hasActiveItem(): boolean;
|
||||
get maxItemNameWidth(): number;
|
||||
get maxShortcutWidth(): number;
|
||||
get totalGutter(): number;
|
||||
get totalHeight(): number;
|
||||
update(): void;
|
||||
updateItemBox(maxItemWidth: number): void;
|
||||
}
|
||||
/**
|
||||
* 菜单项
|
||||
*/
|
||||
declare class ContextMenuItem extends Container {
|
||||
menu: ContextMenu;
|
||||
config: MenuItemOptions;
|
||||
/**
|
||||
* 名称文本
|
||||
*/
|
||||
nameText: Text;
|
||||
/**
|
||||
* 快捷键文本
|
||||
*/
|
||||
shortcutKeyText?: Text;
|
||||
private gutter;
|
||||
arrowText?: Text;
|
||||
box: Graphics;
|
||||
subMenu?: ContextMenu;
|
||||
_active: boolean;
|
||||
constructor(menu: ContextMenu, config: MenuItemOptions);
|
||||
registerEventHandler(): void;
|
||||
get active(): boolean;
|
||||
set active(v: boolean);
|
||||
onActiveChanged(): void;
|
||||
get textWidth(): number;
|
||||
get nameGraphic(): Text;
|
||||
get totalHeight(): number;
|
||||
get nameBounds(): Rectangle;
|
||||
get shortcutKeyBounds(): Rectangle;
|
||||
get style(): MenuCompletionItemStyle;
|
||||
private checkPadding;
|
||||
private toWholePadding;
|
||||
get paddingTop(): number;
|
||||
get paddingBottom(): number;
|
||||
get paddingLeft(): number;
|
||||
get paddingRight(): number;
|
||||
get hoverColor(): string;
|
||||
get fontSize(): number;
|
||||
get fontColor(): string;
|
||||
initShortcutKeyText(): Text | undefined;
|
||||
initSubMenu(): void;
|
||||
updateBackground(width: number, height: number): void;
|
||||
updateBox(width: number, height: number): void;
|
||||
update(): void;
|
||||
}
|
||||
export {};
|
146
lib/ui/Menu.d.ts
vendored
146
lib/ui/Menu.d.ts
vendored
@ -1,146 +0,0 @@
|
||||
/**
|
||||
* 菜单配置项
|
||||
*/
|
||||
export interface MenuOptions {
|
||||
/**
|
||||
* 菜单名称,需唯一
|
||||
*/
|
||||
name: string;
|
||||
/**
|
||||
* 菜单标题
|
||||
*/
|
||||
title?: string;
|
||||
/**
|
||||
* 菜单分组
|
||||
*/
|
||||
groups: MenuGroupOptions[];
|
||||
/**
|
||||
* 菜单样式
|
||||
*/
|
||||
style?: MenuStyleOptions;
|
||||
}
|
||||
/**
|
||||
* 菜单分组
|
||||
*/
|
||||
export interface MenuGroupOptions {
|
||||
/**
|
||||
* 分组命名
|
||||
*/
|
||||
name?: string;
|
||||
/**
|
||||
* 菜单项
|
||||
*/
|
||||
items: MenuItemOptions[];
|
||||
}
|
||||
export interface MenuCompletionOptions extends MenuOptions {
|
||||
style: MenuCompletionStyleOptions;
|
||||
}
|
||||
/**
|
||||
* 菜单样式配置项
|
||||
*/
|
||||
export interface MenuStyleOptions {
|
||||
/**
|
||||
* 菜单标题样式
|
||||
*/
|
||||
titleStyle?: MenuItemStyle;
|
||||
/**
|
||||
* 菜单背景色
|
||||
*/
|
||||
backgroundColor?: string;
|
||||
/**
|
||||
* 菜单边框线宽度,默认1,0为无线框
|
||||
*/
|
||||
borderWidth?: number;
|
||||
/**
|
||||
* 菜单边框颜色
|
||||
*/
|
||||
borderColor?: string;
|
||||
/**
|
||||
* 包围框是否圆角,圆角的半径,0为直角
|
||||
*/
|
||||
borderRoundRadius?: number;
|
||||
/**
|
||||
* 菜单项样式
|
||||
*/
|
||||
itemStyle?: MenuItemStyle;
|
||||
}
|
||||
export interface MenuCompletionStyleOptions extends MenuStyleOptions {
|
||||
titleStyle: MenuItemStyle;
|
||||
backgroundColor: string;
|
||||
border: boolean;
|
||||
borderWidth: number;
|
||||
borderColor: string;
|
||||
borderRoundRadius: number;
|
||||
itemStyle: MenuCompletionItemStyle;
|
||||
}
|
||||
export interface MenuItemOptions {
|
||||
/**
|
||||
* 名称
|
||||
*/
|
||||
name: string;
|
||||
/**
|
||||
* 是否禁用,默认不禁用
|
||||
*/
|
||||
disabled?: boolean;
|
||||
/**
|
||||
* 是否显示,默认显示
|
||||
*/
|
||||
visible?: boolean;
|
||||
/**
|
||||
* 快捷键
|
||||
*/
|
||||
shortcutKeys?: string[];
|
||||
/**
|
||||
* 菜单逻辑处理
|
||||
*/
|
||||
handler?: () => void;
|
||||
fontColor?: string;
|
||||
/**
|
||||
* 子菜单
|
||||
*/
|
||||
subMenu?: MenuOptions;
|
||||
}
|
||||
export interface MenuItemStyle {
|
||||
/**
|
||||
* 字体大小
|
||||
*/
|
||||
fontSize: number;
|
||||
/**
|
||||
* 字体颜色
|
||||
*/
|
||||
fontColor?: string;
|
||||
/**
|
||||
* hover颜色
|
||||
*/
|
||||
hoverColor?: string;
|
||||
/**
|
||||
* 禁用下字体颜色
|
||||
*/
|
||||
disabledFontColor?: string;
|
||||
/**
|
||||
* 内边距
|
||||
*/
|
||||
padding: number[] | number;
|
||||
}
|
||||
export interface MenuCompletionItemStyle extends MenuItemStyle {
|
||||
/**
|
||||
* 文字颜色
|
||||
*/
|
||||
fontColor: string;
|
||||
/**
|
||||
* 激活颜色
|
||||
*/
|
||||
hoverColor: string;
|
||||
/**
|
||||
* 禁用下字体颜色
|
||||
*/
|
||||
disabledFontColor: string;
|
||||
}
|
||||
/**
|
||||
* 默认的白色样式
|
||||
*/
|
||||
export declare const DefaultWhiteStyleOptions: MenuCompletionStyleOptions;
|
||||
/**
|
||||
* 默认的白色菜单配置
|
||||
*/
|
||||
export declare const DefaultWhiteMenuOptions: MenuCompletionOptions;
|
2
lib/ui/index.d.ts
vendored
2
lib/ui/index.d.ts
vendored
@ -1,2 +0,0 @@
|
||||
export * from './ContextMenu';
|
||||
export * from './Menu';
|
232
lib/utils/GraphicUtils.d.ts
vendored
232
lib/utils/GraphicUtils.d.ts
vendored
@ -1,232 +0,0 @@
|
||||
import { Container, DisplayObject, IPointData, Point, Rectangle } from 'pixi.js';
|
||||
/**
|
||||
* 递归父节点执行逻辑
|
||||
* @param obj
|
||||
* @param handler
|
||||
*/
|
||||
export declare function recursiveParents(obj: DisplayObject, handler: (parent: Container) => void): void;
|
||||
/**
|
||||
* 递归父节点查询父节点对象
|
||||
* @param obj
|
||||
* @param finder
|
||||
* @returns
|
||||
*/
|
||||
export declare function recursiveFindParent(obj: DisplayObject, finder: (parent: Container) => boolean): Container | null;
|
||||
/**
|
||||
* 递归子节点执行逻辑
|
||||
* @param container
|
||||
* @param handler
|
||||
*/
|
||||
export declare function recursiveChildren(container: Container, handler: (child: DisplayObject) => void): void;
|
||||
/**
|
||||
* 递归子节点查询子节点对象
|
||||
*/
|
||||
export declare function recursiveFindChild(container: Container, finder: (child: DisplayObject) => boolean): DisplayObject | null;
|
||||
export interface BezierParam {
|
||||
p1: IPointData;
|
||||
p2: IPointData;
|
||||
cp1: IPointData;
|
||||
cp2: IPointData;
|
||||
}
|
||||
/**
|
||||
* 判断贝塞尔曲线数据是否正确
|
||||
* @param points
|
||||
*/
|
||||
export declare function assertBezierPoints(points: IPointData[]): void;
|
||||
/**
|
||||
* 转换为贝塞尔曲线参数
|
||||
* @param points
|
||||
* @returns
|
||||
*/
|
||||
export declare function convertToBezierParams(points: IPointData[]): BezierParam[];
|
||||
/**
|
||||
* 根据分段数计算贝塞尔曲线所有点坐标
|
||||
* @param basePoints
|
||||
* @param segmentsCount
|
||||
* @returns
|
||||
*/
|
||||
export declare function calculateBezierPoints(basePoints: IPointData[], segmentsCount: number): Point[];
|
||||
/**
|
||||
* 根据分段数计算贝塞尔曲线所有点坐标
|
||||
* @param basePoints
|
||||
* @param segmentsCount
|
||||
* @returns
|
||||
*/
|
||||
export declare function calculateOneBezierPoints(p1: IPointData, p2: IPointData, cp1: IPointData, cp2: IPointData, segmentsCount: number): Point[];
|
||||
/**
|
||||
* 计算矩形中点
|
||||
*/
|
||||
export declare function getRectangleCenter(rectangle: Rectangle): Point;
|
||||
/**
|
||||
* 计算两个矩形中心对齐的坐标, PS: 计算的是较大包围框的中心
|
||||
* @param rect1
|
||||
* @param rect2
|
||||
* @returns
|
||||
*/
|
||||
export declare function getCenterOfTwoRectangle(rect1: Rectangle, rect2: Rectangle): Point;
|
||||
/**
|
||||
* 序列化图形变换
|
||||
* @param obj
|
||||
* @returns
|
||||
*/
|
||||
export declare function serializeTransform(obj: DisplayObject): number[];
|
||||
/**
|
||||
* 反序列化变换数据到图形对象
|
||||
* @param obj
|
||||
* @param transform
|
||||
*/
|
||||
export declare function deserializeTransformInto(obj: DisplayObject, transform: number[]): void;
|
||||
/**
|
||||
* 将直线转换为多边形
|
||||
* @param p1
|
||||
* @param p2
|
||||
* @param thick
|
||||
* @returns
|
||||
*/
|
||||
export declare function convertLineToPolygonPoints(p1: IPointData, p2: IPointData, thick: number): IPointData[];
|
||||
/**
|
||||
* 转换矩形为多边形点坐标
|
||||
* @param rect 矩形
|
||||
* @returns
|
||||
*/
|
||||
export declare function convertRectangleToPolygonPoints(rect: Rectangle): IPointData[];
|
||||
/**
|
||||
* 计算线段中点坐标
|
||||
* @param p1
|
||||
* @param p2
|
||||
* @returns
|
||||
*/
|
||||
export declare function calculateLineMidpoint(p1: IPointData, p2: IPointData): Point;
|
||||
/**
|
||||
* 计算线段细分坐标--线段分成几份
|
||||
* @param p1
|
||||
* @param p2
|
||||
* @param knife
|
||||
* @returns
|
||||
*/
|
||||
export declare function calculateLineSegmentingPoint(p1: IPointData, p2: IPointData, knife: number): IPointData[];
|
||||
/**
|
||||
* 计算点到直线距离
|
||||
* @param p1
|
||||
* @param p2
|
||||
* @param p
|
||||
*/
|
||||
export declare function calculateDistanceFromPointToLine(p1: IPointData, p2: IPointData, p: IPointData): number;
|
||||
/**
|
||||
* 计算点到直线的垂足坐标
|
||||
* @param p
|
||||
* @param p1
|
||||
* @param p2
|
||||
*/
|
||||
export declare function calculateFootPointFromPointToLine(p1: IPointData, p2: IPointData, p: IPointData): Point;
|
||||
/**
|
||||
* 计算直线与圆的交点
|
||||
* 1用直线到圆心的距离和半径相比,判断是否和圆有交点;
|
||||
* 2求出圆心在直线上面的垂点;
|
||||
* 3算出直线的单位向量e;
|
||||
* 4求出一侧交点(Intersection)到projectPoint的长度(sideLength);
|
||||
* 5求出sideLength和这侧端点到projectPoint距离的比例(ratio);
|
||||
* 6projectPoint +/- ratio * e = 两侧交点;
|
||||
* @param p0 圆心坐标
|
||||
* @param radius 圆半径
|
||||
* @param p1 直线坐标1
|
||||
* @param p2 直线坐标2
|
||||
* @returns 交点坐标,可能2/1/0个
|
||||
*/
|
||||
export declare function calculateIntersectionPointOfCircleAndLine(p0: IPointData, radius: number, p1: IPointData, p2: IPointData): Point[];
|
||||
/**
|
||||
* 计算圆心与圆心外一点与圆的交点(取圆心到点的向量与圆的交点)
|
||||
* @param p0 圆心坐标
|
||||
* @param radius 圆半径
|
||||
* @param p 点坐标
|
||||
* @returns
|
||||
*/
|
||||
export declare function calculateIntersectionPointOfCircleAndPoint(p0: IPointData, radius: number, p: IPointData): Point;
|
||||
/**
|
||||
* 计算点基于点的镜像点坐标
|
||||
* @param bp 基准点
|
||||
* @param p 待镜像的点坐标
|
||||
* @param distance 镜像点到基准点的距离,默认为p到基准点的距离,即对称
|
||||
* @returns
|
||||
*/
|
||||
export declare function calculateMirrorPoint(bp: IPointData, p: IPointData, distance?: number): Point;
|
||||
/**
|
||||
* 计算基于给定轴的给定点的镜像点坐标
|
||||
* @param pa 给定轴线的坐标
|
||||
* @param pb 给定轴线的坐标
|
||||
* @param p 待镜像点坐标
|
||||
* @param distance
|
||||
* @returns
|
||||
*/
|
||||
export declare function calculateMirrorPointBasedOnAxis(pa: IPointData, pb: IPointData, p: IPointData, distance?: number): Point;
|
||||
/**
|
||||
* 计算直线与水平夹角,角度按顺时针,从0开始
|
||||
* @param p1
|
||||
* @param p2
|
||||
* @returns 角度,范围[0, 360)
|
||||
*/
|
||||
export declare function angleToAxisx(p1: IPointData, p2: IPointData): number;
|
||||
/**
|
||||
* 计算两线夹角,pc与pa,pb的夹角,顺时针为正,逆时针为负
|
||||
* @param pa 交点
|
||||
* @param pb 锚定
|
||||
* @param pc
|
||||
* @returns 夹角, [-180, 180]
|
||||
*/
|
||||
export declare function angleOfIncludedAngle(pa: IPointData, pb: IPointData, pc: IPointData): number;
|
||||
/**
|
||||
* 计算两点连线的法向量
|
||||
* @param point1
|
||||
* @param point2
|
||||
* @returns 单位法向量
|
||||
*/
|
||||
export declare function getNormalVector(point1: IPointData, point2: IPointData): number[];
|
||||
/**
|
||||
* 点延向量方向移动
|
||||
* @param point
|
||||
* @param normal 单位向量
|
||||
* @param length 平移长度
|
||||
* @returns 移动后的点
|
||||
*/
|
||||
export declare function movePointAlongNormal(point: IPointData, normal: number[], length: number): Point;
|
||||
/**
|
||||
* 计算两组点各自组成直线的相交点(若两线平行 返回第一组坐标第一个点)
|
||||
* @param line1 两点坐标列表
|
||||
* @param line2 两点坐标列表
|
||||
* @returns 相交点
|
||||
*/
|
||||
export declare function getIntersectionPoint(line1: number[], line2: number[]): Point;
|
||||
/**
|
||||
* 是否平行线
|
||||
* @param p1
|
||||
* @param p2
|
||||
* @param pa
|
||||
* @param pb
|
||||
* @returns
|
||||
*/
|
||||
export declare function isParallelLines(p1: IPointData, p2: IPointData, pa: IPointData, pb: IPointData): boolean;
|
||||
/**
|
||||
* 点是否在线段上
|
||||
* @param p1
|
||||
* @param p2
|
||||
* @param p
|
||||
* @returns
|
||||
*/
|
||||
export declare function isPointOnLine(p1: IPointData, p2: IPointData, p: IPointData): boolean;
|
||||
/**
|
||||
* 两条线段是否存在包含关系
|
||||
* @param line1
|
||||
* @param line2
|
||||
* @returns
|
||||
*/
|
||||
export declare function isLineContainOther(line1: {
|
||||
p1: IPointData;
|
||||
p2: IPointData;
|
||||
}, line2: {
|
||||
p1: IPointData;
|
||||
p2: IPointData;
|
||||
}): boolean;
|
||||
/** 均分线段, 返回各线段端点 */
|
||||
export declare function splitLineEvenly(p1: IPointData, p2: IPointData, count: number): IPointData[][];
|
||||
export declare function splitPolyline(points: IPointData[], count: number): IPointData[][];
|
||||
export declare function getParallelOfPolyline(points: IPointData[], offset: number, side: 'L' | 'R'): IPointData[];
|
119
lib/utils/IntersectUtils.d.ts
vendored
119
lib/utils/IntersectUtils.d.ts
vendored
@ -1,119 +0,0 @@
|
||||
import { IPointData, Rectangle } from 'pixi.js';
|
||||
/**
|
||||
* 根据点到直线的垂直距离计算碰撞
|
||||
* @param pa 线段a端坐标
|
||||
* @param pb 线段b端坐标
|
||||
* @param p 点坐标
|
||||
* @param lineWidth 线宽
|
||||
* @param exact 是否精确(使用给定线宽,否则线宽会设置为8)
|
||||
* @returns
|
||||
*/
|
||||
export declare function linePoint(pa: IPointData, pb: IPointData, p: IPointData, lineWidth: number, exact?: boolean): boolean;
|
||||
/**
|
||||
* 折线与点碰撞
|
||||
* @param points 折线端点列表
|
||||
* @param p 点座标
|
||||
* @param lineWidth 线宽
|
||||
*/
|
||||
export declare function polylinePoint(points: IPointData[], p: IPointData, lineWidth: number): boolean;
|
||||
/**
|
||||
* 线线碰撞检测
|
||||
* @param pa 线段1a端坐标
|
||||
* @param pb 线段1b端坐标
|
||||
* @param p1 线段2a端坐标
|
||||
* @param p2 线段2b端坐标
|
||||
* @returns
|
||||
*/
|
||||
export declare function lineLine(pa: IPointData, pb: IPointData, p1: IPointData, p2: IPointData): boolean;
|
||||
/**
|
||||
* 点和矩形碰撞检测
|
||||
* @param p 点作弊
|
||||
* @param rect 矩形
|
||||
* @returns
|
||||
*/
|
||||
export declare function pointBox(p: IPointData, rect: Rectangle): boolean;
|
||||
/**
|
||||
* 线和矩形碰撞检测
|
||||
* @param pa 线段a端坐标
|
||||
* @param pb 线段b端坐标
|
||||
* @param rect 矩形
|
||||
* @returns
|
||||
*/
|
||||
export declare function lineBox(pa: IPointData, pb: IPointData, rect: Rectangle): boolean;
|
||||
/**
|
||||
* 多线段和矩形碰撞检测
|
||||
* @param points
|
||||
* @param rect
|
||||
* @returns false / 碰撞的线段序号
|
||||
*/
|
||||
export declare function polylineBox(points: IPointData[], rect: Rectangle): boolean;
|
||||
/**
|
||||
* 两点碰撞检测
|
||||
* @param p1
|
||||
* @param p2
|
||||
* @param tolerance
|
||||
* @returns
|
||||
*/
|
||||
export declare function pointPoint2(p1: IPointData, p2: IPointData, tolerance: number): boolean;
|
||||
/**
|
||||
* 两点碰撞检测
|
||||
* @param x1
|
||||
* @param y1
|
||||
* @param x2
|
||||
* @param y2
|
||||
* @param tolerance 容忍度/两点半径和
|
||||
* @returns
|
||||
*/
|
||||
export declare function pointPoint(x1: number, y1: number, x2: number, y2: number, tolerance: number): boolean;
|
||||
/**
|
||||
* 两点距离
|
||||
* @param x1
|
||||
* @param y1
|
||||
* @param x2
|
||||
* @param y2
|
||||
* @returns
|
||||
*/
|
||||
export declare function distance(x1: number, y1: number, x2: number, y2: number): number;
|
||||
/**
|
||||
* 两点距离
|
||||
* @param p1
|
||||
* @param p2
|
||||
* @returns
|
||||
*/
|
||||
export declare function distance2(p1: IPointData, p2: IPointData): number;
|
||||
/**
|
||||
* 圆和点的碰撞检测
|
||||
* @param x1 圆心x
|
||||
* @param y1 圆心y
|
||||
* @param r1 圆半径
|
||||
* @param x2 点x
|
||||
* @param y2 点y
|
||||
* @returns
|
||||
*/
|
||||
export declare function circlePoint(x1: number, y1: number, r1: number, x2: number, y2: number): boolean;
|
||||
/**
|
||||
* 圆和点的碰撞检测--不包括圆内部
|
||||
*/
|
||||
export declare function circlePoint2(x1: number, y1: number, r1: number, x2: number, y2: number, tolerance: number): boolean;
|
||||
/**
|
||||
* 点和多边形碰撞检测
|
||||
*/
|
||||
export declare function pointPolygon(p: IPointData, points: IPointData[], lineWidth: number): boolean;
|
||||
/**
|
||||
* 线和多边形碰撞检测
|
||||
* @param p1
|
||||
* @param p2
|
||||
* @param points
|
||||
* @param tolerance 多边形包围线宽
|
||||
* @returns
|
||||
*/
|
||||
export declare function linePolygon(p1: IPointData, p2: IPointData, points: IPointData[], lineWidth: number, polygonWidth: number): boolean;
|
||||
/**
|
||||
* 多边线与多边形碰撞检测
|
||||
* @param polylinePoints 多边线所有点坐标
|
||||
* @param polygonPoints 多边形所有点坐标
|
||||
* @param polylineWidth 多边线的线宽
|
||||
* @param polygonWidth 多边形线宽
|
||||
* @returns
|
||||
*/
|
||||
export declare function polylinePolygon(polylinePoints: IPointData[], polygonPoints: IPointData[], polylineWidth: number, polygonWidth: number): boolean;
|
5
lib/utils/debounce.d.ts
vendored
5
lib/utils/debounce.d.ts
vendored
@ -1,5 +0,0 @@
|
||||
export interface DebouncedFunction<F extends (...args: any[]) => any> {
|
||||
(context: ThisParameterType<F>, ...args: Parameters<F>): void;
|
||||
cancel: () => void;
|
||||
}
|
||||
export declare function debounce<F extends (...args: Parameters<F>) => any>(fn: F, waitMs?: number): DebouncedFunction<F>;
|
26
lib/utils/index.d.ts
vendored
26
lib/utils/index.d.ts
vendored
@ -1,26 +0,0 @@
|
||||
import { Point, Rectangle } from 'pixi.js';
|
||||
export * from './GraphicUtils';
|
||||
export * from './IntersectUtils';
|
||||
export * from './debounce';
|
||||
export declare const UP: Point;
|
||||
export declare const DOWN: Point;
|
||||
export declare const LEFT: Point;
|
||||
export declare const RIGHT: Point;
|
||||
/**
|
||||
* 越界结果
|
||||
*/
|
||||
export declare class OutOfBound {
|
||||
left: boolean;
|
||||
top: boolean;
|
||||
right: boolean;
|
||||
bottom: boolean;
|
||||
constructor(left: boolean, top: boolean, right: boolean, bottom: boolean);
|
||||
static check(rect: Rectangle, bound: Rectangle): OutOfBound;
|
||||
static none(): OutOfBound;
|
||||
static leftOut(): OutOfBound;
|
||||
static topOut(): OutOfBound;
|
||||
static rightOut(): OutOfBound;
|
||||
static bottomOut(): OutOfBound;
|
||||
static leftTopOut(): OutOfBound;
|
||||
static rightBottomOut(): OutOfBound;
|
||||
}
|
51
package.json
51
package.json
@ -1,43 +1,46 @@
|
||||
{
|
||||
"name": "graphic-pixi",
|
||||
"version": "0.1.18",
|
||||
"version": "0.0.1",
|
||||
"description": "基于pixijs的图形应用、绘制应用框架",
|
||||
"productName": "Graphic-pixi",
|
||||
"author": "walker <shengxuqiang@joylink.club>",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"main": "lib/index.js",
|
||||
"types": "lib/index.d.ts",
|
||||
"scripts": {
|
||||
"build": "rollup -c rollup.config.mjs"
|
||||
"lint": "eslint --ext .js,.ts,.vue ./",
|
||||
"format": "prettier --write \"**/*.{js,ts,vue,scss,html,md,json}\" --ignore-path .gitignore",
|
||||
"test": "echo \"No test specified\" && exit 0",
|
||||
"dev": "quasar dev",
|
||||
"proto": "node scripts/proto.cjs",
|
||||
"build": "quasar build"
|
||||
},
|
||||
"files": [
|
||||
"lib",
|
||||
"*.d.ts"
|
||||
],
|
||||
"dependencies": {
|
||||
"@pixi/graphics-extras": "^7.3.2",
|
||||
"@pixi/utils": "^7.3.2",
|
||||
"@quasar/extras": "^1.0.0",
|
||||
"@stomp/stompjs": "^7.0.0",
|
||||
"mqtt": "^5.2.1",
|
||||
"google-protobuf": "^3.21.2",
|
||||
"js-base64": "^3.7.5",
|
||||
"pinia": "^2.0.11",
|
||||
"pixi-viewport": "^5.0.1",
|
||||
"pixi.js": "^7.3.2"
|
||||
"pixi.js": "^7.2.4",
|
||||
"quasar": "^2.6.0",
|
||||
"vue": "^3.0.0",
|
||||
"vue-router": "^4.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@rollup/plugin-alias": "^5.1.0",
|
||||
"@rollup/plugin-replace": "^5.0.5",
|
||||
"@rollup/plugin-typescript": "^11.1.5",
|
||||
"@quasar/app-vite": "^1.0.0",
|
||||
"@types/google-protobuf": "^3.15.6",
|
||||
"@types/node": "^12.20.21",
|
||||
"eslint": "^8.55.0",
|
||||
"eslint-config-prettier": "^9.1.0",
|
||||
"eslint-plugin-prettier": "^5.0.1",
|
||||
"prettier": "^3.1.1",
|
||||
"rollup": "^4.8.0",
|
||||
"rollup-plugin-dts": "^6.1.0",
|
||||
"typescript": "^5.3.3"
|
||||
"@typescript-eslint/eslint-plugin": "^5.10.0",
|
||||
"@typescript-eslint/parser": "^5.10.0",
|
||||
"autoprefixer": "^10.4.2",
|
||||
"eslint": "^8.10.0",
|
||||
"eslint-config-prettier": "^8.1.0",
|
||||
"eslint-plugin-vue": "^9.0.0",
|
||||
"prettier": "^2.5.1",
|
||||
"protoc-gen-ts": "^0.8.6",
|
||||
"typescript": "^4.5.4"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 14.19",
|
||||
"node": "^18 || ^16 || ^14.19",
|
||||
"npm": ">= 6.13.4",
|
||||
"yarn": ">= 1.21.1"
|
||||
}
|
||||
|
27
postcss.config.js
Normal file
27
postcss.config.js
Normal file
@ -0,0 +1,27 @@
|
||||
/* eslint-disable */
|
||||
// https://github.com/michael-ciniawsky/postcss-load-config
|
||||
|
||||
module.exports = {
|
||||
plugins: [
|
||||
// https://github.com/postcss/autoprefixer
|
||||
require('autoprefixer')({
|
||||
overrideBrowserslist: [
|
||||
'last 4 Chrome versions',
|
||||
'last 4 Firefox versions',
|
||||
'last 4 Edge versions',
|
||||
'last 4 Safari versions',
|
||||
'last 4 Android versions',
|
||||
'last 4 ChromeAndroid versions',
|
||||
'last 4 FirefoxAndroid versions',
|
||||
'last 4 iOS versions'
|
||||
]
|
||||
})
|
||||
|
||||
// https://github.com/elchininet/postcss-rtlcss
|
||||
// If you want to support RTL css, then
|
||||
// 1. yarn/npm install postcss-rtlcss
|
||||
// 2. optionally set quasar.config.js > framework > lang to an RTL language
|
||||
// 3. uncomment the following line:
|
||||
// require('postcss-rtlcss')
|
||||
]
|
||||
}
|
BIN
public/favicon.ico
Normal file
BIN
public/favicon.ico
Normal file
Binary file not shown.
After Width: | Height: | Size: 63 KiB |
BIN
public/icons/favicon-128x128.png
Normal file
BIN
public/icons/favicon-128x128.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 12 KiB |
BIN
public/icons/favicon-16x16.png
Normal file
BIN
public/icons/favicon-16x16.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 859 B |
BIN
public/icons/favicon-32x32.png
Normal file
BIN
public/icons/favicon-32x32.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 2.0 KiB |
BIN
public/icons/favicon-96x96.png
Normal file
BIN
public/icons/favicon-96x96.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 9.4 KiB |
208
quasar.config.js
Normal file
208
quasar.config.js
Normal file
@ -0,0 +1,208 @@
|
||||
/* eslint-env node */
|
||||
|
||||
/*
|
||||
* This file runs in a Node context (it's NOT transpiled by Babel), so use only
|
||||
* the ES6 features that are supported by your Node version. https://node.green/
|
||||
*/
|
||||
|
||||
// Configuration for your app
|
||||
// https://v2.quasar.dev/quasar-cli-vite/quasar-config-js
|
||||
|
||||
const { configure } = require('quasar/wrappers');
|
||||
|
||||
module.exports = configure(function (/* ctx */) {
|
||||
return {
|
||||
eslint: {
|
||||
// fix: true,
|
||||
// include: [],
|
||||
// exclude: [],
|
||||
// rawOptions: {},
|
||||
warnings: true,
|
||||
errors: true,
|
||||
exclude: ['src/examples/app/protos/*'],
|
||||
},
|
||||
|
||||
// https://v2.quasar.dev/quasar-cli-vite/prefetch-feature
|
||||
// preFetch: true,
|
||||
|
||||
// app boot file (/src/boot)
|
||||
// --> boot files are part of "main.js"
|
||||
// https://v2.quasar.dev/quasar-cli-vite/boot-files
|
||||
boot: [],
|
||||
|
||||
// https://v2.quasar.dev/quasar-cli-vite/quasar-config-js#css
|
||||
css: ['app.scss'],
|
||||
|
||||
// https://github.com/quasarframework/quasar/tree/dev/extras
|
||||
extras: [
|
||||
// 'ionicons-v4',
|
||||
// 'mdi-v5',
|
||||
// 'fontawesome-v6',
|
||||
// 'eva-icons',
|
||||
// 'themify',
|
||||
// 'line-awesome',
|
||||
// 'roboto-font-latin-ext', // this or either 'roboto-font', NEVER both!
|
||||
|
||||
'roboto-font', // optional, you are not bound to it
|
||||
'material-icons', // optional, you are not bound to it
|
||||
],
|
||||
|
||||
// Full list of options: https://v2.quasar.dev/quasar-cli-vite/quasar-config-js#build
|
||||
build: {
|
||||
target: {
|
||||
browser: ['es2019', 'edge88', 'firefox78', 'chrome87', 'safari13.1'],
|
||||
node: 'node16',
|
||||
},
|
||||
|
||||
vueRouterMode: 'history', // available values: 'hash', 'history'
|
||||
// vueRouterBase,
|
||||
// vueDevtools,
|
||||
// vueOptionsAPI: false,
|
||||
|
||||
// rebuildCache: true, // rebuilds Vite/linter/etc cache on startup
|
||||
|
||||
// publicPath: '/',
|
||||
// analyze: true,
|
||||
// env: {},
|
||||
// rawDefine: {}
|
||||
// ignorePublicFolder: true,
|
||||
// minify: false,
|
||||
// polyfillModulePreload: true,
|
||||
// distDir
|
||||
|
||||
// extendViteConf (viteConf) {},
|
||||
// viteVuePluginOptions: {},
|
||||
|
||||
// vitePlugins: [
|
||||
// [ 'package-name', { ..options.. } ]
|
||||
// ]
|
||||
},
|
||||
|
||||
// Full list of options: https://v2.quasar.dev/quasar-cli-vite/quasar-config-js#devServer
|
||||
devServer: {
|
||||
// https: true
|
||||
port: 9999,
|
||||
open: false, // opens browser window automatically
|
||||
},
|
||||
|
||||
// https://v2.quasar.dev/quasar-cli-vite/quasar-config-js#framework
|
||||
framework: {
|
||||
config: {
|
||||
notify: {
|
||||
position: 'top',
|
||||
timeout: 2000,
|
||||
progress: true,
|
||||
},
|
||||
},
|
||||
|
||||
// iconSet: 'material-icons', // Quasar icon set
|
||||
lang: 'zh-CN', // Quasar language pack
|
||||
|
||||
// For special cases outside of where the auto-import strategy can have an impact
|
||||
// (like functional components as one of the examples),
|
||||
// you can manually specify Quasar components/directives to be available everywhere:
|
||||
//
|
||||
// components: [],
|
||||
// directives: [],
|
||||
|
||||
// Quasar plugins
|
||||
plugins: ['Notify', 'Dialog', 'Dark', 'AppFullscreen'],
|
||||
},
|
||||
|
||||
// animations: 'all', // --- includes all animations
|
||||
// https://v2.quasar.dev/options/animations
|
||||
animations: [],
|
||||
|
||||
// https://v2.quasar.dev/quasar-cli-vite/quasar-config-js#sourcefiles
|
||||
// sourceFiles: {
|
||||
// rootComponent: 'src/App.vue',
|
||||
// router: 'src/router/index',
|
||||
// store: 'src/store/index',
|
||||
// registerServiceWorker: 'src-pwa/register-service-worker',
|
||||
// serviceWorker: 'src-pwa/custom-service-worker',
|
||||
// pwaManifestFile: 'src-pwa/manifest.json',
|
||||
// electronMain: 'src-electron/electron-main',
|
||||
// electronPreload: 'src-electron/electron-preload'
|
||||
// },
|
||||
|
||||
// https://v2.quasar.dev/quasar-cli-vite/developing-ssr/configuring-ssr
|
||||
ssr: {
|
||||
// ssrPwaHtmlFilename: 'offline.html', // do NOT use index.html as name!
|
||||
// will mess up SSR
|
||||
|
||||
// extendSSRWebserverConf (esbuildConf) {},
|
||||
// extendPackageJson (json) {},
|
||||
|
||||
pwa: false,
|
||||
|
||||
// manualStoreHydration: true,
|
||||
// manualPostHydrationTrigger: true,
|
||||
|
||||
prodPort: 3000, // The default port that the production server should use
|
||||
// (gets superseded if process.env.PORT is specified at runtime)
|
||||
|
||||
middlewares: [
|
||||
'render', // keep this as last one
|
||||
],
|
||||
},
|
||||
|
||||
// https://v2.quasar.dev/quasar-cli-vite/developing-pwa/configuring-pwa
|
||||
pwa: {
|
||||
workboxMode: 'generateSW', // or 'injectManifest'
|
||||
injectPwaMetaTags: true,
|
||||
swFilename: 'sw.js',
|
||||
manifestFilename: 'manifest.json',
|
||||
useCredentialsForManifestTag: false,
|
||||
// useFilenameHashes: true,
|
||||
// extendGenerateSWOptions (cfg) {}
|
||||
// extendInjectManifestOptions (cfg) {},
|
||||
// extendManifestJson (json) {}
|
||||
// extendPWACustomSWConf (esbuildConf) {}
|
||||
},
|
||||
|
||||
// Full list of options: https://v2.quasar.dev/quasar-cli-vite/developing-cordova-apps/configuring-cordova
|
||||
cordova: {
|
||||
// noIosLegacyBuildFlag: true, // uncomment only if you know what you are doing
|
||||
},
|
||||
|
||||
// Full list of options: https://v2.quasar.dev/quasar-cli-vite/developing-capacitor-apps/configuring-capacitor
|
||||
capacitor: {
|
||||
hideSplashscreen: true,
|
||||
},
|
||||
|
||||
// Full list of options: https://v2.quasar.dev/quasar-cli-vite/developing-electron-apps/configuring-electron
|
||||
electron: {
|
||||
// extendElectronMainConf (esbuildConf)
|
||||
// extendElectronPreloadConf (esbuildConf)
|
||||
|
||||
inspectPort: 5858,
|
||||
|
||||
bundler: 'packager', // 'packager' or 'builder'
|
||||
|
||||
packager: {
|
||||
// https://github.com/electron-userland/electron-packager/blob/master/docs/api.md#options
|
||||
// OS X / Mac App Store
|
||||
// appBundleId: '',
|
||||
// appCategoryType: '',
|
||||
// osxSign: '',
|
||||
// protocol: 'myapp://path',
|
||||
// Windows only
|
||||
// win32metadata: { ... }
|
||||
},
|
||||
|
||||
builder: {
|
||||
// https://www.electron.build/configuration/configuration
|
||||
|
||||
appId: 'graphic-pixi',
|
||||
},
|
||||
},
|
||||
|
||||
// Full list of options: https://v2.quasar.dev/quasar-cli-vite/developing-browser-extensions/configuring-bex
|
||||
bex: {
|
||||
contentScripts: ['my-content-script'],
|
||||
|
||||
// extendBexScriptsConf (esbuildConf) {}
|
||||
// extendBexManifestJson (json) {}
|
||||
},
|
||||
};
|
||||
});
|
@ -1,30 +0,0 @@
|
||||
import typescript from '@rollup/plugin-typescript';
|
||||
|
||||
/**
|
||||
* @type {import('rollup').RollupOptions}
|
||||
*/
|
||||
const config = {
|
||||
input: ['src/index.ts'],
|
||||
output: {
|
||||
dir: 'lib',
|
||||
format: 'esm',
|
||||
},
|
||||
external: [
|
||||
'pixi.js',
|
||||
'pixi-viewport',
|
||||
'@stomp/stompjs',
|
||||
'mqtt',
|
||||
'eventemitter3',
|
||||
'@pixi/graphics-extras',
|
||||
],
|
||||
logLevel: 'debug',
|
||||
plugins: [
|
||||
typescript({
|
||||
declarationDir: 'lib',
|
||||
include: ['src/**/*'],
|
||||
tsconfig: './tsconfig.json',
|
||||
}),
|
||||
],
|
||||
};
|
||||
|
||||
export default config;
|
95
scripts/proto.cjs
Normal file
95
scripts/proto.cjs
Normal file
@ -0,0 +1,95 @@
|
||||
/**
|
||||
* 将proto文件编译到 src/proto/
|
||||
*/
|
||||
const { readdirSync } = require('fs');
|
||||
const { resolve } = require('path');
|
||||
const os = require('os');
|
||||
|
||||
const { exec } = require('child_process');
|
||||
|
||||
const protocDir = resolve(
|
||||
__dirname,
|
||||
'../src/examples/app/app_message/protoc-22.2'
|
||||
);
|
||||
const protoFileDir = resolve(
|
||||
__dirname,
|
||||
'../src/examples/app/app_message/protos'
|
||||
);
|
||||
const destDir = resolve(__dirname, '../src/examples/app/protos');
|
||||
|
||||
/**
|
||||
* 递归处理所有proto文件生成
|
||||
* @param {*} file 文件
|
||||
* @param {*} path 目录
|
||||
*/
|
||||
function recursiveGenerate(file, path = [], cmds = []) {
|
||||
if (file.isFile()) {
|
||||
// 文件,生成
|
||||
if (file.name.endsWith('.proto')) {
|
||||
cmds.push(buildGenerateCmd(file.name, path));
|
||||
} else {
|
||||
console.warn('不是proto文件', file.name);
|
||||
}
|
||||
} else if (file.isDirectory()) {
|
||||
// 文件夹,递归
|
||||
readdirSync(resolve(protoFileDir, ...path, file.name), {
|
||||
withFileTypes: true,
|
||||
}).forEach((f) => {
|
||||
const subPath = [...path, file.name];
|
||||
recursiveGenerate(f, subPath, cmds);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const isLinux = os.type().toLowerCase().includes('linux');
|
||||
|
||||
function buildGenerateCmd(name, path = []) {
|
||||
const protoPath = resolve(protoFileDir, ...path);
|
||||
const tsPath = resolve(destDir, ...path);
|
||||
|
||||
let cmd = ['protoc', `-I=${protoPath}`, `--ts_out=${tsPath}`, `${name}`];
|
||||
let cmdStr = cmd.join(' ');
|
||||
return cmdStr;
|
||||
}
|
||||
|
||||
function main() {
|
||||
const protocBin = resolve(
|
||||
protocDir,
|
||||
`bin/${isLinux ? 'linux-x86_64' : 'win64'}`
|
||||
);
|
||||
const prepareCmds = [];
|
||||
const setPathCmd = isLinux
|
||||
? ['export', `PATH=${protocBin}:${protocDir}:"$PATH"`].join(' ')
|
||||
: ['set', `PATH=${protocBin};${protocDir};%PATH%`].join(' ');
|
||||
const protocVersionCmd = ['protoc', '--version'].join(' ');
|
||||
prepareCmds.push(setPathCmd);
|
||||
prepareCmds.push(protocVersionCmd);
|
||||
|
||||
readdirSync(protoFileDir, {
|
||||
withFileTypes: true,
|
||||
}).forEach((f) => {
|
||||
recursiveGenerate(f, [], prepareCmds);
|
||||
});
|
||||
|
||||
console.log(prepareCmds);
|
||||
|
||||
exec(
|
||||
prepareCmds.join(' && '),
|
||||
{
|
||||
maxBuffer: 1024 * 2000,
|
||||
},
|
||||
(err, stdout, stderr) => {
|
||||
if (err) {
|
||||
console.error(err);
|
||||
throw err;
|
||||
} else if (stderr.length > 0) {
|
||||
console.error(stderr.toString());
|
||||
throw new Error(stderr.toString());
|
||||
} else {
|
||||
console.log(stdout);
|
||||
}
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
main();
|
7
src/App.vue
Normal file
7
src/App.vue
Normal file
@ -0,0 +1,7 @@
|
||||
<template>
|
||||
<router-view />
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
|
||||
</script>
|
@ -1,110 +0,0 @@
|
||||
import { GraphicData, JlGraphic } from '../core';
|
||||
import { JlOperation } from '../operation';
|
||||
import { ICanvasProperties, IGraphicApp, IJlCanvas } from './JlGraphicApp';
|
||||
|
||||
/**
|
||||
* 更新画布操作
|
||||
*/
|
||||
export class UpdateCanvasOperation extends JlOperation {
|
||||
obj: IJlCanvas;
|
||||
old: ICanvasProperties;
|
||||
data: ICanvasProperties;
|
||||
description = '';
|
||||
|
||||
constructor(
|
||||
app: IGraphicApp,
|
||||
obj: IJlCanvas,
|
||||
old: ICanvasProperties,
|
||||
data: ICanvasProperties
|
||||
) {
|
||||
super(app, 'update-canvas');
|
||||
this.app = app;
|
||||
this.obj = obj;
|
||||
this.old = old;
|
||||
this.data = data;
|
||||
}
|
||||
|
||||
undo(): JlGraphic[] {
|
||||
this.obj.update(this.old);
|
||||
return [];
|
||||
}
|
||||
redo(): JlGraphic[] {
|
||||
this.obj.update(this.data);
|
||||
return [];
|
||||
}
|
||||
}
|
||||
/**
|
||||
* 创建图形操作
|
||||
*/
|
||||
export class GraphicCreateOperation extends JlOperation {
|
||||
obj: JlGraphic[];
|
||||
description = '';
|
||||
|
||||
constructor(app: IGraphicApp, obj: JlGraphic[]) {
|
||||
super(app, 'graphic-create');
|
||||
this.app = app;
|
||||
this.obj = obj;
|
||||
}
|
||||
|
||||
undo(): JlGraphic[] | void {
|
||||
this.app.deleteGraphics(...this.obj);
|
||||
}
|
||||
redo(): JlGraphic[] {
|
||||
this.app.addGraphics(...this.obj);
|
||||
return this.obj;
|
||||
}
|
||||
}
|
||||
/**
|
||||
* 删除图形操作
|
||||
*/
|
||||
export class GraphicDeleteOperation extends JlOperation {
|
||||
obj: JlGraphic[];
|
||||
|
||||
constructor(app: IGraphicApp, obj: JlGraphic[]) {
|
||||
super(app, 'graphic-delete');
|
||||
this.app = app;
|
||||
this.obj = obj;
|
||||
}
|
||||
|
||||
undo(): JlGraphic[] {
|
||||
this.app.addGraphics(...this.obj);
|
||||
return this.obj;
|
||||
}
|
||||
redo(): void {
|
||||
this.app.deleteGraphics(...this.obj);
|
||||
}
|
||||
}
|
||||
|
||||
export class GraphicDataUpdateOperation extends JlOperation {
|
||||
obj: JlGraphic[];
|
||||
oldData: GraphicData[];
|
||||
newData: GraphicData[];
|
||||
constructor(
|
||||
app: IGraphicApp,
|
||||
obj: JlGraphic[],
|
||||
oldData: GraphicData[],
|
||||
newData: GraphicData[]
|
||||
) {
|
||||
super(app, 'graphic-drag');
|
||||
this.obj = [...obj];
|
||||
this.oldData = oldData;
|
||||
this.newData = newData;
|
||||
}
|
||||
|
||||
undo(): void | JlGraphic[] {
|
||||
for (let i = 0; i < this.obj.length; i++) {
|
||||
const g = this.obj[i];
|
||||
// g.exitChildEdit();
|
||||
g.updateData(this.oldData[i]);
|
||||
}
|
||||
return this.obj;
|
||||
}
|
||||
redo(): void | JlGraphic[] {
|
||||
for (let i = 0; i < this.obj.length; i++) {
|
||||
const g = this.obj[i];
|
||||
// g.exitChildEdit();
|
||||
g.updateData(this.newData[i]);
|
||||
}
|
||||
return this.obj;
|
||||
}
|
||||
}
|
@ -1,49 +0,0 @@
|
||||
import {
|
||||
DrawAppOptions,
|
||||
DrawAssistant,
|
||||
GraphicDrawAssistant,
|
||||
IDrawApp,
|
||||
JlDrawApp,
|
||||
} from './JlDrawApp';
|
||||
import {
|
||||
AppConsts,
|
||||
GraphicApp,
|
||||
GraphicAppOptions,
|
||||
ICanvasProperties,
|
||||
IGraphicApp,
|
||||
IGraphicScene,
|
||||
IGraphicStorage,
|
||||
IJlCanvas,
|
||||
IGridBackground
|
||||
} from './JlGraphicApp';
|
||||
import { GraphicDataUpdateOperation } from './BasicOperation';
|
||||
|
||||
/**
|
||||
* 实例化图形app
|
||||
* @param options
|
||||
* @returns
|
||||
*/
|
||||
export function newGraphicApp(options: GraphicAppOptions): IGraphicApp {
|
||||
return new GraphicApp(options);
|
||||
}
|
||||
|
||||
/**
|
||||
* 实例化绘图app
|
||||
* @param options
|
||||
* @returns
|
||||
*/
|
||||
export function newDrawApp(options: DrawAppOptions): IDrawApp {
|
||||
return new JlDrawApp(options);
|
||||
}
|
||||
|
||||
export { AppConsts, GraphicDrawAssistant, GraphicDataUpdateOperation };
|
||||
export type {
|
||||
DrawAssistant,
|
||||
ICanvasProperties,
|
||||
IDrawApp,
|
||||
IGraphicApp,
|
||||
IGraphicScene,
|
||||
IGraphicStorage,
|
||||
IJlCanvas,
|
||||
IGridBackground
|
||||
};
|
15
src/assets/quasar-logo-vertical.svg
Normal file
15
src/assets/quasar-logo-vertical.svg
Normal file
@ -0,0 +1,15 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 356 360">
|
||||
<path
|
||||
d="M43.4 303.4c0 3.8-2.3 6.3-7.1 6.3h-15v-22h14.4c4.3 0 6.2 2.2 6.2 5.2 0 2.6-1.5 4.4-3.4 5 2.8.4 4.9 2.5 4.9 5.5zm-8-13H24.1v6.9H35c2.1 0 4-1.3 4-3.8 0-2.2-1.3-3.1-3.7-3.1zm5.1 12.6c0-2.3-1.8-3.7-4-3.7H24.2v7.7h11.7c3.4 0 4.6-1.8 4.6-4zm36.3 4v2.7H56v-22h20.6v2.7H58.9v6.8h14.6v2.3H58.9v7.5h17.9zm23-5.8v8.5H97v-8.5l-11-13.4h3.4l8.9 11 8.8-11h3.4l-10.8 13.4zm19.1-1.8V298c0-7.9 5.2-10.7 12.7-10.7 7.5 0 13 2.8 13 10.7v1.4c0 7.9-5.5 10.8-13 10.8s-12.7-3-12.7-10.8zm22.7 0V298c0-5.7-3.9-8-10-8-6 0-9.8 2.3-9.8 8v1.4c0 5.8 3.8 8.1 9.8 8.1 6 0 10-2.3 10-8.1zm37.2-11.6v21.9h-2.9l-15.8-17.9v17.9h-2.8v-22h3l15.6 18v-18h2.9zm37.9 10.2v1.3c0 7.8-5.2 10.4-12.4 10.4H193v-22h11.2c7.2 0 12.4 2.8 12.4 10.3zm-3 0c0-5.3-3.3-7.6-9.4-7.6h-8.4V307h8.4c6 0 9.5-2 9.5-7.7V298zm50.8-7.6h-9.7v19.3h-3v-19.3h-9.7v-2.6h22.4v2.6zm34.4-2.6v21.9h-3v-10.1h-16.8v10h-2.8v-21.8h2.8v9.2H296v-9.2h2.9zm34.9 19.2v2.7h-20.7v-22h20.6v2.7H316v6.8h14.5v2.3H316v7.5h17.8zM24 340.2v7.3h13.9v2.4h-14v9.6H21v-22h20v2.7H24zm41.5 11.4h-9.8v7.9H53v-22h13.3c5.1 0 8 1.9 8 6.8 0 3.7-2 6.3-5.6 7l6 8.2h-3.3l-5.8-8zm-9.8-2.6H66c3.1 0 5.3-1.5 5.3-4.7 0-3.3-2.2-4.1-5.3-4.1H55.7v8.8zm47.9 6.2H89l-2 4.3h-3.2l10.7-22.2H98l10.7 22.2h-3.2l-2-4.3zm-1-2.3l-6.3-13-6 13h12.2zm46.3-15.3v21.9H146v-17.2L135.7 358h-2.1l-10.2-15.6v17h-2.8v-21.8h3l11 16.9 11.3-17h3zm35 19.3v2.6h-20.7v-22h20.6v2.7H166v6.8h14.5v2.3H166v7.6h17.8zm47-19.3l-8.3 22h-3l-7.1-18.6-7 18.6h-3l-8.2-22h3.3L204 356l6.8-18.5h3.4L221 356l6.6-18.5h3.3zm10 11.6v-1.4c0-7.8 5.2-10.7 12.7-10.7 7.6 0 13 2.9 13 10.7v1.4c0 7.9-5.4 10.8-13 10.8-7.5 0-12.7-3-12.7-10.8zm22.8 0v-1.4c0-5.7-4-8-10-8s-9.9 2.3-9.9 8v1.4c0 5.8 3.8 8.2 9.8 8.2 6.1 0 10-2.4 10-8.2zm28.3 2.4h-9.8v7.9h-2.8v-22h13.2c5.2 0 8 1.9 8 6.8 0 3.7-2 6.3-5.6 7l6 8.2h-3.3l-5.8-8zm-9.8-2.6h10.2c3 0 5.2-1.5 5.2-4.7 0-3.3-2.1-4.1-5.2-4.1h-10.2v8.8zm40.3-1.5l-6.8 5.6v6.4h-2.9v-22h2.9v12.3l15.2-12.2h3.7l-9.9 8.1 10.3 13.8h-3.6l-8.9-12z" />
|
||||
<path fill="#050A14"
|
||||
d="M188.4 71.7a10.4 10.4 0 01-20.8 0 10.4 10.4 0 1120.8 0zM224.2 45c-2.2-3.9-5-7.5-8.2-10.7l-12 7c-3.7-3.2-8-5.7-12.6-7.3a49.4 49.4 0 00-9.7 13.9 59 59 0 0140.1 14l7.6-4.4a57 57 0 00-5.2-12.5zM178 125.1c4.5 0 9-.6 13.4-1.7v-14a40 40 0 0012.5-7.2 47.7 47.7 0 00-7.1-15.3 59 59 0 01-32.2 27.7v8.7c4.4 1.2 8.9 1.8 13.4 1.8zM131.8 45c-2.3 4-4 8.1-5.2 12.5l12 7a40 40 0 000 14.4c5.7 1.5 11.3 2 16.9 1.5a59 59 0 01-8-41.7l-7.5-4.3c-3.2 3.2-6 6.7-8.2 10.6z" />
|
||||
<path fill="#00B4FF"
|
||||
d="M224.2 98.4c2.3-3.9 4-8 5.2-12.4l-12-7a40 40 0 000-14.5c-5.7-1.5-11.3-2-16.9-1.5a59 59 0 018 41.7l7.5 4.4c3.2-3.2 6-6.8 8.2-10.7zm-92.4 0c2.2 4 5 7.5 8.2 10.7l12-7a40 40 0 0012.6 7.3c4-4.1 7.3-8.8 9.7-13.8a59 59 0 01-40-14l-7.7 4.4c1.2 4.3 3 8.5 5.2 12.4zm46.2-80c-4.5 0-9 .5-13.4 1.7V34a40 40 0 00-12.5 7.2c1.5 5.7 4 10.8 7.1 15.4a59 59 0 0132.2-27.7V20a53.3 53.3 0 00-13.4-1.8z" />
|
||||
<path fill="#00B4FF"
|
||||
d="M178 9.2a62.6 62.6 0 11-.1 125.2A62.6 62.6 0 01178 9.2m0-9.2a71.7 71.7 0 100 143.5A71.7 71.7 0 00178 0z" />
|
||||
<path fill="#050A14"
|
||||
d="M96.6 212v4.3c-9.2-.8-15.4-5.8-15.4-17.8V180h4.6v18.4c0 8.6 4 12.6 10.8 13.5zm16-31.9v18.4c0 8.9-4.3 12.8-10.9 13.5v4.4c9.2-.7 15.5-5.6 15.5-18v-18.3h-4.7zM62.2 199v-2.2c0-12.7-8.8-17.4-21-17.4-12.1 0-20.7 4.7-20.7 17.4v2.2c0 12.8 8.6 17.6 20.7 17.6 1.5 0 3-.1 4.4-.3l11.8 6.2 2-3.3-8.2-4-6.4-3.1a32 32 0 01-3.6.2c-9.8 0-16-3.9-16-13.3v-2.2c0-9.3 6.2-13.1 16-13.1 9.9 0 16.3 3.8 16.3 13.1v2.2c0 5.3-2.1 8.7-5.6 10.8l4.8 2.4c3.4-2.8 5.5-7 5.5-13.2zM168 215.6h5.1L156 179.7h-4.8l17 36zM143 205l7.4-15.7-2.4-5-15.1 31.4h5.1l3.3-7h18.3l-1.8-3.7H143zm133.7 10.7h5.2l-17.3-35.9h-4.8l17 36zm-25-10.7l7.4-15.7-2.4-5-15.1 31.4h5.1l3.3-7h18.3l-1.7-3.7h-14.8zm73.8-2.5c6-1.2 9-5.4 9-11.4 0-8-4.5-10.9-12.9-10.9h-21.4v35.5h4.6v-31.3h16.5c5 0 8.5 1.4 8.5 6.7 0 5.2-3.5 7.7-8.5 7.7h-11.4v4.1h10.7l9.3 12.8h5.5l-9.9-13.2zm-117.4 9.9c-9.7 0-14.7-2.5-18.6-6.3l-2.2 3.8c5.1 5 11 6.7 21 6.7 1.6 0 3.1-.1 4.6-.3l-1.9-4h-3zm18.4-7c0-6.4-4.7-8.6-13.8-9.4l-10.1-1c-6.7-.7-9.3-2.2-9.3-5.6 0-2.5 1.4-4 4.6-5l-1.8-3.8c-4.7 1.4-7.5 4.2-7.5 8.9 0 5.2 3.4 8.7 13 9.6l11.3 1.2c6.4.6 8.9 2 8.9 5.4 0 2.7-2.1 4.7-6 5.8l1.8 3.9c5.3-1.6 8.9-4.7 8.9-10zm-20.3-21.9c7.9 0 13.3 1.8 18.1 5.7l1.8-3.9a30 30 0 00-19.6-5.9c-2 0-4 .1-5.7.3l1.9 4 3.5-.2z" />
|
||||
<path fill="#00B4FF"
|
||||
d="M.5 251.9c29.6-.5 59.2-.8 88.8-1l88.7-.3 88.7.3 44.4.4 44.4.6-44.4.6-44.4.4-88.7.3-88.7-.3a7981 7981 0 01-88.8-1z" />
|
||||
<path fill="none" d="M-565.2 324H-252v15.8h-313.2z" />
|
||||
</svg>
|
After Width: | Height: | Size: 4.4 KiB |
0
src/boot/.gitkeep
Normal file
0
src/boot/.gitkeep
Normal file
34
src/components/EssentialLink.vue
Normal file
34
src/components/EssentialLink.vue
Normal file
@ -0,0 +1,34 @@
|
||||
<template>
|
||||
<q-item
|
||||
clickable
|
||||
tag="a"
|
||||
target="_blank"
|
||||
:href="link"
|
||||
>
|
||||
<q-item-section
|
||||
v-if="icon"
|
||||
avatar
|
||||
>
|
||||
<q-icon :name="icon" />
|
||||
</q-item-section>
|
||||
|
||||
<q-item-section>
|
||||
<q-item-label>{{ title }}</q-item-label>
|
||||
<q-item-label caption>{{ caption }}</q-item-label>
|
||||
</q-item-section>
|
||||
</q-item>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
export interface EssentialLinkProps {
|
||||
title: string;
|
||||
caption?: string;
|
||||
link?: string;
|
||||
icon?: string;
|
||||
}
|
||||
withDefaults(defineProps<EssentialLinkProps>(), {
|
||||
caption: '',
|
||||
link: '#',
|
||||
icon: '',
|
||||
});
|
||||
</script>
|
37
src/components/ExampleComponent.vue
Normal file
37
src/components/ExampleComponent.vue
Normal file
@ -0,0 +1,37 @@
|
||||
<template>
|
||||
<div>
|
||||
<p>{{ title }}</p>
|
||||
<ul>
|
||||
<li v-for="todo in todos" :key="todo.id" @click="increment">
|
||||
{{ todo.id }} - {{ todo.content }}
|
||||
</li>
|
||||
</ul>
|
||||
<p>Count: {{ todoCount }} / {{ meta.totalCount }}</p>
|
||||
<p>Active: {{ active ? 'yes' : 'no' }}</p>
|
||||
<p>Clicks on todos: {{ clickCount }}</p>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import { computed, ref } from 'vue';
|
||||
import { Todo, Meta } from './models';
|
||||
|
||||
interface Props {
|
||||
title: string;
|
||||
todos?: Todo[];
|
||||
meta: Meta;
|
||||
active: boolean;
|
||||
}
|
||||
const props = withDefaults(defineProps<Props>(), {
|
||||
todos: () => [],
|
||||
});
|
||||
|
||||
const clickCount = ref(0);
|
||||
function increment() {
|
||||
clickCount.value += 1;
|
||||
return clickCount.value;
|
||||
}
|
||||
|
||||
const todoCount = computed(() => props.todos.length);
|
||||
|
||||
</script>
|
61
src/components/draw-app/DrawProperties.vue
Normal file
61
src/components/draw-app/DrawProperties.vue
Normal file
@ -0,0 +1,61 @@
|
||||
<template>
|
||||
<!-- 绘制图形模板属性 -->
|
||||
<div v-if="drawStore.drawMode">
|
||||
<q-card flat>
|
||||
<q-card-section>
|
||||
<div class="text-h6">{{ drawStore.drawGraphicName + ' 模板' }}</div>
|
||||
</q-card-section>
|
||||
<q-separator inset></q-separator>
|
||||
<q-card-section>
|
||||
<template v-if="drawStore.drawGraphicType === Link.Type">
|
||||
<link-template></link-template>
|
||||
</template>
|
||||
<template v-if="drawStore.drawGraphicType === Platform.Type">
|
||||
<platform-template></platform-template>
|
||||
</template>
|
||||
</q-card-section>
|
||||
</q-card>
|
||||
</div>
|
||||
<!-- 画布或图形对象属性 -->
|
||||
<div v-else-if="drawStore.selectedGraphics !== null">
|
||||
<q-card flat>
|
||||
<q-card-section>
|
||||
<div class="text-h6">{{ drawStore.selectedObjName + ' 属性' }}</div>
|
||||
</q-card-section>
|
||||
<q-separator inset></q-separator>
|
||||
<template v-if="drawStore.selectedGraphics.length === 0">
|
||||
<q-card-section>
|
||||
<canvas-property></canvas-property>
|
||||
</q-card-section>
|
||||
</template>
|
||||
<template v-else-if="drawStore.selectedGraphics.length === 1">
|
||||
<q-card-section>
|
||||
<link-property
|
||||
v-if="drawStore.selectedGraphicType === Link.Type"
|
||||
></link-property>
|
||||
<platform-property
|
||||
v-if="drawStore.selectedGraphicType === Platform.Type"
|
||||
></platform-property>
|
||||
<iscs-fan-property
|
||||
v-else-if="drawStore.selectedGraphicType === IscsFan.Type"
|
||||
></iscs-fan-property>
|
||||
</q-card-section>
|
||||
</template>
|
||||
</q-card>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import LinkTemplate from './templates/LinkTemplate.vue';
|
||||
import PlatformTemplate from './templates/PlatformTemplate.vue';
|
||||
import CanvasProperty from './properties/CanvasProperty.vue';
|
||||
import LinkProperty from './properties/LinkProperty.vue';
|
||||
import PlatformProperty from './properties/PlatformProperty.vue';
|
||||
import IscsFanProperty from './properties/IscsFanProperty.vue';
|
||||
import { Link } from 'src/graphics/link/Link';
|
||||
import { Platform } from 'src/graphics/platform/Platform';
|
||||
import { useDrawStore } from 'src/stores/draw-store';
|
||||
import { IscsFan } from 'src/graphics/iscs-fan/IscsFan';
|
||||
|
||||
const drawStore = useDrawStore();
|
||||
</script>
|
80
src/components/draw-app/properties/CanvasProperty.vue
Normal file
80
src/components/draw-app/properties/CanvasProperty.vue
Normal file
@ -0,0 +1,80 @@
|
||||
<template>
|
||||
<q-form>
|
||||
<q-input
|
||||
outlined
|
||||
v-model.number="canvas.width"
|
||||
@blur="onUpdate"
|
||||
label="画布宽 *"
|
||||
lazy-rules
|
||||
:rules="[(val) => (val && val > 0) || '画布宽必须大于0']"
|
||||
/>
|
||||
|
||||
<q-input
|
||||
outlined
|
||||
type="number"
|
||||
v-model.number="canvas.height"
|
||||
@blur="onUpdate"
|
||||
label="画布高 *"
|
||||
lazy-rules
|
||||
:rules="[(val) => val > 0 || '画布高必须大于0']"
|
||||
/>
|
||||
|
||||
<q-input
|
||||
outlined
|
||||
v-model="canvas.backgroundColor"
|
||||
@blur="onUpdate"
|
||||
label="画布背景色 *"
|
||||
lazy-rules
|
||||
:rules="[(val) => (val && val.length > 0) || '画布背景色必须设置']"
|
||||
>
|
||||
<template v-slot:append>
|
||||
<q-icon name="colorize" class="cursor-pointer">
|
||||
<q-popup-proxy cover transition-show="scale" transition-hide="scale">
|
||||
<q-color
|
||||
:model-value="canvas.backgroundColor"
|
||||
@change="
|
||||
(val) => {
|
||||
canvas.backgroundColor = val;
|
||||
onUpdate();
|
||||
}
|
||||
"
|
||||
/>
|
||||
</q-popup-proxy>
|
||||
</q-icon>
|
||||
</template>
|
||||
</q-input>
|
||||
</q-form>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import { useDrawStore } from 'src/stores/draw-store';
|
||||
import { onMounted, onUnmounted, reactive } from 'vue';
|
||||
const drawStore = useDrawStore();
|
||||
|
||||
const canvas = reactive({
|
||||
width: 1920,
|
||||
height: 1080,
|
||||
backgroundColor: '#ffffff',
|
||||
});
|
||||
|
||||
onMounted(() => {
|
||||
console.log('画布属性表单mounted');
|
||||
const jc = drawStore.getJlCanvas();
|
||||
canvas.width = jc.properties.width;
|
||||
canvas.height = jc.properties.height;
|
||||
canvas.backgroundColor = jc.properties.backgroundColor;
|
||||
});
|
||||
|
||||
onUnmounted(() => {
|
||||
console.log('画布属性表单unmounted');
|
||||
});
|
||||
|
||||
function onUpdate() {
|
||||
console.log('画布属性更新');
|
||||
const app = drawStore.getDrawApp();
|
||||
app.updateCanvasAndRecord({
|
||||
...canvas,
|
||||
viewportTransform: app.canvas.properties.viewportTransform,
|
||||
});
|
||||
}
|
||||
</script>
|
42
src/components/draw-app/properties/IscsFanProperty.vue
Normal file
42
src/components/draw-app/properties/IscsFanProperty.vue
Normal file
@ -0,0 +1,42 @@
|
||||
<template>
|
||||
<q-form>
|
||||
<q-input outlined readonly v-model="model.id" label="id" :rules="[]" />
|
||||
</q-form>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import { IscsFanData } from 'src/examples/app/graphics/IscsFanInteraction';
|
||||
import { IscsFan } from 'src/graphics/iscs-fan/IscsFan';
|
||||
import { useDrawStore } from 'src/stores/draw-store';
|
||||
import { onMounted, reactive, watch } from 'vue';
|
||||
|
||||
const drawStore = useDrawStore();
|
||||
const model = reactive(new IscsFanData());
|
||||
|
||||
drawStore.$subscribe;
|
||||
watch(
|
||||
() => drawStore.selectedGraphic,
|
||||
(val) => {
|
||||
if (val && val.type == IscsFan.Type) {
|
||||
// console.log('Iscs风机变更');
|
||||
model.copyFrom(val.saveData() as IscsFanData);
|
||||
}
|
||||
}
|
||||
);
|
||||
|
||||
onMounted(() => {
|
||||
// console.log('Iscs风机 属性表单 mounted');
|
||||
const g = drawStore.selectedGraphic as IscsFan;
|
||||
if (g) {
|
||||
model.copyFrom(g.saveData());
|
||||
}
|
||||
});
|
||||
|
||||
function onUpdate() {
|
||||
console.log('Iscs风机 属性更新');
|
||||
const g = drawStore.selectedGraphic as IscsFan;
|
||||
if (g) {
|
||||
drawStore.getDrawApp().updateGraphicAndRecord(g, model);
|
||||
}
|
||||
}
|
||||
</script>
|
96
src/components/draw-app/properties/LinkProperty.vue
Normal file
96
src/components/draw-app/properties/LinkProperty.vue
Normal file
@ -0,0 +1,96 @@
|
||||
<template>
|
||||
<q-form>
|
||||
<q-input outlined readonly v-model="linkModel.id" label="id" hint="" />
|
||||
<q-input
|
||||
outlined
|
||||
v-model.number="linkModel.lineWidth"
|
||||
type="number"
|
||||
@blur="onUpdate"
|
||||
label="线宽"
|
||||
lazy-rules
|
||||
:rules="[(val) => (val && val > 0) || '画布宽必须大于0']"
|
||||
/>
|
||||
|
||||
<q-input
|
||||
outlined
|
||||
v-model="linkModel.lineColor"
|
||||
@blur="onUpdate"
|
||||
label="线色"
|
||||
lazy-rules
|
||||
:rules="[(val) => (val && val.length > 0) || '线色不能为空']"
|
||||
>
|
||||
<template v-slot:append>
|
||||
<q-icon name="colorize" class="cursor-pointer">
|
||||
<q-popup-proxy cover transition-show="scale" transition-hide="scale">
|
||||
<q-color
|
||||
v-model="linkModel.lineColor"
|
||||
@change="
|
||||
(val) => {
|
||||
linkModel.lineColor = val;
|
||||
onUpdate();
|
||||
}
|
||||
"
|
||||
/>
|
||||
</q-popup-proxy>
|
||||
</q-icon>
|
||||
</template>
|
||||
</q-input>
|
||||
|
||||
<!-- <q-btn-toggle
|
||||
disable
|
||||
v-model="linkModel.curve"
|
||||
:options="[
|
||||
{ label: '直线', value: false },
|
||||
{ label: '曲线', value: true },
|
||||
]"
|
||||
/> -->
|
||||
|
||||
<q-input
|
||||
v-if="linkModel.curve"
|
||||
outlined
|
||||
v-model.number="linkModel.segmentsCount"
|
||||
type="number"
|
||||
@blur="onUpdate"
|
||||
label="曲线分段数量"
|
||||
lazy-rules
|
||||
:rules="[(val) => (val && val > 0) || '曲线分段数量必须大于0']"
|
||||
/>
|
||||
</q-form>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import { LinkData } from 'src/examples/app/graphics/LinkInteraction';
|
||||
import { Link } from 'src/graphics/link/Link';
|
||||
import { useDrawStore } from 'src/stores/draw-store';
|
||||
import { onMounted, reactive, watch } from 'vue';
|
||||
|
||||
const drawStore = useDrawStore();
|
||||
const linkModel = reactive(new LinkData());
|
||||
|
||||
drawStore.$subscribe;
|
||||
watch(
|
||||
() => drawStore.selectedGraphic,
|
||||
(val) => {
|
||||
if (val && val.type == Link.Type) {
|
||||
// console.log('link变更');
|
||||
linkModel.copyFrom(val.saveData() as LinkData);
|
||||
}
|
||||
}
|
||||
);
|
||||
|
||||
onMounted(() => {
|
||||
// console.log('link 属性表单 mounted');
|
||||
const link = drawStore.selectedGraphic as Link;
|
||||
if (link) {
|
||||
linkModel.copyFrom(link.saveData());
|
||||
}
|
||||
});
|
||||
|
||||
function onUpdate() {
|
||||
console.log('link 属性更新');
|
||||
const link = drawStore.selectedGraphic as Link;
|
||||
if (link) {
|
||||
drawStore.getDrawApp().updateGraphicAndRecord(link, linkModel);
|
||||
}
|
||||
}
|
||||
</script>
|
85
src/components/draw-app/properties/PlatformProperty.vue
Normal file
85
src/components/draw-app/properties/PlatformProperty.vue
Normal file
@ -0,0 +1,85 @@
|
||||
<template>
|
||||
<q-form>
|
||||
<q-input outlined readonly v-model="stationModel.id" label="id" hint="" />
|
||||
<q-input
|
||||
outlined
|
||||
v-model.number="stationModel.lineWidth"
|
||||
type="number"
|
||||
@blur="onUpdate"
|
||||
label="线宽"
|
||||
lazy-rules
|
||||
:rules="[(val) => (val && val > 0) || '画布宽必须大于0']"
|
||||
/>
|
||||
|
||||
<q-input
|
||||
outlined
|
||||
v-model="stationModel.lineColor"
|
||||
@blur="onUpdate"
|
||||
label="线色"
|
||||
lazy-rules
|
||||
:rules="[(val) => (val && val.length > 0) || '线色不能为空']"
|
||||
>
|
||||
<template v-slot:append>
|
||||
<q-icon name="colorize" class="cursor-pointer">
|
||||
<q-popup-proxy cover transition-show="scale" transition-hide="scale">
|
||||
<q-color
|
||||
v-model="stationModel.lineColor"
|
||||
@change="
|
||||
(val) => {
|
||||
stationModel.lineColor = val;
|
||||
onUpdate();
|
||||
}
|
||||
"
|
||||
/>
|
||||
</q-popup-proxy>
|
||||
</q-icon>
|
||||
</template>
|
||||
</q-input>
|
||||
|
||||
<q-select
|
||||
outlined
|
||||
v-model="stationModel.hasdoor"
|
||||
:options="options"
|
||||
label="是否有屏蔽门"
|
||||
/>
|
||||
</q-form>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import { PlatformData } from 'src/examples/app/graphics/PlatformInteraction';
|
||||
import { Platform } from 'src/graphics/platform/Platform';
|
||||
import { useDrawStore } from 'src/stores/draw-store';
|
||||
import { onMounted, reactive, watch } from 'vue';
|
||||
|
||||
const drawStore = useDrawStore();
|
||||
const stationModel = reactive(new PlatformData());
|
||||
const options = [true, false];
|
||||
|
||||
drawStore.$subscribe;
|
||||
watch(
|
||||
() => drawStore.selectedGraphic,
|
||||
(val) => {
|
||||
if (val && val.type == Platform.Type) {
|
||||
// console.log('station变更');
|
||||
stationModel.copyFrom(val.saveData() as PlatformData);
|
||||
}
|
||||
}
|
||||
);
|
||||
|
||||
onMounted(() => {
|
||||
//console.log('station 属性表单 mounted');
|
||||
const station = drawStore.selectedGraphic as Platform;
|
||||
|
||||
if (station) {
|
||||
stationModel.copyFrom(station.saveData());
|
||||
}
|
||||
});
|
||||
|
||||
function onUpdate() {
|
||||
//console.log(stationModel, 'station 属性更新');
|
||||
const station = drawStore.selectedGraphic as Platform;
|
||||
if (station) {
|
||||
drawStore.getDrawApp().updateGraphicAndRecord(station, stationModel);
|
||||
}
|
||||
}
|
||||
</script>
|
96
src/components/draw-app/templates/LinkTemplate.vue
Normal file
96
src/components/draw-app/templates/LinkTemplate.vue
Normal file
@ -0,0 +1,96 @@
|
||||
<template>
|
||||
<q-form>
|
||||
<q-input
|
||||
outlined
|
||||
v-model.number="template.lineWidth"
|
||||
type="number"
|
||||
@blur="onUpdate"
|
||||
label="线宽 *"
|
||||
lazy-rules
|
||||
:rules="[(val) => (val && val > 0) || '线宽必须大于0']"
|
||||
/>
|
||||
|
||||
<q-input
|
||||
outlined
|
||||
v-model="template.lineColor"
|
||||
@blur="onUpdate"
|
||||
label="线色 *"
|
||||
lazy-rules
|
||||
:rules="[(val) => (val && val.length > 0) || '线色不能为空']"
|
||||
>
|
||||
<template v-slot:append>
|
||||
<q-icon name="colorize" class="cursor-pointer">
|
||||
<q-popup-proxy cover transition-show="scale" transition-hide="scale">
|
||||
<q-color
|
||||
v-model="template.lineColor"
|
||||
@change="
|
||||
(val) => {
|
||||
template.lineColor = val;
|
||||
onUpdate();
|
||||
}
|
||||
"
|
||||
/>
|
||||
</q-popup-proxy>
|
||||
</q-icon>
|
||||
</template>
|
||||
</q-input>
|
||||
|
||||
<q-btn-toggle
|
||||
v-model="template.curve"
|
||||
@update:model-value="onUpdate"
|
||||
:options="[
|
||||
{ label: '直线', value: false },
|
||||
{ label: '曲线', value: true },
|
||||
]"
|
||||
/>
|
||||
|
||||
<q-input
|
||||
v-if="template.curve"
|
||||
outlined
|
||||
v-model.number="template.segmentsCount"
|
||||
type="number"
|
||||
@blur="onUpdate"
|
||||
label="曲线分段数量 *"
|
||||
lazy-rules
|
||||
:rules="[(val) => (val && val > 0) || '曲线分段数量必须大于0']"
|
||||
/>
|
||||
</q-form>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import { LinkTemplate } from 'src/graphics/link/Link';
|
||||
import { useDrawStore } from 'src/stores/draw-store';
|
||||
import { onMounted, reactive } from 'vue';
|
||||
|
||||
const drawStore = useDrawStore();
|
||||
const template = reactive({
|
||||
lineWidth: 1,
|
||||
lineColor: '#0000ff',
|
||||
curve: false,
|
||||
segmentsCount: 10,
|
||||
});
|
||||
|
||||
onMounted(() => {
|
||||
const type = drawStore.drawGraphicType;
|
||||
if (type) {
|
||||
const gt = drawStore.drawGraphicTemplate;
|
||||
if (gt) {
|
||||
const lt = gt as LinkTemplate;
|
||||
template.lineWidth = lt.lineWidth;
|
||||
template.lineColor = lt.lineColor;
|
||||
template.curve = lt.curve;
|
||||
template.segmentsCount = lt.segmentsCount;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
function onUpdate() {
|
||||
const gt = drawStore.drawGraphicTemplate as LinkTemplate;
|
||||
if (gt) {
|
||||
gt.lineWidth = template.lineWidth;
|
||||
gt.lineColor = template.lineColor;
|
||||
gt.curve = template.curve;
|
||||
gt.segmentsCount = template.segmentsCount;
|
||||
}
|
||||
}
|
||||
</script>
|
76
src/components/draw-app/templates/PlatformTemplate.vue
Normal file
76
src/components/draw-app/templates/PlatformTemplate.vue
Normal file
@ -0,0 +1,76 @@
|
||||
<template>
|
||||
<q-form>
|
||||
<q-input
|
||||
outlined
|
||||
v-model.number="template.lineWidth"
|
||||
type="number"
|
||||
@blur="onUpdate"
|
||||
label="线宽 *"
|
||||
lazy-rules
|
||||
:rules="[(val) => (val && val > 0) || '线宽必须大于0']"
|
||||
/>
|
||||
|
||||
<q-input
|
||||
outlined
|
||||
v-model="template.lineColor"
|
||||
@blur="onUpdate"
|
||||
label="线色 *"
|
||||
lazy-rules
|
||||
:rules="[(val) => (val && val.length > 0) || '线色不能为空']"
|
||||
>
|
||||
<template v-slot:append>
|
||||
<q-icon name="colorize" class="cursor-pointer">
|
||||
<q-popup-proxy cover transition-show="scale" transition-hide="scale">
|
||||
<q-color
|
||||
v-model="template.lineColor"
|
||||
@change="
|
||||
(val) => {
|
||||
template.lineColor = val;
|
||||
onUpdate();
|
||||
}
|
||||
"
|
||||
/>
|
||||
</q-popup-proxy>
|
||||
</q-icon>
|
||||
</template>
|
||||
</q-input>
|
||||
</q-form>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import { LinkTemplate } from 'src/graphics/link/Link';
|
||||
import { useDrawStore } from 'src/stores/draw-store';
|
||||
import { onMounted, reactive } from 'vue';
|
||||
|
||||
const drawStore = useDrawStore();
|
||||
const template = reactive({
|
||||
lineWidth: 1,
|
||||
lineColor: '#0000ff',
|
||||
curve: false,
|
||||
segmentsCount: 10,
|
||||
});
|
||||
|
||||
onMounted(() => {
|
||||
const type = drawStore.drawGraphicType;
|
||||
if (type) {
|
||||
const gt = drawStore.drawGraphicTemplate;
|
||||
if (gt) {
|
||||
const lt = gt as LinkTemplate;
|
||||
template.lineWidth = lt.lineWidth;
|
||||
template.lineColor = lt.lineColor;
|
||||
template.curve = lt.curve;
|
||||
template.segmentsCount = lt.segmentsCount;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
function onUpdate() {
|
||||
const gt = drawStore.drawGraphicTemplate as LinkTemplate;
|
||||
if (gt) {
|
||||
gt.lineWidth = template.lineWidth;
|
||||
gt.lineColor = template.lineColor;
|
||||
gt.curve = template.curve;
|
||||
gt.segmentsCount = template.segmentsCount;
|
||||
}
|
||||
}
|
||||
</script>
|
8
src/components/models.ts
Normal file
8
src/components/models.ts
Normal file
@ -0,0 +1,8 @@
|
||||
export interface Todo {
|
||||
id: number;
|
||||
content: string;
|
||||
}
|
||||
|
||||
export interface Meta {
|
||||
totalCount: number;
|
||||
}
|
1
src/css/app.scss
Normal file
1
src/css/app.scss
Normal file
@ -0,0 +1 @@
|
||||
// app global css in SCSS form
|
25
src/css/quasar.variables.scss
Normal file
25
src/css/quasar.variables.scss
Normal file
@ -0,0 +1,25 @@
|
||||
// Quasar SCSS (& Sass) Variables
|
||||
// --------------------------------------------------
|
||||
// To customize the look and feel of this app, you can override
|
||||
// the Sass/SCSS variables found in Quasar's source Sass/SCSS files.
|
||||
|
||||
// Check documentation for full list of Quasar variables
|
||||
|
||||
// Your own variables (that are declared here) and Quasar's own
|
||||
// ones will be available out of the box in your .vue/.scss/.sass files
|
||||
|
||||
// It's highly recommended to change the default colors
|
||||
// to match your app's branding.
|
||||
// Tip: Use the "Theme Builder" on Quasar's documentation website.
|
||||
|
||||
$primary : #1976D2;
|
||||
$secondary : #26A69A;
|
||||
$accent : #9C27B0;
|
||||
|
||||
$dark : #1D1D1D;
|
||||
$dark-page : #121212;
|
||||
|
||||
$positive : #21BA45;
|
||||
$negative : #C10015;
|
||||
$info : #31CCEC;
|
||||
$warning : #F2C037;
|
9
src/env.d.ts
vendored
Normal file
9
src/env.d.ts
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
/* eslint-disable */
|
||||
|
||||
declare namespace NodeJS {
|
||||
interface ProcessEnv {
|
||||
NODE_ENV: string;
|
||||
VUE_ROUTER_MODE: 'hash' | 'history' | 'abstract' | undefined;
|
||||
VUE_ROUTER_BASE: string | undefined;
|
||||
}
|
||||
}
|
BIN
src/examples/app/app_message/protoc-22.2/bin/linux-x86_64/protoc
Executable file
BIN
src/examples/app/app_message/protoc-22.2/bin/linux-x86_64/protoc
Executable file
Binary file not shown.
BIN
src/examples/app/app_message/protoc-22.2/bin/win64/protoc.exe
Normal file
BIN
src/examples/app/app_message/protoc-22.2/bin/win64/protoc.exe
Normal file
Binary file not shown.
@ -0,0 +1,161 @@
|
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2008 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
syntax = "proto3";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
option go_package = "google.golang.org/protobuf/types/known/anypb";
|
||||
option java_package = "com.google.protobuf";
|
||||
option java_outer_classname = "AnyProto";
|
||||
option java_multiple_files = true;
|
||||
option objc_class_prefix = "GPB";
|
||||
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||
|
||||
// `Any` contains an arbitrary serialized protocol buffer message along with a
|
||||
// URL that describes the type of the serialized message.
|
||||
//
|
||||
// Protobuf library provides support to pack/unpack Any values in the form
|
||||
// of utility functions or additional generated methods of the Any type.
|
||||
//
|
||||
// Example 1: Pack and unpack a message in C++.
|
||||
//
|
||||
// Foo foo = ...;
|
||||
// Any any;
|
||||
// any.PackFrom(foo);
|
||||
// ...
|
||||
// if (any.UnpackTo(&foo)) {
|
||||
// ...
|
||||
// }
|
||||
//
|
||||
// Example 2: Pack and unpack a message in Java.
|
||||
//
|
||||
// Foo foo = ...;
|
||||
// Any any = Any.pack(foo);
|
||||
// ...
|
||||
// if (any.is(Foo.class)) {
|
||||
// foo = any.unpack(Foo.class);
|
||||
// }
|
||||
// // or ...
|
||||
// if (any.isSameTypeAs(Foo.getDefaultInstance())) {
|
||||
// foo = any.unpack(Foo.getDefaultInstance());
|
||||
// }
|
||||
//
|
||||
// Example 3: Pack and unpack a message in Python.
|
||||
//
|
||||
// foo = Foo(...)
|
||||
// any = Any()
|
||||
// any.Pack(foo)
|
||||
// ...
|
||||
// if any.Is(Foo.DESCRIPTOR):
|
||||
// any.Unpack(foo)
|
||||
// ...
|
||||
//
|
||||
// Example 4: Pack and unpack a message in Go
|
||||
//
|
||||
// foo := &pb.Foo{...}
|
||||
// any, err := anypb.New(foo)
|
||||
// if err != nil {
|
||||
// ...
|
||||
// }
|
||||
// ...
|
||||
// foo := &pb.Foo{}
|
||||
// if err := any.UnmarshalTo(foo); err != nil {
|
||||
// ...
|
||||
// }
|
||||
//
|
||||
// The pack methods provided by protobuf library will by default use
|
||||
// 'type.googleapis.com/full.type.name' as the type URL and the unpack
|
||||
// methods only use the fully qualified type name after the last '/'
|
||||
// in the type URL, for example "foo.bar.com/x/y.z" will yield type
|
||||
// name "y.z".
|
||||
//
|
||||
// JSON
|
||||
//
|
||||
// The JSON representation of an `Any` value uses the regular
|
||||
// representation of the deserialized, embedded message, with an
|
||||
// additional field `@type` which contains the type URL. Example:
|
||||
//
|
||||
// package google.profile;
|
||||
// message Person {
|
||||
// string first_name = 1;
|
||||
// string last_name = 2;
|
||||
// }
|
||||
//
|
||||
// {
|
||||
// "@type": "type.googleapis.com/google.profile.Person",
|
||||
// "firstName": <string>,
|
||||
// "lastName": <string>
|
||||
// }
|
||||
//
|
||||
// If the embedded message type is well-known and has a custom JSON
|
||||
// representation, that representation will be embedded adding a field
|
||||
// `value` which holds the custom JSON in addition to the `@type`
|
||||
// field. Example (for message [google.protobuf.Duration][]):
|
||||
//
|
||||
// {
|
||||
// "@type": "type.googleapis.com/google.protobuf.Duration",
|
||||
// "value": "1.212s"
|
||||
// }
|
||||
//
|
||||
message Any {
|
||||
// A URL/resource name that uniquely identifies the type of the serialized
|
||||
// protocol buffer message. This string must contain at least
|
||||
// one "/" character. The last segment of the URL's path must represent
|
||||
// the fully qualified name of the type (as in
|
||||
// `path/google.protobuf.Duration`). The name should be in a canonical form
|
||||
// (e.g., leading "." is not accepted).
|
||||
//
|
||||
// In practice, teams usually precompile into the binary all types that they
|
||||
// expect it to use in the context of Any. However, for URLs which use the
|
||||
// scheme `http`, `https`, or no scheme, one can optionally set up a type
|
||||
// server that maps type URLs to message definitions as follows:
|
||||
//
|
||||
// * If no scheme is provided, `https` is assumed.
|
||||
// * An HTTP GET on the URL must yield a [google.protobuf.Type][]
|
||||
// value in binary format, or produce an error.
|
||||
// * Applications are allowed to cache lookup results based on the
|
||||
// URL, or have them precompiled into a binary to avoid any
|
||||
// lookup. Therefore, binary compatibility needs to be preserved
|
||||
// on changes to types. (Use versioned type names to manage
|
||||
// breaking changes.)
|
||||
//
|
||||
// Note: this functionality is not currently available in the official
|
||||
// protobuf release, and it is not used for type URLs beginning with
|
||||
// type.googleapis.com.
|
||||
//
|
||||
// Schemes other than `http`, `https` (or the empty scheme) might be
|
||||
// used with implementation specific semantics.
|
||||
//
|
||||
string type_url = 1;
|
||||
|
||||
// Must be a valid serialized protocol buffer of the above specified type.
|
||||
bytes value = 2;
|
||||
}
|
@ -0,0 +1,207 @@
|
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2008 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
syntax = "proto3";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
import "google/protobuf/source_context.proto";
|
||||
import "google/protobuf/type.proto";
|
||||
|
||||
option java_package = "com.google.protobuf";
|
||||
option java_outer_classname = "ApiProto";
|
||||
option java_multiple_files = true;
|
||||
option objc_class_prefix = "GPB";
|
||||
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||
option go_package = "google.golang.org/protobuf/types/known/apipb";
|
||||
|
||||
// Api is a light-weight descriptor for an API Interface.
|
||||
//
|
||||
// Interfaces are also described as "protocol buffer services" in some contexts,
|
||||
// such as by the "service" keyword in a .proto file, but they are different
|
||||
// from API Services, which represent a concrete implementation of an interface
|
||||
// as opposed to simply a description of methods and bindings. They are also
|
||||
// sometimes simply referred to as "APIs" in other contexts, such as the name of
|
||||
// this message itself. See https://cloud.google.com/apis/design/glossary for
|
||||
// detailed terminology.
|
||||
message Api {
|
||||
// The fully qualified name of this interface, including package name
|
||||
// followed by the interface's simple name.
|
||||
string name = 1;
|
||||
|
||||
// The methods of this interface, in unspecified order.
|
||||
repeated Method methods = 2;
|
||||
|
||||
// Any metadata attached to the interface.
|
||||
repeated Option options = 3;
|
||||
|
||||
// A version string for this interface. If specified, must have the form
|
||||
// `major-version.minor-version`, as in `1.10`. If the minor version is
|
||||
// omitted, it defaults to zero. If the entire version field is empty, the
|
||||
// major version is derived from the package name, as outlined below. If the
|
||||
// field is not empty, the version in the package name will be verified to be
|
||||
// consistent with what is provided here.
|
||||
//
|
||||
// The versioning schema uses [semantic
|
||||
// versioning](http://semver.org) where the major version number
|
||||
// indicates a breaking change and the minor version an additive,
|
||||
// non-breaking change. Both version numbers are signals to users
|
||||
// what to expect from different versions, and should be carefully
|
||||
// chosen based on the product plan.
|
||||
//
|
||||
// The major version is also reflected in the package name of the
|
||||
// interface, which must end in `v<major-version>`, as in
|
||||
// `google.feature.v1`. For major versions 0 and 1, the suffix can
|
||||
// be omitted. Zero major versions must only be used for
|
||||
// experimental, non-GA interfaces.
|
||||
//
|
||||
string version = 4;
|
||||
|
||||
// Source context for the protocol buffer service represented by this
|
||||
// message.
|
||||
SourceContext source_context = 5;
|
||||
|
||||
// Included interfaces. See [Mixin][].
|
||||
repeated Mixin mixins = 6;
|
||||
|
||||
// The source syntax of the service.
|
||||
Syntax syntax = 7;
|
||||
}
|
||||
|
||||
// Method represents a method of an API interface.
|
||||
message Method {
|
||||
// The simple name of this method.
|
||||
string name = 1;
|
||||
|
||||
// A URL of the input message type.
|
||||
string request_type_url = 2;
|
||||
|
||||
// If true, the request is streamed.
|
||||
bool request_streaming = 3;
|
||||
|
||||
// The URL of the output message type.
|
||||
string response_type_url = 4;
|
||||
|
||||
// If true, the response is streamed.
|
||||
bool response_streaming = 5;
|
||||
|
||||
// Any metadata attached to the method.
|
||||
repeated Option options = 6;
|
||||
|
||||
// The source syntax of this method.
|
||||
Syntax syntax = 7;
|
||||
}
|
||||
|
||||
// Declares an API Interface to be included in this interface. The including
|
||||
// interface must redeclare all the methods from the included interface, but
|
||||
// documentation and options are inherited as follows:
|
||||
//
|
||||
// - If after comment and whitespace stripping, the documentation
|
||||
// string of the redeclared method is empty, it will be inherited
|
||||
// from the original method.
|
||||
//
|
||||
// - Each annotation belonging to the service config (http,
|
||||
// visibility) which is not set in the redeclared method will be
|
||||
// inherited.
|
||||
//
|
||||
// - If an http annotation is inherited, the path pattern will be
|
||||
// modified as follows. Any version prefix will be replaced by the
|
||||
// version of the including interface plus the [root][] path if
|
||||
// specified.
|
||||
//
|
||||
// Example of a simple mixin:
|
||||
//
|
||||
// package google.acl.v1;
|
||||
// service AccessControl {
|
||||
// // Get the underlying ACL object.
|
||||
// rpc GetAcl(GetAclRequest) returns (Acl) {
|
||||
// option (google.api.http).get = "/v1/{resource=**}:getAcl";
|
||||
// }
|
||||
// }
|
||||
//
|
||||
// package google.storage.v2;
|
||||
// service Storage {
|
||||
// rpc GetAcl(GetAclRequest) returns (Acl);
|
||||
//
|
||||
// // Get a data record.
|
||||
// rpc GetData(GetDataRequest) returns (Data) {
|
||||
// option (google.api.http).get = "/v2/{resource=**}";
|
||||
// }
|
||||
// }
|
||||
//
|
||||
// Example of a mixin configuration:
|
||||
//
|
||||
// apis:
|
||||
// - name: google.storage.v2.Storage
|
||||
// mixins:
|
||||
// - name: google.acl.v1.AccessControl
|
||||
//
|
||||
// The mixin construct implies that all methods in `AccessControl` are
|
||||
// also declared with same name and request/response types in
|
||||
// `Storage`. A documentation generator or annotation processor will
|
||||
// see the effective `Storage.GetAcl` method after inheriting
|
||||
// documentation and annotations as follows:
|
||||
//
|
||||
// service Storage {
|
||||
// // Get the underlying ACL object.
|
||||
// rpc GetAcl(GetAclRequest) returns (Acl) {
|
||||
// option (google.api.http).get = "/v2/{resource=**}:getAcl";
|
||||
// }
|
||||
// ...
|
||||
// }
|
||||
//
|
||||
// Note how the version in the path pattern changed from `v1` to `v2`.
|
||||
//
|
||||
// If the `root` field in the mixin is specified, it should be a
|
||||
// relative path under which inherited HTTP paths are placed. Example:
|
||||
//
|
||||
// apis:
|
||||
// - name: google.storage.v2.Storage
|
||||
// mixins:
|
||||
// - name: google.acl.v1.AccessControl
|
||||
// root: acls
|
||||
//
|
||||
// This implies the following inherited HTTP annotation:
|
||||
//
|
||||
// service Storage {
|
||||
// // Get the underlying ACL object.
|
||||
// rpc GetAcl(GetAclRequest) returns (Acl) {
|
||||
// option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
|
||||
// }
|
||||
// ...
|
||||
// }
|
||||
message Mixin {
|
||||
// The fully qualified name of the interface which is included.
|
||||
string name = 1;
|
||||
|
||||
// If non-empty specifies a path under which inherited HTTP paths
|
||||
// are rooted.
|
||||
string root = 2;
|
||||
}
|
@ -0,0 +1,180 @@
|
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2008 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
// Author: kenton@google.com (Kenton Varda)
|
||||
//
|
||||
// protoc (aka the Protocol Compiler) can be extended via plugins. A plugin is
|
||||
// just a program that reads a CodeGeneratorRequest from stdin and writes a
|
||||
// CodeGeneratorResponse to stdout.
|
||||
//
|
||||
// Plugins written using C++ can use google/protobuf/compiler/plugin.h instead
|
||||
// of dealing with the raw protocol defined here.
|
||||
//
|
||||
// A plugin executable needs only to be placed somewhere in the path. The
|
||||
// plugin should be named "protoc-gen-$NAME", and will then be used when the
|
||||
// flag "--${NAME}_out" is passed to protoc.
|
||||
|
||||
syntax = "proto2";
|
||||
|
||||
package google.protobuf.compiler;
|
||||
option java_package = "com.google.protobuf.compiler";
|
||||
option java_outer_classname = "PluginProtos";
|
||||
|
||||
option csharp_namespace = "Google.Protobuf.Compiler";
|
||||
option go_package = "google.golang.org/protobuf/types/pluginpb";
|
||||
|
||||
import "google/protobuf/descriptor.proto";
|
||||
|
||||
// The version number of protocol compiler.
|
||||
message Version {
|
||||
optional int32 major = 1;
|
||||
optional int32 minor = 2;
|
||||
optional int32 patch = 3;
|
||||
// A suffix for alpha, beta or rc release, e.g., "alpha-1", "rc2". It should
|
||||
// be empty for mainline stable releases.
|
||||
optional string suffix = 4;
|
||||
}
|
||||
|
||||
// An encoded CodeGeneratorRequest is written to the plugin's stdin.
|
||||
message CodeGeneratorRequest {
|
||||
// The .proto files that were explicitly listed on the command-line. The
|
||||
// code generator should generate code only for these files. Each file's
|
||||
// descriptor will be included in proto_file, below.
|
||||
repeated string file_to_generate = 1;
|
||||
|
||||
// The generator parameter passed on the command-line.
|
||||
optional string parameter = 2;
|
||||
|
||||
// FileDescriptorProtos for all files in files_to_generate and everything
|
||||
// they import. The files will appear in topological order, so each file
|
||||
// appears before any file that imports it.
|
||||
//
|
||||
// protoc guarantees that all proto_files will be written after
|
||||
// the fields above, even though this is not technically guaranteed by the
|
||||
// protobuf wire format. This theoretically could allow a plugin to stream
|
||||
// in the FileDescriptorProtos and handle them one by one rather than read
|
||||
// the entire set into memory at once. However, as of this writing, this
|
||||
// is not similarly optimized on protoc's end -- it will store all fields in
|
||||
// memory at once before sending them to the plugin.
|
||||
//
|
||||
// Type names of fields and extensions in the FileDescriptorProto are always
|
||||
// fully qualified.
|
||||
repeated FileDescriptorProto proto_file = 15;
|
||||
|
||||
// The version number of protocol compiler.
|
||||
optional Version compiler_version = 3;
|
||||
}
|
||||
|
||||
// The plugin writes an encoded CodeGeneratorResponse to stdout.
|
||||
message CodeGeneratorResponse {
|
||||
// Error message. If non-empty, code generation failed. The plugin process
|
||||
// should exit with status code zero even if it reports an error in this way.
|
||||
//
|
||||
// This should be used to indicate errors in .proto files which prevent the
|
||||
// code generator from generating correct code. Errors which indicate a
|
||||
// problem in protoc itself -- such as the input CodeGeneratorRequest being
|
||||
// unparseable -- should be reported by writing a message to stderr and
|
||||
// exiting with a non-zero status code.
|
||||
optional string error = 1;
|
||||
|
||||
// A bitmask of supported features that the code generator supports.
|
||||
// This is a bitwise "or" of values from the Feature enum.
|
||||
optional uint64 supported_features = 2;
|
||||
|
||||
// Sync with code_generator.h.
|
||||
enum Feature {
|
||||
FEATURE_NONE = 0;
|
||||
FEATURE_PROTO3_OPTIONAL = 1;
|
||||
}
|
||||
|
||||
// Represents a single generated file.
|
||||
message File {
|
||||
// The file name, relative to the output directory. The name must not
|
||||
// contain "." or ".." components and must be relative, not be absolute (so,
|
||||
// the file cannot lie outside the output directory). "/" must be used as
|
||||
// the path separator, not "\".
|
||||
//
|
||||
// If the name is omitted, the content will be appended to the previous
|
||||
// file. This allows the generator to break large files into small chunks,
|
||||
// and allows the generated text to be streamed back to protoc so that large
|
||||
// files need not reside completely in memory at one time. Note that as of
|
||||
// this writing protoc does not optimize for this -- it will read the entire
|
||||
// CodeGeneratorResponse before writing files to disk.
|
||||
optional string name = 1;
|
||||
|
||||
// If non-empty, indicates that the named file should already exist, and the
|
||||
// content here is to be inserted into that file at a defined insertion
|
||||
// point. This feature allows a code generator to extend the output
|
||||
// produced by another code generator. The original generator may provide
|
||||
// insertion points by placing special annotations in the file that look
|
||||
// like:
|
||||
// @@protoc_insertion_point(NAME)
|
||||
// The annotation can have arbitrary text before and after it on the line,
|
||||
// which allows it to be placed in a comment. NAME should be replaced with
|
||||
// an identifier naming the point -- this is what other generators will use
|
||||
// as the insertion_point. Code inserted at this point will be placed
|
||||
// immediately above the line containing the insertion point (thus multiple
|
||||
// insertions to the same point will come out in the order they were added).
|
||||
// The double-@ is intended to make it unlikely that the generated code
|
||||
// could contain things that look like insertion points by accident.
|
||||
//
|
||||
// For example, the C++ code generator places the following line in the
|
||||
// .pb.h files that it generates:
|
||||
// // @@protoc_insertion_point(namespace_scope)
|
||||
// This line appears within the scope of the file's package namespace, but
|
||||
// outside of any particular class. Another plugin can then specify the
|
||||
// insertion_point "namespace_scope" to generate additional classes or
|
||||
// other declarations that should be placed in this scope.
|
||||
//
|
||||
// Note that if the line containing the insertion point begins with
|
||||
// whitespace, the same whitespace will be added to every line of the
|
||||
// inserted text. This is useful for languages like Python, where
|
||||
// indentation matters. In these languages, the insertion point comment
|
||||
// should be indented the same amount as any inserted code will need to be
|
||||
// in order to work correctly in that context.
|
||||
//
|
||||
// The code generator that generates the initial file and the one which
|
||||
// inserts into it must both run as part of a single invocation of protoc.
|
||||
// Code generators are executed in the order in which they appear on the
|
||||
// command line.
|
||||
//
|
||||
// If |insertion_point| is present, |name| must also be present.
|
||||
optional string insertion_point = 2;
|
||||
|
||||
// The file contents.
|
||||
optional string content = 15;
|
||||
|
||||
// Information describing the file content being inserted. If an insertion
|
||||
// point is used, this information will be appropriately offset and inserted
|
||||
// into the code generation metadata for the generated files.
|
||||
optional GeneratedCodeInfo generated_code_info = 16;
|
||||
}
|
||||
repeated File file = 15;
|
||||
}
|
@ -0,0 +1,975 @@
|
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2008 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
// Author: kenton@google.com (Kenton Varda)
|
||||
// Based on original Protocol Buffers design by
|
||||
// Sanjay Ghemawat, Jeff Dean, and others.
|
||||
//
|
||||
// The messages in this file describe the definitions found in .proto files.
|
||||
// A valid .proto file can be translated directly to a FileDescriptorProto
|
||||
// without any other information (e.g. without reading its imports).
|
||||
|
||||
syntax = "proto2";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
option go_package = "google.golang.org/protobuf/types/descriptorpb";
|
||||
option java_package = "com.google.protobuf";
|
||||
option java_outer_classname = "DescriptorProtos";
|
||||
option csharp_namespace = "Google.Protobuf.Reflection";
|
||||
option objc_class_prefix = "GPB";
|
||||
option cc_enable_arenas = true;
|
||||
|
||||
// descriptor.proto must be optimized for speed because reflection-based
|
||||
// algorithms don't work during bootstrapping.
|
||||
option optimize_for = SPEED;
|
||||
|
||||
// The protocol compiler can output a FileDescriptorSet containing the .proto
|
||||
// files it parses.
|
||||
message FileDescriptorSet {
|
||||
repeated FileDescriptorProto file = 1;
|
||||
}
|
||||
|
||||
// Describes a complete .proto file.
|
||||
message FileDescriptorProto {
|
||||
optional string name = 1; // file name, relative to root of source tree
|
||||
optional string package = 2; // e.g. "foo", "foo.bar", etc.
|
||||
|
||||
// Names of files imported by this file.
|
||||
repeated string dependency = 3;
|
||||
// Indexes of the public imported files in the dependency list above.
|
||||
repeated int32 public_dependency = 10;
|
||||
// Indexes of the weak imported files in the dependency list.
|
||||
// For Google-internal migration only. Do not use.
|
||||
repeated int32 weak_dependency = 11;
|
||||
|
||||
// All top-level definitions in this file.
|
||||
repeated DescriptorProto message_type = 4;
|
||||
repeated EnumDescriptorProto enum_type = 5;
|
||||
repeated ServiceDescriptorProto service = 6;
|
||||
repeated FieldDescriptorProto extension = 7;
|
||||
|
||||
optional FileOptions options = 8;
|
||||
|
||||
// This field contains optional information about the original source code.
|
||||
// You may safely remove this entire field without harming runtime
|
||||
// functionality of the descriptors -- the information is needed only by
|
||||
// development tools.
|
||||
optional SourceCodeInfo source_code_info = 9;
|
||||
|
||||
// The syntax of the proto file.
|
||||
// The supported values are "proto2", "proto3", and "editions".
|
||||
//
|
||||
// If `edition` is present, this value must be "editions".
|
||||
optional string syntax = 12;
|
||||
|
||||
// The edition of the proto file, which is an opaque string.
|
||||
optional string edition = 13;
|
||||
}
|
||||
|
||||
// Describes a message type.
|
||||
message DescriptorProto {
|
||||
optional string name = 1;
|
||||
|
||||
repeated FieldDescriptorProto field = 2;
|
||||
repeated FieldDescriptorProto extension = 6;
|
||||
|
||||
repeated DescriptorProto nested_type = 3;
|
||||
repeated EnumDescriptorProto enum_type = 4;
|
||||
|
||||
message ExtensionRange {
|
||||
optional int32 start = 1; // Inclusive.
|
||||
optional int32 end = 2; // Exclusive.
|
||||
|
||||
optional ExtensionRangeOptions options = 3;
|
||||
}
|
||||
repeated ExtensionRange extension_range = 5;
|
||||
|
||||
repeated OneofDescriptorProto oneof_decl = 8;
|
||||
|
||||
optional MessageOptions options = 7;
|
||||
|
||||
// Range of reserved tag numbers. Reserved tag numbers may not be used by
|
||||
// fields or extension ranges in the same message. Reserved ranges may
|
||||
// not overlap.
|
||||
message ReservedRange {
|
||||
optional int32 start = 1; // Inclusive.
|
||||
optional int32 end = 2; // Exclusive.
|
||||
}
|
||||
repeated ReservedRange reserved_range = 9;
|
||||
// Reserved field names, which may not be used by fields in the same message.
|
||||
// A given name may only be reserved once.
|
||||
repeated string reserved_name = 10;
|
||||
}
|
||||
|
||||
message ExtensionRangeOptions {
|
||||
// The parser stores options it doesn't recognize here. See above.
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
// Clients can define custom options in extensions of this message. See above.
|
||||
extensions 1000 to max;
|
||||
}
|
||||
|
||||
// Describes a field within a message.
|
||||
message FieldDescriptorProto {
|
||||
enum Type {
|
||||
// 0 is reserved for errors.
|
||||
// Order is weird for historical reasons.
|
||||
TYPE_DOUBLE = 1;
|
||||
TYPE_FLOAT = 2;
|
||||
// Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if
|
||||
// negative values are likely.
|
||||
TYPE_INT64 = 3;
|
||||
TYPE_UINT64 = 4;
|
||||
// Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if
|
||||
// negative values are likely.
|
||||
TYPE_INT32 = 5;
|
||||
TYPE_FIXED64 = 6;
|
||||
TYPE_FIXED32 = 7;
|
||||
TYPE_BOOL = 8;
|
||||
TYPE_STRING = 9;
|
||||
// Tag-delimited aggregate.
|
||||
// Group type is deprecated and not supported in proto3. However, Proto3
|
||||
// implementations should still be able to parse the group wire format and
|
||||
// treat group fields as unknown fields.
|
||||
TYPE_GROUP = 10;
|
||||
TYPE_MESSAGE = 11; // Length-delimited aggregate.
|
||||
|
||||
// New in version 2.
|
||||
TYPE_BYTES = 12;
|
||||
TYPE_UINT32 = 13;
|
||||
TYPE_ENUM = 14;
|
||||
TYPE_SFIXED32 = 15;
|
||||
TYPE_SFIXED64 = 16;
|
||||
TYPE_SINT32 = 17; // Uses ZigZag encoding.
|
||||
TYPE_SINT64 = 18; // Uses ZigZag encoding.
|
||||
}
|
||||
|
||||
enum Label {
|
||||
// 0 is reserved for errors
|
||||
LABEL_OPTIONAL = 1;
|
||||
LABEL_REQUIRED = 2;
|
||||
LABEL_REPEATED = 3;
|
||||
}
|
||||
|
||||
optional string name = 1;
|
||||
optional int32 number = 3;
|
||||
optional Label label = 4;
|
||||
|
||||
// If type_name is set, this need not be set. If both this and type_name
|
||||
// are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.
|
||||
optional Type type = 5;
|
||||
|
||||
// For message and enum types, this is the name of the type. If the name
|
||||
// starts with a '.', it is fully-qualified. Otherwise, C++-like scoping
|
||||
// rules are used to find the type (i.e. first the nested types within this
|
||||
// message are searched, then within the parent, on up to the root
|
||||
// namespace).
|
||||
optional string type_name = 6;
|
||||
|
||||
// For extensions, this is the name of the type being extended. It is
|
||||
// resolved in the same manner as type_name.
|
||||
optional string extendee = 2;
|
||||
|
||||
// For numeric types, contains the original text representation of the value.
|
||||
// For booleans, "true" or "false".
|
||||
// For strings, contains the default text contents (not escaped in any way).
|
||||
// For bytes, contains the C escaped value. All bytes >= 128 are escaped.
|
||||
optional string default_value = 7;
|
||||
|
||||
// If set, gives the index of a oneof in the containing type's oneof_decl
|
||||
// list. This field is a member of that oneof.
|
||||
optional int32 oneof_index = 9;
|
||||
|
||||
// JSON name of this field. The value is set by protocol compiler. If the
|
||||
// user has set a "json_name" option on this field, that option's value
|
||||
// will be used. Otherwise, it's deduced from the field's name by converting
|
||||
// it to camelCase.
|
||||
optional string json_name = 10;
|
||||
|
||||
optional FieldOptions options = 8;
|
||||
|
||||
// If true, this is a proto3 "optional". When a proto3 field is optional, it
|
||||
// tracks presence regardless of field type.
|
||||
//
|
||||
// When proto3_optional is true, this field must be belong to a oneof to
|
||||
// signal to old proto3 clients that presence is tracked for this field. This
|
||||
// oneof is known as a "synthetic" oneof, and this field must be its sole
|
||||
// member (each proto3 optional field gets its own synthetic oneof). Synthetic
|
||||
// oneofs exist in the descriptor only, and do not generate any API. Synthetic
|
||||
// oneofs must be ordered after all "real" oneofs.
|
||||
//
|
||||
// For message fields, proto3_optional doesn't create any semantic change,
|
||||
// since non-repeated message fields always track presence. However it still
|
||||
// indicates the semantic detail of whether the user wrote "optional" or not.
|
||||
// This can be useful for round-tripping the .proto file. For consistency we
|
||||
// give message fields a synthetic oneof also, even though it is not required
|
||||
// to track presence. This is especially important because the parser can't
|
||||
// tell if a field is a message or an enum, so it must always create a
|
||||
// synthetic oneof.
|
||||
//
|
||||
// Proto2 optional fields do not set this flag, because they already indicate
|
||||
// optional with `LABEL_OPTIONAL`.
|
||||
optional bool proto3_optional = 17;
|
||||
}
|
||||
|
||||
// Describes a oneof.
|
||||
message OneofDescriptorProto {
|
||||
optional string name = 1;
|
||||
optional OneofOptions options = 2;
|
||||
}
|
||||
|
||||
// Describes an enum type.
|
||||
message EnumDescriptorProto {
|
||||
optional string name = 1;
|
||||
|
||||
repeated EnumValueDescriptorProto value = 2;
|
||||
|
||||
optional EnumOptions options = 3;
|
||||
|
||||
// Range of reserved numeric values. Reserved values may not be used by
|
||||
// entries in the same enum. Reserved ranges may not overlap.
|
||||
//
|
||||
// Note that this is distinct from DescriptorProto.ReservedRange in that it
|
||||
// is inclusive such that it can appropriately represent the entire int32
|
||||
// domain.
|
||||
message EnumReservedRange {
|
||||
optional int32 start = 1; // Inclusive.
|
||||
optional int32 end = 2; // Inclusive.
|
||||
}
|
||||
|
||||
// Range of reserved numeric values. Reserved numeric values may not be used
|
||||
// by enum values in the same enum declaration. Reserved ranges may not
|
||||
// overlap.
|
||||
repeated EnumReservedRange reserved_range = 4;
|
||||
|
||||
// Reserved enum value names, which may not be reused. A given name may only
|
||||
// be reserved once.
|
||||
repeated string reserved_name = 5;
|
||||
}
|
||||
|
||||
// Describes a value within an enum.
|
||||
message EnumValueDescriptorProto {
|
||||
optional string name = 1;
|
||||
optional int32 number = 2;
|
||||
|
||||
optional EnumValueOptions options = 3;
|
||||
}
|
||||
|
||||
// Describes a service.
|
||||
message ServiceDescriptorProto {
|
||||
optional string name = 1;
|
||||
repeated MethodDescriptorProto method = 2;
|
||||
|
||||
optional ServiceOptions options = 3;
|
||||
}
|
||||
|
||||
// Describes a method of a service.
|
||||
message MethodDescriptorProto {
|
||||
optional string name = 1;
|
||||
|
||||
// Input and output type names. These are resolved in the same way as
|
||||
// FieldDescriptorProto.type_name, but must refer to a message type.
|
||||
optional string input_type = 2;
|
||||
optional string output_type = 3;
|
||||
|
||||
optional MethodOptions options = 4;
|
||||
|
||||
// Identifies if client streams multiple client messages
|
||||
optional bool client_streaming = 5 [default = false];
|
||||
// Identifies if server streams multiple server messages
|
||||
optional bool server_streaming = 6 [default = false];
|
||||
}
|
||||
|
||||
// ===================================================================
|
||||
// Options
|
||||
|
||||
// Each of the definitions above may have "options" attached. These are
|
||||
// just annotations which may cause code to be generated slightly differently
|
||||
// or may contain hints for code that manipulates protocol messages.
|
||||
//
|
||||
// Clients may define custom options as extensions of the *Options messages.
|
||||
// These extensions may not yet be known at parsing time, so the parser cannot
|
||||
// store the values in them. Instead it stores them in a field in the *Options
|
||||
// message called uninterpreted_option. This field must have the same name
|
||||
// across all *Options messages. We then use this field to populate the
|
||||
// extensions when we build a descriptor, at which point all protos have been
|
||||
// parsed and so all extensions are known.
|
||||
//
|
||||
// Extension numbers for custom options may be chosen as follows:
|
||||
// * For options which will only be used within a single application or
|
||||
// organization, or for experimental options, use field numbers 50000
|
||||
// through 99999. It is up to you to ensure that you do not use the
|
||||
// same number for multiple options.
|
||||
// * For options which will be published and used publicly by multiple
|
||||
// independent entities, e-mail protobuf-global-extension-registry@google.com
|
||||
// to reserve extension numbers. Simply provide your project name (e.g.
|
||||
// Objective-C plugin) and your project website (if available) -- there's no
|
||||
// need to explain how you intend to use them. Usually you only need one
|
||||
// extension number. You can declare multiple options with only one extension
|
||||
// number by putting them in a sub-message. See the Custom Options section of
|
||||
// the docs for examples:
|
||||
// https://developers.google.com/protocol-buffers/docs/proto#options
|
||||
// If this turns out to be popular, a web service will be set up
|
||||
// to automatically assign option numbers.
|
||||
|
||||
message FileOptions {
|
||||
|
||||
// Sets the Java package where classes generated from this .proto will be
|
||||
// placed. By default, the proto package is used, but this is often
|
||||
// inappropriate because proto packages do not normally start with backwards
|
||||
// domain names.
|
||||
optional string java_package = 1;
|
||||
|
||||
// Controls the name of the wrapper Java class generated for the .proto file.
|
||||
// That class will always contain the .proto file's getDescriptor() method as
|
||||
// well as any top-level extensions defined in the .proto file.
|
||||
// If java_multiple_files is disabled, then all the other classes from the
|
||||
// .proto file will be nested inside the single wrapper outer class.
|
||||
optional string java_outer_classname = 8;
|
||||
|
||||
// If enabled, then the Java code generator will generate a separate .java
|
||||
// file for each top-level message, enum, and service defined in the .proto
|
||||
// file. Thus, these types will *not* be nested inside the wrapper class
|
||||
// named by java_outer_classname. However, the wrapper class will still be
|
||||
// generated to contain the file's getDescriptor() method as well as any
|
||||
// top-level extensions defined in the file.
|
||||
optional bool java_multiple_files = 10 [default = false];
|
||||
|
||||
// This option does nothing.
|
||||
optional bool java_generate_equals_and_hash = 20 [deprecated=true];
|
||||
|
||||
// If set true, then the Java2 code generator will generate code that
|
||||
// throws an exception whenever an attempt is made to assign a non-UTF-8
|
||||
// byte sequence to a string field.
|
||||
// Message reflection will do the same.
|
||||
// However, an extension field still accepts non-UTF-8 byte sequences.
|
||||
// This option has no effect on when used with the lite runtime.
|
||||
optional bool java_string_check_utf8 = 27 [default = false];
|
||||
|
||||
// Generated classes can be optimized for speed or code size.
|
||||
enum OptimizeMode {
|
||||
SPEED = 1; // Generate complete code for parsing, serialization,
|
||||
// etc.
|
||||
CODE_SIZE = 2; // Use ReflectionOps to implement these methods.
|
||||
LITE_RUNTIME = 3; // Generate code using MessageLite and the lite runtime.
|
||||
}
|
||||
optional OptimizeMode optimize_for = 9 [default = SPEED];
|
||||
|
||||
// Sets the Go package where structs generated from this .proto will be
|
||||
// placed. If omitted, the Go package will be derived from the following:
|
||||
// - The basename of the package import path, if provided.
|
||||
// - Otherwise, the package statement in the .proto file, if present.
|
||||
// - Otherwise, the basename of the .proto file, without extension.
|
||||
optional string go_package = 11;
|
||||
|
||||
// Should generic services be generated in each language? "Generic" services
|
||||
// are not specific to any particular RPC system. They are generated by the
|
||||
// main code generators in each language (without additional plugins).
|
||||
// Generic services were the only kind of service generation supported by
|
||||
// early versions of google.protobuf.
|
||||
//
|
||||
// Generic services are now considered deprecated in favor of using plugins
|
||||
// that generate code specific to your particular RPC system. Therefore,
|
||||
// these default to false. Old code which depends on generic services should
|
||||
// explicitly set them to true.
|
||||
optional bool cc_generic_services = 16 [default = false];
|
||||
optional bool java_generic_services = 17 [default = false];
|
||||
optional bool py_generic_services = 18 [default = false];
|
||||
optional bool php_generic_services = 42 [default = false];
|
||||
|
||||
// Is this file deprecated?
|
||||
// Depending on the target platform, this can emit Deprecated annotations
|
||||
// for everything in the file, or it will be completely ignored; in the very
|
||||
// least, this is a formalization for deprecating files.
|
||||
optional bool deprecated = 23 [default = false];
|
||||
|
||||
// Enables the use of arenas for the proto messages in this file. This applies
|
||||
// only to generated classes for C++.
|
||||
optional bool cc_enable_arenas = 31 [default = true];
|
||||
|
||||
// Sets the objective c class prefix which is prepended to all objective c
|
||||
// generated classes from this .proto. There is no default.
|
||||
optional string objc_class_prefix = 36;
|
||||
|
||||
// Namespace for generated classes; defaults to the package.
|
||||
optional string csharp_namespace = 37;
|
||||
|
||||
// By default Swift generators will take the proto package and CamelCase it
|
||||
// replacing '.' with underscore and use that to prefix the types/symbols
|
||||
// defined. When this options is provided, they will use this value instead
|
||||
// to prefix the types/symbols defined.
|
||||
optional string swift_prefix = 39;
|
||||
|
||||
// Sets the php class prefix which is prepended to all php generated classes
|
||||
// from this .proto. Default is empty.
|
||||
optional string php_class_prefix = 40;
|
||||
|
||||
// Use this option to change the namespace of php generated classes. Default
|
||||
// is empty. When this option is empty, the package name will be used for
|
||||
// determining the namespace.
|
||||
optional string php_namespace = 41;
|
||||
|
||||
// Use this option to change the namespace of php generated metadata classes.
|
||||
// Default is empty. When this option is empty, the proto file name will be
|
||||
// used for determining the namespace.
|
||||
optional string php_metadata_namespace = 44;
|
||||
|
||||
// Use this option to change the package of ruby generated classes. Default
|
||||
// is empty. When this option is not set, the package name will be used for
|
||||
// determining the ruby package.
|
||||
optional string ruby_package = 45;
|
||||
|
||||
// The parser stores options it doesn't recognize here.
|
||||
// See the documentation for the "Options" section above.
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
// Clients can define custom options in extensions of this message.
|
||||
// See the documentation for the "Options" section above.
|
||||
extensions 1000 to max;
|
||||
|
||||
reserved 38;
|
||||
}
|
||||
|
||||
message MessageOptions {
|
||||
// Set true to use the old proto1 MessageSet wire format for extensions.
|
||||
// This is provided for backwards-compatibility with the MessageSet wire
|
||||
// format. You should not use this for any other reason: It's less
|
||||
// efficient, has fewer features, and is more complicated.
|
||||
//
|
||||
// The message must be defined exactly as follows:
|
||||
// message Foo {
|
||||
// option message_set_wire_format = true;
|
||||
// extensions 4 to max;
|
||||
// }
|
||||
// Note that the message cannot have any defined fields; MessageSets only
|
||||
// have extensions.
|
||||
//
|
||||
// All extensions of your type must be singular messages; e.g. they cannot
|
||||
// be int32s, enums, or repeated messages.
|
||||
//
|
||||
// Because this is an option, the above two restrictions are not enforced by
|
||||
// the protocol compiler.
|
||||
optional bool message_set_wire_format = 1 [default = false];
|
||||
|
||||
// Disables the generation of the standard "descriptor()" accessor, which can
|
||||
// conflict with a field of the same name. This is meant to make migration
|
||||
// from proto1 easier; new code should avoid fields named "descriptor".
|
||||
optional bool no_standard_descriptor_accessor = 2 [default = false];
|
||||
|
||||
// Is this message deprecated?
|
||||
// Depending on the target platform, this can emit Deprecated annotations
|
||||
// for the message, or it will be completely ignored; in the very least,
|
||||
// this is a formalization for deprecating messages.
|
||||
optional bool deprecated = 3 [default = false];
|
||||
|
||||
reserved 4, 5, 6;
|
||||
|
||||
// NOTE: Do not set the option in .proto files. Always use the maps syntax
|
||||
// instead. The option should only be implicitly set by the proto compiler
|
||||
// parser.
|
||||
//
|
||||
// Whether the message is an automatically generated map entry type for the
|
||||
// maps field.
|
||||
//
|
||||
// For maps fields:
|
||||
// map<KeyType, ValueType> map_field = 1;
|
||||
// The parsed descriptor looks like:
|
||||
// message MapFieldEntry {
|
||||
// option map_entry = true;
|
||||
// optional KeyType key = 1;
|
||||
// optional ValueType value = 2;
|
||||
// }
|
||||
// repeated MapFieldEntry map_field = 1;
|
||||
//
|
||||
// Implementations may choose not to generate the map_entry=true message, but
|
||||
// use a native map in the target language to hold the keys and values.
|
||||
// The reflection APIs in such implementations still need to work as
|
||||
// if the field is a repeated message field.
|
||||
optional bool map_entry = 7;
|
||||
|
||||
reserved 8; // javalite_serializable
|
||||
reserved 9; // javanano_as_lite
|
||||
|
||||
// Enable the legacy handling of JSON field name conflicts. This lowercases
|
||||
// and strips underscored from the fields before comparison in proto3 only.
|
||||
// The new behavior takes `json_name` into account and applies to proto2 as
|
||||
// well.
|
||||
//
|
||||
// This should only be used as a temporary measure against broken builds due
|
||||
// to the change in behavior for JSON field name conflicts.
|
||||
//
|
||||
// TODO(b/261750190) This is legacy behavior we plan to remove once downstream
|
||||
// teams have had time to migrate.
|
||||
optional bool deprecated_legacy_json_field_conflicts = 11 [deprecated = true];
|
||||
|
||||
// The parser stores options it doesn't recognize here. See above.
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
// Clients can define custom options in extensions of this message. See above.
|
||||
extensions 1000 to max;
|
||||
}
|
||||
|
||||
message FieldOptions {
|
||||
// The ctype option instructs the C++ code generator to use a different
|
||||
// representation of the field than it normally would. See the specific
|
||||
// options below. This option is not yet implemented in the open source
|
||||
// release -- sorry, we'll try to include it in a future version!
|
||||
optional CType ctype = 1 [default = STRING];
|
||||
enum CType {
|
||||
// Default mode.
|
||||
STRING = 0;
|
||||
|
||||
CORD = 1;
|
||||
|
||||
STRING_PIECE = 2;
|
||||
}
|
||||
// The packed option can be enabled for repeated primitive fields to enable
|
||||
// a more efficient representation on the wire. Rather than repeatedly
|
||||
// writing the tag and type for each element, the entire array is encoded as
|
||||
// a single length-delimited blob. In proto3, only explicit setting it to
|
||||
// false will avoid using packed encoding.
|
||||
optional bool packed = 2;
|
||||
|
||||
// The jstype option determines the JavaScript type used for values of the
|
||||
// field. The option is permitted only for 64 bit integral and fixed types
|
||||
// (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING
|
||||
// is represented as JavaScript string, which avoids loss of precision that
|
||||
// can happen when a large value is converted to a floating point JavaScript.
|
||||
// Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
|
||||
// use the JavaScript "number" type. The behavior of the default option
|
||||
// JS_NORMAL is implementation dependent.
|
||||
//
|
||||
// This option is an enum to permit additional types to be added, e.g.
|
||||
// goog.math.Integer.
|
||||
optional JSType jstype = 6 [default = JS_NORMAL];
|
||||
enum JSType {
|
||||
// Use the default type.
|
||||
JS_NORMAL = 0;
|
||||
|
||||
// Use JavaScript strings.
|
||||
JS_STRING = 1;
|
||||
|
||||
// Use JavaScript numbers.
|
||||
JS_NUMBER = 2;
|
||||
}
|
||||
|
||||
// Should this field be parsed lazily? Lazy applies only to message-type
|
||||
// fields. It means that when the outer message is initially parsed, the
|
||||
// inner message's contents will not be parsed but instead stored in encoded
|
||||
// form. The inner message will actually be parsed when it is first accessed.
|
||||
//
|
||||
// This is only a hint. Implementations are free to choose whether to use
|
||||
// eager or lazy parsing regardless of the value of this option. However,
|
||||
// setting this option true suggests that the protocol author believes that
|
||||
// using lazy parsing on this field is worth the additional bookkeeping
|
||||
// overhead typically needed to implement it.
|
||||
//
|
||||
// This option does not affect the public interface of any generated code;
|
||||
// all method signatures remain the same. Furthermore, thread-safety of the
|
||||
// interface is not affected by this option; const methods remain safe to
|
||||
// call from multiple threads concurrently, while non-const methods continue
|
||||
// to require exclusive access.
|
||||
//
|
||||
// Note that implementations may choose not to check required fields within
|
||||
// a lazy sub-message. That is, calling IsInitialized() on the outer message
|
||||
// may return true even if the inner message has missing required fields.
|
||||
// This is necessary because otherwise the inner message would have to be
|
||||
// parsed in order to perform the check, defeating the purpose of lazy
|
||||
// parsing. An implementation which chooses not to check required fields
|
||||
// must be consistent about it. That is, for any particular sub-message, the
|
||||
// implementation must either *always* check its required fields, or *never*
|
||||
// check its required fields, regardless of whether or not the message has
|
||||
// been parsed.
|
||||
//
|
||||
// As of May 2022, lazy verifies the contents of the byte stream during
|
||||
// parsing. An invalid byte stream will cause the overall parsing to fail.
|
||||
optional bool lazy = 5 [default = false];
|
||||
|
||||
// unverified_lazy does no correctness checks on the byte stream. This should
|
||||
// only be used where lazy with verification is prohibitive for performance
|
||||
// reasons.
|
||||
optional bool unverified_lazy = 15 [default = false];
|
||||
|
||||
// Is this field deprecated?
|
||||
// Depending on the target platform, this can emit Deprecated annotations
|
||||
// for accessors, or it will be completely ignored; in the very least, this
|
||||
// is a formalization for deprecating fields.
|
||||
optional bool deprecated = 3 [default = false];
|
||||
|
||||
// For Google-internal migration only. Do not use.
|
||||
optional bool weak = 10 [default = false];
|
||||
|
||||
// Indicate that the field value should not be printed out when using debug
|
||||
// formats, e.g. when the field contains sensitive credentials.
|
||||
optional bool debug_redact = 16 [default = false];
|
||||
|
||||
// If set to RETENTION_SOURCE, the option will be omitted from the binary.
|
||||
// Note: as of January 2023, support for this is in progress and does not yet
|
||||
// have an effect (b/264593489).
|
||||
enum OptionRetention {
|
||||
RETENTION_UNKNOWN = 0;
|
||||
RETENTION_RUNTIME = 1;
|
||||
RETENTION_SOURCE = 2;
|
||||
}
|
||||
|
||||
optional OptionRetention retention = 17;
|
||||
|
||||
// This indicates the types of entities that the field may apply to when used
|
||||
// as an option. If it is unset, then the field may be freely used as an
|
||||
// option on any kind of entity. Note: as of January 2023, support for this is
|
||||
// in progress and does not yet have an effect (b/264593489).
|
||||
enum OptionTargetType {
|
||||
TARGET_TYPE_UNKNOWN = 0;
|
||||
TARGET_TYPE_FILE = 1;
|
||||
TARGET_TYPE_EXTENSION_RANGE = 2;
|
||||
TARGET_TYPE_MESSAGE = 3;
|
||||
TARGET_TYPE_FIELD = 4;
|
||||
TARGET_TYPE_ONEOF = 5;
|
||||
TARGET_TYPE_ENUM = 6;
|
||||
TARGET_TYPE_ENUM_ENTRY = 7;
|
||||
TARGET_TYPE_SERVICE = 8;
|
||||
TARGET_TYPE_METHOD = 9;
|
||||
}
|
||||
|
||||
optional OptionTargetType target = 18;
|
||||
|
||||
// The parser stores options it doesn't recognize here. See above.
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
// Clients can define custom options in extensions of this message. See above.
|
||||
extensions 1000 to max;
|
||||
|
||||
reserved 4; // removed jtype
|
||||
}
|
||||
|
||||
message OneofOptions {
|
||||
// The parser stores options it doesn't recognize here. See above.
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
// Clients can define custom options in extensions of this message. See above.
|
||||
extensions 1000 to max;
|
||||
}
|
||||
|
||||
message EnumOptions {
|
||||
|
||||
// Set this option to true to allow mapping different tag names to the same
|
||||
// value.
|
||||
optional bool allow_alias = 2;
|
||||
|
||||
// Is this enum deprecated?
|
||||
// Depending on the target platform, this can emit Deprecated annotations
|
||||
// for the enum, or it will be completely ignored; in the very least, this
|
||||
// is a formalization for deprecating enums.
|
||||
optional bool deprecated = 3 [default = false];
|
||||
|
||||
reserved 5; // javanano_as_lite
|
||||
|
||||
// Enable the legacy handling of JSON field name conflicts. This lowercases
|
||||
// and strips underscored from the fields before comparison in proto3 only.
|
||||
// The new behavior takes `json_name` into account and applies to proto2 as
|
||||
// well.
|
||||
// TODO(b/261750190) Remove this legacy behavior once downstream teams have
|
||||
// had time to migrate.
|
||||
optional bool deprecated_legacy_json_field_conflicts = 6 [deprecated = true];
|
||||
|
||||
// The parser stores options it doesn't recognize here. See above.
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
// Clients can define custom options in extensions of this message. See above.
|
||||
extensions 1000 to max;
|
||||
}
|
||||
|
||||
message EnumValueOptions {
|
||||
// Is this enum value deprecated?
|
||||
// Depending on the target platform, this can emit Deprecated annotations
|
||||
// for the enum value, or it will be completely ignored; in the very least,
|
||||
// this is a formalization for deprecating enum values.
|
||||
optional bool deprecated = 1 [default = false];
|
||||
|
||||
// The parser stores options it doesn't recognize here. See above.
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
// Clients can define custom options in extensions of this message. See above.
|
||||
extensions 1000 to max;
|
||||
}
|
||||
|
||||
message ServiceOptions {
|
||||
|
||||
// Note: Field numbers 1 through 32 are reserved for Google's internal RPC
|
||||
// framework. We apologize for hoarding these numbers to ourselves, but
|
||||
// we were already using them long before we decided to release Protocol
|
||||
// Buffers.
|
||||
|
||||
// Is this service deprecated?
|
||||
// Depending on the target platform, this can emit Deprecated annotations
|
||||
// for the service, or it will be completely ignored; in the very least,
|
||||
// this is a formalization for deprecating services.
|
||||
optional bool deprecated = 33 [default = false];
|
||||
|
||||
// The parser stores options it doesn't recognize here. See above.
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
// Clients can define custom options in extensions of this message. See above.
|
||||
extensions 1000 to max;
|
||||
}
|
||||
|
||||
message MethodOptions {
|
||||
|
||||
// Note: Field numbers 1 through 32 are reserved for Google's internal RPC
|
||||
// framework. We apologize for hoarding these numbers to ourselves, but
|
||||
// we were already using them long before we decided to release Protocol
|
||||
// Buffers.
|
||||
|
||||
// Is this method deprecated?
|
||||
// Depending on the target platform, this can emit Deprecated annotations
|
||||
// for the method, or it will be completely ignored; in the very least,
|
||||
// this is a formalization for deprecating methods.
|
||||
optional bool deprecated = 33 [default = false];
|
||||
|
||||
// Is this method side-effect-free (or safe in HTTP parlance), or idempotent,
|
||||
// or neither? HTTP based RPC implementation may choose GET verb for safe
|
||||
// methods, and PUT verb for idempotent methods instead of the default POST.
|
||||
enum IdempotencyLevel {
|
||||
IDEMPOTENCY_UNKNOWN = 0;
|
||||
NO_SIDE_EFFECTS = 1; // implies idempotent
|
||||
IDEMPOTENT = 2; // idempotent, but may have side effects
|
||||
}
|
||||
optional IdempotencyLevel idempotency_level = 34
|
||||
[default = IDEMPOTENCY_UNKNOWN];
|
||||
|
||||
// The parser stores options it doesn't recognize here. See above.
|
||||
repeated UninterpretedOption uninterpreted_option = 999;
|
||||
|
||||
// Clients can define custom options in extensions of this message. See above.
|
||||
extensions 1000 to max;
|
||||
}
|
||||
|
||||
// A message representing a option the parser does not recognize. This only
|
||||
// appears in options protos created by the compiler::Parser class.
|
||||
// DescriptorPool resolves these when building Descriptor objects. Therefore,
|
||||
// options protos in descriptor objects (e.g. returned by Descriptor::options(),
|
||||
// or produced by Descriptor::CopyTo()) will never have UninterpretedOptions
|
||||
// in them.
|
||||
message UninterpretedOption {
|
||||
// The name of the uninterpreted option. Each string represents a segment in
|
||||
// a dot-separated name. is_extension is true iff a segment represents an
|
||||
// extension (denoted with parentheses in options specs in .proto files).
|
||||
// E.g.,{ ["foo", false], ["bar.baz", true], ["moo", false] } represents
|
||||
// "foo.(bar.baz).moo".
|
||||
message NamePart {
|
||||
required string name_part = 1;
|
||||
required bool is_extension = 2;
|
||||
}
|
||||
repeated NamePart name = 2;
|
||||
|
||||
// The value of the uninterpreted option, in whatever type the tokenizer
|
||||
// identified it as during parsing. Exactly one of these should be set.
|
||||
optional string identifier_value = 3;
|
||||
optional uint64 positive_int_value = 4;
|
||||
optional int64 negative_int_value = 5;
|
||||
optional double double_value = 6;
|
||||
optional bytes string_value = 7;
|
||||
optional string aggregate_value = 8;
|
||||
}
|
||||
|
||||
// ===================================================================
|
||||
// Optional source code info
|
||||
|
||||
// Encapsulates information about the original source file from which a
|
||||
// FileDescriptorProto was generated.
|
||||
message SourceCodeInfo {
|
||||
// A Location identifies a piece of source code in a .proto file which
|
||||
// corresponds to a particular definition. This information is intended
|
||||
// to be useful to IDEs, code indexers, documentation generators, and similar
|
||||
// tools.
|
||||
//
|
||||
// For example, say we have a file like:
|
||||
// message Foo {
|
||||
// optional string foo = 1;
|
||||
// }
|
||||
// Let's look at just the field definition:
|
||||
// optional string foo = 1;
|
||||
// ^ ^^ ^^ ^ ^^^
|
||||
// a bc de f ghi
|
||||
// We have the following locations:
|
||||
// span path represents
|
||||
// [a,i) [ 4, 0, 2, 0 ] The whole field definition.
|
||||
// [a,b) [ 4, 0, 2, 0, 4 ] The label (optional).
|
||||
// [c,d) [ 4, 0, 2, 0, 5 ] The type (string).
|
||||
// [e,f) [ 4, 0, 2, 0, 1 ] The name (foo).
|
||||
// [g,h) [ 4, 0, 2, 0, 3 ] The number (1).
|
||||
//
|
||||
// Notes:
|
||||
// - A location may refer to a repeated field itself (i.e. not to any
|
||||
// particular index within it). This is used whenever a set of elements are
|
||||
// logically enclosed in a single code segment. For example, an entire
|
||||
// extend block (possibly containing multiple extension definitions) will
|
||||
// have an outer location whose path refers to the "extensions" repeated
|
||||
// field without an index.
|
||||
// - Multiple locations may have the same path. This happens when a single
|
||||
// logical declaration is spread out across multiple places. The most
|
||||
// obvious example is the "extend" block again -- there may be multiple
|
||||
// extend blocks in the same scope, each of which will have the same path.
|
||||
// - A location's span is not always a subset of its parent's span. For
|
||||
// example, the "extendee" of an extension declaration appears at the
|
||||
// beginning of the "extend" block and is shared by all extensions within
|
||||
// the block.
|
||||
// - Just because a location's span is a subset of some other location's span
|
||||
// does not mean that it is a descendant. For example, a "group" defines
|
||||
// both a type and a field in a single declaration. Thus, the locations
|
||||
// corresponding to the type and field and their components will overlap.
|
||||
// - Code which tries to interpret locations should probably be designed to
|
||||
// ignore those that it doesn't understand, as more types of locations could
|
||||
// be recorded in the future.
|
||||
repeated Location location = 1;
|
||||
message Location {
|
||||
// Identifies which part of the FileDescriptorProto was defined at this
|
||||
// location.
|
||||
//
|
||||
// Each element is a field number or an index. They form a path from
|
||||
// the root FileDescriptorProto to the place where the definition occurs.
|
||||
// For example, this path:
|
||||
// [ 4, 3, 2, 7, 1 ]
|
||||
// refers to:
|
||||
// file.message_type(3) // 4, 3
|
||||
// .field(7) // 2, 7
|
||||
// .name() // 1
|
||||
// This is because FileDescriptorProto.message_type has field number 4:
|
||||
// repeated DescriptorProto message_type = 4;
|
||||
// and DescriptorProto.field has field number 2:
|
||||
// repeated FieldDescriptorProto field = 2;
|
||||
// and FieldDescriptorProto.name has field number 1:
|
||||
// optional string name = 1;
|
||||
//
|
||||
// Thus, the above path gives the location of a field name. If we removed
|
||||
// the last element:
|
||||
// [ 4, 3, 2, 7 ]
|
||||
// this path refers to the whole field declaration (from the beginning
|
||||
// of the label to the terminating semicolon).
|
||||
repeated int32 path = 1 [packed = true];
|
||||
|
||||
// Always has exactly three or four elements: start line, start column,
|
||||
// end line (optional, otherwise assumed same as start line), end column.
|
||||
// These are packed into a single field for efficiency. Note that line
|
||||
// and column numbers are zero-based -- typically you will want to add
|
||||
// 1 to each before displaying to a user.
|
||||
repeated int32 span = 2 [packed = true];
|
||||
|
||||
// If this SourceCodeInfo represents a complete declaration, these are any
|
||||
// comments appearing before and after the declaration which appear to be
|
||||
// attached to the declaration.
|
||||
//
|
||||
// A series of line comments appearing on consecutive lines, with no other
|
||||
// tokens appearing on those lines, will be treated as a single comment.
|
||||
//
|
||||
// leading_detached_comments will keep paragraphs of comments that appear
|
||||
// before (but not connected to) the current element. Each paragraph,
|
||||
// separated by empty lines, will be one comment element in the repeated
|
||||
// field.
|
||||
//
|
||||
// Only the comment content is provided; comment markers (e.g. //) are
|
||||
// stripped out. For block comments, leading whitespace and an asterisk
|
||||
// will be stripped from the beginning of each line other than the first.
|
||||
// Newlines are included in the output.
|
||||
//
|
||||
// Examples:
|
||||
//
|
||||
// optional int32 foo = 1; // Comment attached to foo.
|
||||
// // Comment attached to bar.
|
||||
// optional int32 bar = 2;
|
||||
//
|
||||
// optional string baz = 3;
|
||||
// // Comment attached to baz.
|
||||
// // Another line attached to baz.
|
||||
//
|
||||
// // Comment attached to moo.
|
||||
// //
|
||||
// // Another line attached to moo.
|
||||
// optional double moo = 4;
|
||||
//
|
||||
// // Detached comment for corge. This is not leading or trailing comments
|
||||
// // to moo or corge because there are blank lines separating it from
|
||||
// // both.
|
||||
//
|
||||
// // Detached comment for corge paragraph 2.
|
||||
//
|
||||
// optional string corge = 5;
|
||||
// /* Block comment attached
|
||||
// * to corge. Leading asterisks
|
||||
// * will be removed. */
|
||||
// /* Block comment attached to
|
||||
// * grault. */
|
||||
// optional int32 grault = 6;
|
||||
//
|
||||
// // ignored detached comments.
|
||||
optional string leading_comments = 3;
|
||||
optional string trailing_comments = 4;
|
||||
repeated string leading_detached_comments = 6;
|
||||
}
|
||||
}
|
||||
|
||||
// Describes the relationship between generated code and its original source
|
||||
// file. A GeneratedCodeInfo message is associated with only one generated
|
||||
// source file, but may contain references to different source .proto files.
|
||||
message GeneratedCodeInfo {
|
||||
// An Annotation connects some span of text in generated code to an element
|
||||
// of its generating .proto file.
|
||||
repeated Annotation annotation = 1;
|
||||
message Annotation {
|
||||
// Identifies the element in the original source .proto file. This field
|
||||
// is formatted the same as SourceCodeInfo.Location.path.
|
||||
repeated int32 path = 1 [packed = true];
|
||||
|
||||
// Identifies the filesystem path to the original source .proto.
|
||||
optional string source_file = 2;
|
||||
|
||||
// Identifies the starting offset in bytes in the generated code
|
||||
// that relates to the identified object.
|
||||
optional int32 begin = 3;
|
||||
|
||||
// Identifies the ending offset in bytes in the generated code that
|
||||
// relates to the identified object. The end offset should be one past
|
||||
// the last relevant byte (so the length of the text = end - begin).
|
||||
optional int32 end = 4;
|
||||
|
||||
// Represents the identified object's effect on the element in the original
|
||||
// .proto file.
|
||||
enum Semantic {
|
||||
// There is no effect or the effect is indescribable.
|
||||
NONE = 0;
|
||||
// The element is set or otherwise mutated.
|
||||
SET = 1;
|
||||
// An alias to the element is returned.
|
||||
ALIAS = 2;
|
||||
}
|
||||
optional Semantic semantic = 5;
|
||||
}
|
||||
}
|
@ -0,0 +1,115 @@
|
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2008 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
syntax = "proto3";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
option cc_enable_arenas = true;
|
||||
option go_package = "google.golang.org/protobuf/types/known/durationpb";
|
||||
option java_package = "com.google.protobuf";
|
||||
option java_outer_classname = "DurationProto";
|
||||
option java_multiple_files = true;
|
||||
option objc_class_prefix = "GPB";
|
||||
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||
|
||||
// A Duration represents a signed, fixed-length span of time represented
|
||||
// as a count of seconds and fractions of seconds at nanosecond
|
||||
// resolution. It is independent of any calendar and concepts like "day"
|
||||
// or "month". It is related to Timestamp in that the difference between
|
||||
// two Timestamp values is a Duration and it can be added or subtracted
|
||||
// from a Timestamp. Range is approximately +-10,000 years.
|
||||
//
|
||||
// # Examples
|
||||
//
|
||||
// Example 1: Compute Duration from two Timestamps in pseudo code.
|
||||
//
|
||||
// Timestamp start = ...;
|
||||
// Timestamp end = ...;
|
||||
// Duration duration = ...;
|
||||
//
|
||||
// duration.seconds = end.seconds - start.seconds;
|
||||
// duration.nanos = end.nanos - start.nanos;
|
||||
//
|
||||
// if (duration.seconds < 0 && duration.nanos > 0) {
|
||||
// duration.seconds += 1;
|
||||
// duration.nanos -= 1000000000;
|
||||
// } else if (duration.seconds > 0 && duration.nanos < 0) {
|
||||
// duration.seconds -= 1;
|
||||
// duration.nanos += 1000000000;
|
||||
// }
|
||||
//
|
||||
// Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
|
||||
//
|
||||
// Timestamp start = ...;
|
||||
// Duration duration = ...;
|
||||
// Timestamp end = ...;
|
||||
//
|
||||
// end.seconds = start.seconds + duration.seconds;
|
||||
// end.nanos = start.nanos + duration.nanos;
|
||||
//
|
||||
// if (end.nanos < 0) {
|
||||
// end.seconds -= 1;
|
||||
// end.nanos += 1000000000;
|
||||
// } else if (end.nanos >= 1000000000) {
|
||||
// end.seconds += 1;
|
||||
// end.nanos -= 1000000000;
|
||||
// }
|
||||
//
|
||||
// Example 3: Compute Duration from datetime.timedelta in Python.
|
||||
//
|
||||
// td = datetime.timedelta(days=3, minutes=10)
|
||||
// duration = Duration()
|
||||
// duration.FromTimedelta(td)
|
||||
//
|
||||
// # JSON Mapping
|
||||
//
|
||||
// In JSON format, the Duration type is encoded as a string rather than an
|
||||
// object, where the string ends in the suffix "s" (indicating seconds) and
|
||||
// is preceded by the number of seconds, with nanoseconds expressed as
|
||||
// fractional seconds. For example, 3 seconds with 0 nanoseconds should be
|
||||
// encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
|
||||
// be expressed in JSON format as "3.000000001s", and 3 seconds and 1
|
||||
// microsecond should be expressed in JSON format as "3.000001s".
|
||||
//
|
||||
message Duration {
|
||||
// Signed seconds of the span of time. Must be from -315,576,000,000
|
||||
// to +315,576,000,000 inclusive. Note: these bounds are computed from:
|
||||
// 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
|
||||
int64 seconds = 1;
|
||||
|
||||
// Signed fractions of a second at nanosecond resolution of the span
|
||||
// of time. Durations less than one second are represented with a 0
|
||||
// `seconds` field and a positive or negative `nanos` field. For durations
|
||||
// of one second or more, a non-zero value for the `nanos` field must be
|
||||
// of the same sign as the `seconds` field. Must be from -999,999,999
|
||||
// to +999,999,999 inclusive.
|
||||
int32 nanos = 2;
|
||||
}
|
@ -0,0 +1,51 @@
|
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2008 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
syntax = "proto3";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
option go_package = "google.golang.org/protobuf/types/known/emptypb";
|
||||
option java_package = "com.google.protobuf";
|
||||
option java_outer_classname = "EmptyProto";
|
||||
option java_multiple_files = true;
|
||||
option objc_class_prefix = "GPB";
|
||||
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||
option cc_enable_arenas = true;
|
||||
|
||||
// A generic empty message that you can re-use to avoid defining duplicated
|
||||
// empty messages in your APIs. A typical example is to use it as the request
|
||||
// or the response type of an API method. For instance:
|
||||
//
|
||||
// service Foo {
|
||||
// rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
||||
// }
|
||||
//
|
||||
message Empty {}
|
@ -0,0 +1,245 @@
|
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2008 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
syntax = "proto3";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
option java_package = "com.google.protobuf";
|
||||
option java_outer_classname = "FieldMaskProto";
|
||||
option java_multiple_files = true;
|
||||
option objc_class_prefix = "GPB";
|
||||
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||
option go_package = "google.golang.org/protobuf/types/known/fieldmaskpb";
|
||||
option cc_enable_arenas = true;
|
||||
|
||||
// `FieldMask` represents a set of symbolic field paths, for example:
|
||||
//
|
||||
// paths: "f.a"
|
||||
// paths: "f.b.d"
|
||||
//
|
||||
// Here `f` represents a field in some root message, `a` and `b`
|
||||
// fields in the message found in `f`, and `d` a field found in the
|
||||
// message in `f.b`.
|
||||
//
|
||||
// Field masks are used to specify a subset of fields that should be
|
||||
// returned by a get operation or modified by an update operation.
|
||||
// Field masks also have a custom JSON encoding (see below).
|
||||
//
|
||||
// # Field Masks in Projections
|
||||
//
|
||||
// When used in the context of a projection, a response message or
|
||||
// sub-message is filtered by the API to only contain those fields as
|
||||
// specified in the mask. For example, if the mask in the previous
|
||||
// example is applied to a response message as follows:
|
||||
//
|
||||
// f {
|
||||
// a : 22
|
||||
// b {
|
||||
// d : 1
|
||||
// x : 2
|
||||
// }
|
||||
// y : 13
|
||||
// }
|
||||
// z: 8
|
||||
//
|
||||
// The result will not contain specific values for fields x,y and z
|
||||
// (their value will be set to the default, and omitted in proto text
|
||||
// output):
|
||||
//
|
||||
//
|
||||
// f {
|
||||
// a : 22
|
||||
// b {
|
||||
// d : 1
|
||||
// }
|
||||
// }
|
||||
//
|
||||
// A repeated field is not allowed except at the last position of a
|
||||
// paths string.
|
||||
//
|
||||
// If a FieldMask object is not present in a get operation, the
|
||||
// operation applies to all fields (as if a FieldMask of all fields
|
||||
// had been specified).
|
||||
//
|
||||
// Note that a field mask does not necessarily apply to the
|
||||
// top-level response message. In case of a REST get operation, the
|
||||
// field mask applies directly to the response, but in case of a REST
|
||||
// list operation, the mask instead applies to each individual message
|
||||
// in the returned resource list. In case of a REST custom method,
|
||||
// other definitions may be used. Where the mask applies will be
|
||||
// clearly documented together with its declaration in the API. In
|
||||
// any case, the effect on the returned resource/resources is required
|
||||
// behavior for APIs.
|
||||
//
|
||||
// # Field Masks in Update Operations
|
||||
//
|
||||
// A field mask in update operations specifies which fields of the
|
||||
// targeted resource are going to be updated. The API is required
|
||||
// to only change the values of the fields as specified in the mask
|
||||
// and leave the others untouched. If a resource is passed in to
|
||||
// describe the updated values, the API ignores the values of all
|
||||
// fields not covered by the mask.
|
||||
//
|
||||
// If a repeated field is specified for an update operation, new values will
|
||||
// be appended to the existing repeated field in the target resource. Note that
|
||||
// a repeated field is only allowed in the last position of a `paths` string.
|
||||
//
|
||||
// If a sub-message is specified in the last position of the field mask for an
|
||||
// update operation, then new value will be merged into the existing sub-message
|
||||
// in the target resource.
|
||||
//
|
||||
// For example, given the target message:
|
||||
//
|
||||
// f {
|
||||
// b {
|
||||
// d: 1
|
||||
// x: 2
|
||||
// }
|
||||
// c: [1]
|
||||
// }
|
||||
//
|
||||
// And an update message:
|
||||
//
|
||||
// f {
|
||||
// b {
|
||||
// d: 10
|
||||
// }
|
||||
// c: [2]
|
||||
// }
|
||||
//
|
||||
// then if the field mask is:
|
||||
//
|
||||
// paths: ["f.b", "f.c"]
|
||||
//
|
||||
// then the result will be:
|
||||
//
|
||||
// f {
|
||||
// b {
|
||||
// d: 10
|
||||
// x: 2
|
||||
// }
|
||||
// c: [1, 2]
|
||||
// }
|
||||
//
|
||||
// An implementation may provide options to override this default behavior for
|
||||
// repeated and message fields.
|
||||
//
|
||||
// In order to reset a field's value to the default, the field must
|
||||
// be in the mask and set to the default value in the provided resource.
|
||||
// Hence, in order to reset all fields of a resource, provide a default
|
||||
// instance of the resource and set all fields in the mask, or do
|
||||
// not provide a mask as described below.
|
||||
//
|
||||
// If a field mask is not present on update, the operation applies to
|
||||
// all fields (as if a field mask of all fields has been specified).
|
||||
// Note that in the presence of schema evolution, this may mean that
|
||||
// fields the client does not know and has therefore not filled into
|
||||
// the request will be reset to their default. If this is unwanted
|
||||
// behavior, a specific service may require a client to always specify
|
||||
// a field mask, producing an error if not.
|
||||
//
|
||||
// As with get operations, the location of the resource which
|
||||
// describes the updated values in the request message depends on the
|
||||
// operation kind. In any case, the effect of the field mask is
|
||||
// required to be honored by the API.
|
||||
//
|
||||
// ## Considerations for HTTP REST
|
||||
//
|
||||
// The HTTP kind of an update operation which uses a field mask must
|
||||
// be set to PATCH instead of PUT in order to satisfy HTTP semantics
|
||||
// (PUT must only be used for full updates).
|
||||
//
|
||||
// # JSON Encoding of Field Masks
|
||||
//
|
||||
// In JSON, a field mask is encoded as a single string where paths are
|
||||
// separated by a comma. Fields name in each path are converted
|
||||
// to/from lower-camel naming conventions.
|
||||
//
|
||||
// As an example, consider the following message declarations:
|
||||
//
|
||||
// message Profile {
|
||||
// User user = 1;
|
||||
// Photo photo = 2;
|
||||
// }
|
||||
// message User {
|
||||
// string display_name = 1;
|
||||
// string address = 2;
|
||||
// }
|
||||
//
|
||||
// In proto a field mask for `Profile` may look as such:
|
||||
//
|
||||
// mask {
|
||||
// paths: "user.display_name"
|
||||
// paths: "photo"
|
||||
// }
|
||||
//
|
||||
// In JSON, the same mask is represented as below:
|
||||
//
|
||||
// {
|
||||
// mask: "user.displayName,photo"
|
||||
// }
|
||||
//
|
||||
// # Field Masks and Oneof Fields
|
||||
//
|
||||
// Field masks treat fields in oneofs just as regular fields. Consider the
|
||||
// following message:
|
||||
//
|
||||
// message SampleMessage {
|
||||
// oneof test_oneof {
|
||||
// string name = 4;
|
||||
// SubMessage sub_message = 9;
|
||||
// }
|
||||
// }
|
||||
//
|
||||
// The field mask can be:
|
||||
//
|
||||
// mask {
|
||||
// paths: "name"
|
||||
// }
|
||||
//
|
||||
// Or:
|
||||
//
|
||||
// mask {
|
||||
// paths: "sub_message"
|
||||
// }
|
||||
//
|
||||
// Note that oneof type names ("test_oneof" in this case) cannot be used in
|
||||
// paths.
|
||||
//
|
||||
// ## Field Mask Verification
|
||||
//
|
||||
// The implementation of any API method which has a FieldMask type field in the
|
||||
// request should verify the included field paths, and return an
|
||||
// `INVALID_ARGUMENT` error if any path is unmappable.
|
||||
message FieldMask {
|
||||
// The set of field mask paths.
|
||||
repeated string paths = 1;
|
||||
}
|
@ -0,0 +1,48 @@
|
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2008 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
syntax = "proto3";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
option java_package = "com.google.protobuf";
|
||||
option java_outer_classname = "SourceContextProto";
|
||||
option java_multiple_files = true;
|
||||
option objc_class_prefix = "GPB";
|
||||
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||
option go_package = "google.golang.org/protobuf/types/known/sourcecontextpb";
|
||||
|
||||
// `SourceContext` represents information about the source of a
|
||||
// protobuf element, like the file in which it is defined.
|
||||
message SourceContext {
|
||||
// The path-qualified name of the .proto file that contained the associated
|
||||
// protobuf element. For example: `"google/protobuf/source_context.proto"`.
|
||||
string file_name = 1;
|
||||
}
|
@ -0,0 +1,95 @@
|
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2008 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
syntax = "proto3";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
option cc_enable_arenas = true;
|
||||
option go_package = "google.golang.org/protobuf/types/known/structpb";
|
||||
option java_package = "com.google.protobuf";
|
||||
option java_outer_classname = "StructProto";
|
||||
option java_multiple_files = true;
|
||||
option objc_class_prefix = "GPB";
|
||||
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||
|
||||
// `Struct` represents a structured data value, consisting of fields
|
||||
// which map to dynamically typed values. In some languages, `Struct`
|
||||
// might be supported by a native representation. For example, in
|
||||
// scripting languages like JS a struct is represented as an
|
||||
// object. The details of that representation are described together
|
||||
// with the proto support for the language.
|
||||
//
|
||||
// The JSON representation for `Struct` is JSON object.
|
||||
message Struct {
|
||||
// Unordered map of dynamically typed values.
|
||||
map<string, Value> fields = 1;
|
||||
}
|
||||
|
||||
// `Value` represents a dynamically typed value which can be either
|
||||
// null, a number, a string, a boolean, a recursive struct value, or a
|
||||
// list of values. A producer of value is expected to set one of these
|
||||
// variants. Absence of any variant indicates an error.
|
||||
//
|
||||
// The JSON representation for `Value` is JSON value.
|
||||
message Value {
|
||||
// The kind of value.
|
||||
oneof kind {
|
||||
// Represents a null value.
|
||||
NullValue null_value = 1;
|
||||
// Represents a double value.
|
||||
double number_value = 2;
|
||||
// Represents a string value.
|
||||
string string_value = 3;
|
||||
// Represents a boolean value.
|
||||
bool bool_value = 4;
|
||||
// Represents a structured value.
|
||||
Struct struct_value = 5;
|
||||
// Represents a repeated `Value`.
|
||||
ListValue list_value = 6;
|
||||
}
|
||||
}
|
||||
|
||||
// `NullValue` is a singleton enumeration to represent the null value for the
|
||||
// `Value` type union.
|
||||
//
|
||||
// The JSON representation for `NullValue` is JSON `null`.
|
||||
enum NullValue {
|
||||
// Null value.
|
||||
NULL_VALUE = 0;
|
||||
}
|
||||
|
||||
// `ListValue` is a wrapper around a repeated field of values.
|
||||
//
|
||||
// The JSON representation for `ListValue` is JSON array.
|
||||
message ListValue {
|
||||
// Repeated field of dynamically typed values.
|
||||
repeated Value values = 1;
|
||||
}
|
@ -0,0 +1,144 @@
|
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2008 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
syntax = "proto3";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
option cc_enable_arenas = true;
|
||||
option go_package = "google.golang.org/protobuf/types/known/timestamppb";
|
||||
option java_package = "com.google.protobuf";
|
||||
option java_outer_classname = "TimestampProto";
|
||||
option java_multiple_files = true;
|
||||
option objc_class_prefix = "GPB";
|
||||
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||
|
||||
// A Timestamp represents a point in time independent of any time zone or local
|
||||
// calendar, encoded as a count of seconds and fractions of seconds at
|
||||
// nanosecond resolution. The count is relative to an epoch at UTC midnight on
|
||||
// January 1, 1970, in the proleptic Gregorian calendar which extends the
|
||||
// Gregorian calendar backwards to year one.
|
||||
//
|
||||
// All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
|
||||
// second table is needed for interpretation, using a [24-hour linear
|
||||
// smear](https://developers.google.com/time/smear).
|
||||
//
|
||||
// The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
|
||||
// restricting to that range, we ensure that we can convert to and from [RFC
|
||||
// 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
|
||||
//
|
||||
// # Examples
|
||||
//
|
||||
// Example 1: Compute Timestamp from POSIX `time()`.
|
||||
//
|
||||
// Timestamp timestamp;
|
||||
// timestamp.set_seconds(time(NULL));
|
||||
// timestamp.set_nanos(0);
|
||||
//
|
||||
// Example 2: Compute Timestamp from POSIX `gettimeofday()`.
|
||||
//
|
||||
// struct timeval tv;
|
||||
// gettimeofday(&tv, NULL);
|
||||
//
|
||||
// Timestamp timestamp;
|
||||
// timestamp.set_seconds(tv.tv_sec);
|
||||
// timestamp.set_nanos(tv.tv_usec * 1000);
|
||||
//
|
||||
// Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
|
||||
//
|
||||
// FILETIME ft;
|
||||
// GetSystemTimeAsFileTime(&ft);
|
||||
// UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
|
||||
//
|
||||
// // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
|
||||
// // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
|
||||
// Timestamp timestamp;
|
||||
// timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
|
||||
// timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
|
||||
//
|
||||
// Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
|
||||
//
|
||||
// long millis = System.currentTimeMillis();
|
||||
//
|
||||
// Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
|
||||
// .setNanos((int) ((millis % 1000) * 1000000)).build();
|
||||
//
|
||||
// Example 5: Compute Timestamp from Java `Instant.now()`.
|
||||
//
|
||||
// Instant now = Instant.now();
|
||||
//
|
||||
// Timestamp timestamp =
|
||||
// Timestamp.newBuilder().setSeconds(now.getEpochSecond())
|
||||
// .setNanos(now.getNano()).build();
|
||||
//
|
||||
// Example 6: Compute Timestamp from current time in Python.
|
||||
//
|
||||
// timestamp = Timestamp()
|
||||
// timestamp.GetCurrentTime()
|
||||
//
|
||||
// # JSON Mapping
|
||||
//
|
||||
// In JSON format, the Timestamp type is encoded as a string in the
|
||||
// [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
|
||||
// format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
|
||||
// where {year} is always expressed using four digits while {month}, {day},
|
||||
// {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
|
||||
// seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
|
||||
// are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
|
||||
// is required. A proto3 JSON serializer should always use UTC (as indicated by
|
||||
// "Z") when printing the Timestamp type and a proto3 JSON parser should be
|
||||
// able to accept both UTC and other timezones (as indicated by an offset).
|
||||
//
|
||||
// For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
|
||||
// 01:30 UTC on January 15, 2017.
|
||||
//
|
||||
// In JavaScript, one can convert a Date object to this format using the
|
||||
// standard
|
||||
// [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
|
||||
// method. In Python, a standard `datetime.datetime` object can be converted
|
||||
// to this format using
|
||||
// [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
|
||||
// the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
|
||||
// the Joda Time's [`ISODateTimeFormat.dateTime()`](
|
||||
// http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
|
||||
// ) to obtain a formatter capable of generating timestamps in this format.
|
||||
//
|
||||
message Timestamp {
|
||||
// Represents seconds of UTC time since Unix epoch
|
||||
// 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
|
||||
// 9999-12-31T23:59:59Z inclusive.
|
||||
int64 seconds = 1;
|
||||
|
||||
// Non-negative fractions of a second at nanosecond resolution. Negative
|
||||
// second values with fractions must still have non-negative nanos values
|
||||
// that count forward in time. Must be from 0 to 999,999,999
|
||||
// inclusive.
|
||||
int32 nanos = 2;
|
||||
}
|
@ -0,0 +1,187 @@
|
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2008 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
syntax = "proto3";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
import "google/protobuf/any.proto";
|
||||
import "google/protobuf/source_context.proto";
|
||||
|
||||
option cc_enable_arenas = true;
|
||||
option java_package = "com.google.protobuf";
|
||||
option java_outer_classname = "TypeProto";
|
||||
option java_multiple_files = true;
|
||||
option objc_class_prefix = "GPB";
|
||||
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||
option go_package = "google.golang.org/protobuf/types/known/typepb";
|
||||
|
||||
// A protocol buffer message type.
|
||||
message Type {
|
||||
// The fully qualified message name.
|
||||
string name = 1;
|
||||
// The list of fields.
|
||||
repeated Field fields = 2;
|
||||
// The list of types appearing in `oneof` definitions in this type.
|
||||
repeated string oneofs = 3;
|
||||
// The protocol buffer options.
|
||||
repeated Option options = 4;
|
||||
// The source context.
|
||||
SourceContext source_context = 5;
|
||||
// The source syntax.
|
||||
Syntax syntax = 6;
|
||||
}
|
||||
|
||||
// A single field of a message type.
|
||||
message Field {
|
||||
// Basic field types.
|
||||
enum Kind {
|
||||
// Field type unknown.
|
||||
TYPE_UNKNOWN = 0;
|
||||
// Field type double.
|
||||
TYPE_DOUBLE = 1;
|
||||
// Field type float.
|
||||
TYPE_FLOAT = 2;
|
||||
// Field type int64.
|
||||
TYPE_INT64 = 3;
|
||||
// Field type uint64.
|
||||
TYPE_UINT64 = 4;
|
||||
// Field type int32.
|
||||
TYPE_INT32 = 5;
|
||||
// Field type fixed64.
|
||||
TYPE_FIXED64 = 6;
|
||||
// Field type fixed32.
|
||||
TYPE_FIXED32 = 7;
|
||||
// Field type bool.
|
||||
TYPE_BOOL = 8;
|
||||
// Field type string.
|
||||
TYPE_STRING = 9;
|
||||
// Field type group. Proto2 syntax only, and deprecated.
|
||||
TYPE_GROUP = 10;
|
||||
// Field type message.
|
||||
TYPE_MESSAGE = 11;
|
||||
// Field type bytes.
|
||||
TYPE_BYTES = 12;
|
||||
// Field type uint32.
|
||||
TYPE_UINT32 = 13;
|
||||
// Field type enum.
|
||||
TYPE_ENUM = 14;
|
||||
// Field type sfixed32.
|
||||
TYPE_SFIXED32 = 15;
|
||||
// Field type sfixed64.
|
||||
TYPE_SFIXED64 = 16;
|
||||
// Field type sint32.
|
||||
TYPE_SINT32 = 17;
|
||||
// Field type sint64.
|
||||
TYPE_SINT64 = 18;
|
||||
}
|
||||
|
||||
// Whether a field is optional, required, or repeated.
|
||||
enum Cardinality {
|
||||
// For fields with unknown cardinality.
|
||||
CARDINALITY_UNKNOWN = 0;
|
||||
// For optional fields.
|
||||
CARDINALITY_OPTIONAL = 1;
|
||||
// For required fields. Proto2 syntax only.
|
||||
CARDINALITY_REQUIRED = 2;
|
||||
// For repeated fields.
|
||||
CARDINALITY_REPEATED = 3;
|
||||
}
|
||||
|
||||
// The field type.
|
||||
Kind kind = 1;
|
||||
// The field cardinality.
|
||||
Cardinality cardinality = 2;
|
||||
// The field number.
|
||||
int32 number = 3;
|
||||
// The field name.
|
||||
string name = 4;
|
||||
// The field type URL, without the scheme, for message or enumeration
|
||||
// types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
|
||||
string type_url = 6;
|
||||
// The index of the field type in `Type.oneofs`, for message or enumeration
|
||||
// types. The first type has index 1; zero means the type is not in the list.
|
||||
int32 oneof_index = 7;
|
||||
// Whether to use alternative packed wire representation.
|
||||
bool packed = 8;
|
||||
// The protocol buffer options.
|
||||
repeated Option options = 9;
|
||||
// The field JSON name.
|
||||
string json_name = 10;
|
||||
// The string value of the default value of this field. Proto2 syntax only.
|
||||
string default_value = 11;
|
||||
}
|
||||
|
||||
// Enum type definition.
|
||||
message Enum {
|
||||
// Enum type name.
|
||||
string name = 1;
|
||||
// Enum value definitions.
|
||||
repeated EnumValue enumvalue = 2;
|
||||
// Protocol buffer options.
|
||||
repeated Option options = 3;
|
||||
// The source context.
|
||||
SourceContext source_context = 4;
|
||||
// The source syntax.
|
||||
Syntax syntax = 5;
|
||||
}
|
||||
|
||||
// Enum value definition.
|
||||
message EnumValue {
|
||||
// Enum value name.
|
||||
string name = 1;
|
||||
// Enum value number.
|
||||
int32 number = 2;
|
||||
// Protocol buffer options.
|
||||
repeated Option options = 3;
|
||||
}
|
||||
|
||||
// A protocol buffer option, which can be attached to a message, field,
|
||||
// enumeration, etc.
|
||||
message Option {
|
||||
// The option's name. For protobuf built-in options (options defined in
|
||||
// descriptor.proto), this is the short name. For example, `"map_entry"`.
|
||||
// For custom options, it should be the fully-qualified name. For example,
|
||||
// `"google.api.http"`.
|
||||
string name = 1;
|
||||
// The option's value packed in an Any message. If the value is a primitive,
|
||||
// the corresponding wrapper type defined in google/protobuf/wrappers.proto
|
||||
// should be used. If the value is an enum, it should be stored as an int32
|
||||
// value using the google.protobuf.Int32Value type.
|
||||
Any value = 2;
|
||||
}
|
||||
|
||||
// The syntax in which a protocol buffer element is defined.
|
||||
enum Syntax {
|
||||
// Syntax `proto2`.
|
||||
SYNTAX_PROTO2 = 0;
|
||||
// Syntax `proto3`.
|
||||
SYNTAX_PROTO3 = 1;
|
||||
}
|
@ -0,0 +1,123 @@
|
||||
// Protocol Buffers - Google's data interchange format
|
||||
// Copyright 2008 Google Inc. All rights reserved.
|
||||
// https://developers.google.com/protocol-buffers/
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without
|
||||
// modification, are permitted provided that the following conditions are
|
||||
// met:
|
||||
//
|
||||
// * Redistributions of source code must retain the above copyright
|
||||
// notice, this list of conditions and the following disclaimer.
|
||||
// * Redistributions in binary form must reproduce the above
|
||||
// copyright notice, this list of conditions and the following disclaimer
|
||||
// in the documentation and/or other materials provided with the
|
||||
// distribution.
|
||||
// * Neither the name of Google Inc. nor the names of its
|
||||
// contributors may be used to endorse or promote products derived from
|
||||
// this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
//
|
||||
// Wrappers for primitive (non-message) types. These types are useful
|
||||
// for embedding primitives in the `google.protobuf.Any` type and for places
|
||||
// where we need to distinguish between the absence of a primitive
|
||||
// typed field and its default value.
|
||||
//
|
||||
// These wrappers have no meaningful use within repeated fields as they lack
|
||||
// the ability to detect presence on individual elements.
|
||||
// These wrappers have no meaningful use within a map or a oneof since
|
||||
// individual entries of a map or fields of a oneof can already detect presence.
|
||||
|
||||
syntax = "proto3";
|
||||
|
||||
package google.protobuf;
|
||||
|
||||
option cc_enable_arenas = true;
|
||||
option go_package = "google.golang.org/protobuf/types/known/wrapperspb";
|
||||
option java_package = "com.google.protobuf";
|
||||
option java_outer_classname = "WrappersProto";
|
||||
option java_multiple_files = true;
|
||||
option objc_class_prefix = "GPB";
|
||||
option csharp_namespace = "Google.Protobuf.WellKnownTypes";
|
||||
|
||||
// Wrapper message for `double`.
|
||||
//
|
||||
// The JSON representation for `DoubleValue` is JSON number.
|
||||
message DoubleValue {
|
||||
// The double value.
|
||||
double value = 1;
|
||||
}
|
||||
|
||||
// Wrapper message for `float`.
|
||||
//
|
||||
// The JSON representation for `FloatValue` is JSON number.
|
||||
message FloatValue {
|
||||
// The float value.
|
||||
float value = 1;
|
||||
}
|
||||
|
||||
// Wrapper message for `int64`.
|
||||
//
|
||||
// The JSON representation for `Int64Value` is JSON string.
|
||||
message Int64Value {
|
||||
// The int64 value.
|
||||
int64 value = 1;
|
||||
}
|
||||
|
||||
// Wrapper message for `uint64`.
|
||||
//
|
||||
// The JSON representation for `UInt64Value` is JSON string.
|
||||
message UInt64Value {
|
||||
// The uint64 value.
|
||||
uint64 value = 1;
|
||||
}
|
||||
|
||||
// Wrapper message for `int32`.
|
||||
//
|
||||
// The JSON representation for `Int32Value` is JSON number.
|
||||
message Int32Value {
|
||||
// The int32 value.
|
||||
int32 value = 1;
|
||||
}
|
||||
|
||||
// Wrapper message for `uint32`.
|
||||
//
|
||||
// The JSON representation for `UInt32Value` is JSON number.
|
||||
message UInt32Value {
|
||||
// The uint32 value.
|
||||
uint32 value = 1;
|
||||
}
|
||||
|
||||
// Wrapper message for `bool`.
|
||||
//
|
||||
// The JSON representation for `BoolValue` is JSON `true` and `false`.
|
||||
message BoolValue {
|
||||
// The bool value.
|
||||
bool value = 1;
|
||||
}
|
||||
|
||||
// Wrapper message for `string`.
|
||||
//
|
||||
// The JSON representation for `StringValue` is JSON string.
|
||||
message StringValue {
|
||||
// The string value.
|
||||
string value = 1;
|
||||
}
|
||||
|
||||
// Wrapper message for `bytes`.
|
||||
//
|
||||
// The JSON representation for `BytesValue` is JSON string.
|
||||
message BytesValue {
|
||||
// The bytes value.
|
||||
bytes value = 1;
|
||||
}
|
12
src/examples/app/app_message/protoc-22.2/readme.txt
Normal file
12
src/examples/app/app_message/protoc-22.2/readme.txt
Normal file
@ -0,0 +1,12 @@
|
||||
Protocol Buffers - Google's data interchange format
|
||||
Copyright 2008 Google Inc.
|
||||
https://developers.google.com/protocol-buffers/
|
||||
This package contains a precompiled binary version of the protocol buffer
|
||||
compiler (protoc). This binary is intended for users who want to use Protocol
|
||||
Buffers in languages other than C++ but do not want to compile protoc
|
||||
themselves. To install, simply place this binary somewhere in your PATH.
|
||||
If you intend to use the included well known types then don't forget to
|
||||
copy the contents of the 'include' directory somewhere as well, for example
|
||||
into '/usr/local/include/'.
|
||||
Please refer to our official github site for more installation instructions:
|
||||
https://github.com/protocolbuffers/protobuf
|
85
src/examples/app/app_message/protos/draw_data_storage.proto
Normal file
85
src/examples/app/app_message/protos/draw_data_storage.proto
Normal file
@ -0,0 +1,85 @@
|
||||
syntax = "proto3";
|
||||
|
||||
package graphicData;
|
||||
|
||||
message RtssGraphicStorage {
|
||||
Canvas canvas = 1;
|
||||
repeated Link links = 2;
|
||||
repeated IscsFan iscsFans = 3;
|
||||
repeated Platform Platforms = 4;
|
||||
}
|
||||
|
||||
message Canvas {
|
||||
// 画布宽
|
||||
int32 width = 1;
|
||||
// 画布高
|
||||
int32 height = 2;
|
||||
// 背景色
|
||||
string backgroundColor = 3;
|
||||
// 视口变换
|
||||
Transform viewportTransform = 4;
|
||||
}
|
||||
|
||||
message Point {
|
||||
// x坐标
|
||||
float x = 1;
|
||||
// y坐标
|
||||
float y = 2;
|
||||
}
|
||||
|
||||
//变换
|
||||
message Transform {
|
||||
// 位移
|
||||
Point position = 1;
|
||||
// 缩放
|
||||
Point scale = 2;
|
||||
// 旋转弧度
|
||||
float rotation = 3;
|
||||
// 歪斜
|
||||
Point skew = 4;
|
||||
}
|
||||
|
||||
//子元素变换
|
||||
message ChildTransform {
|
||||
// 子元素名称
|
||||
string name = 1;
|
||||
// 子元素变换
|
||||
Transform transform = 2;
|
||||
}
|
||||
// 公共属性
|
||||
message CommonInfo {
|
||||
string id = 1;
|
||||
string graphicType = 2;
|
||||
Transform transform = 3;
|
||||
repeated ChildTransform childTransforms = 4;
|
||||
}
|
||||
|
||||
message Link {
|
||||
CommonInfo common = 1;
|
||||
string code = 2;
|
||||
bool curve = 3; // 是否曲线
|
||||
int32 segmentsCount = 4; // 曲线分段数
|
||||
int32 lineWidth = 5; // 线宽
|
||||
string lineColor = 6; // 线色
|
||||
repeated Point points = 7; // 点坐标列表
|
||||
}
|
||||
|
||||
message Platform {
|
||||
CommonInfo common = 1;
|
||||
string code = 2;
|
||||
bool hasdoor = 3; // 是否有屏蔽门
|
||||
int32 lineWidth = 4; // 线宽
|
||||
string lineColor = 5; // 站台线色
|
||||
string lineColorDoor = 6; // 屏蔽门线色
|
||||
Point point = 7; // 位置坐标
|
||||
float width = 8;//宽度
|
||||
float height = 9; //高度
|
||||
repeated string orbitCode = 10;//站台轨
|
||||
}
|
||||
|
||||
message IscsFan {
|
||||
CommonInfo common = 1;
|
||||
string code = 2;
|
||||
}
|
||||
|
||||
message Turnout {}
|
101
src/examples/app/graphics/GraphicDataBase.ts
Normal file
101
src/examples/app/graphics/GraphicDataBase.ts
Normal file
@ -0,0 +1,101 @@
|
||||
import * as pb_1 from 'google-protobuf';
|
||||
import {
|
||||
ChildTransform,
|
||||
GraphicData,
|
||||
GraphicTransform,
|
||||
IChildTransform,
|
||||
IGraphicTransform,
|
||||
} from 'src/jlgraphic';
|
||||
import { toStorageTransform } from '..';
|
||||
import { graphicData } from '../protos/draw_data_storage';
|
||||
|
||||
export interface ICommonInfo {
|
||||
id: string;
|
||||
graphicType: string;
|
||||
transform: IGraphicTransform;
|
||||
childTransforms: IChildTransform[];
|
||||
}
|
||||
|
||||
export interface IProtoGraphicData extends pb_1.Message {
|
||||
common: ICommonInfo;
|
||||
code: string;
|
||||
}
|
||||
|
||||
export abstract class GraphicDataBase implements GraphicData {
|
||||
_data: IProtoGraphicData;
|
||||
constructor(data: IProtoGraphicData) {
|
||||
this._data = data;
|
||||
}
|
||||
|
||||
static defaultCommonInfo(): graphicData.CommonInfo {
|
||||
return new graphicData.CommonInfo({
|
||||
id: '',
|
||||
graphicType: '',
|
||||
transform: new graphicData.Transform({
|
||||
position: new graphicData.Point({ x: 0, y: 0 }),
|
||||
scale: new graphicData.Point({ x: 1, y: 1 }),
|
||||
rotation: 0,
|
||||
skew: new graphicData.Point({ x: 0, y: 0 }),
|
||||
}),
|
||||
childTransforms: [],
|
||||
});
|
||||
}
|
||||
|
||||
getData<D extends IProtoGraphicData>(): D {
|
||||
return this._data as D;
|
||||
}
|
||||
|
||||
get id(): string {
|
||||
return this._data.common.id;
|
||||
}
|
||||
set id(v: string) {
|
||||
this._data.common.id = v;
|
||||
}
|
||||
get graphicType(): string {
|
||||
return this._data.common.graphicType;
|
||||
}
|
||||
set graphicType(v: string) {
|
||||
this._data.common.graphicType = v;
|
||||
}
|
||||
get transform(): GraphicTransform {
|
||||
return GraphicTransform.from(this._data.common.transform);
|
||||
}
|
||||
set transform(v: GraphicTransform) {
|
||||
this._data.common.transform = toStorageTransform(v);
|
||||
}
|
||||
get childTransforms(): ChildTransform[] | undefined {
|
||||
const cts: ChildTransform[] = [];
|
||||
if (this._data.common.childTransforms) {
|
||||
this._data.common.childTransforms.forEach((ct) => {
|
||||
cts.push(ChildTransform.from(ct));
|
||||
});
|
||||
}
|
||||
return cts;
|
||||
}
|
||||
set childTransforms(v: ChildTransform[] | undefined) {
|
||||
if (v) {
|
||||
const cts: graphicData.ChildTransform[] = [];
|
||||
v.forEach((ct) =>
|
||||
cts.push(
|
||||
new graphicData.ChildTransform({
|
||||
...ct,
|
||||
transform: toStorageTransform(ct.transform),
|
||||
})
|
||||
)
|
||||
);
|
||||
this._data.common.childTransforms = cts;
|
||||
} else {
|
||||
this._data.common.childTransforms = [];
|
||||
}
|
||||
}
|
||||
|
||||
clone(): GraphicData {
|
||||
throw new Error('Method not implemented.');
|
||||
}
|
||||
copyFrom(gd: GraphicDataBase): void {
|
||||
pb_1.Message.copyInto(gd._data, this._data);
|
||||
}
|
||||
eq(other: GraphicDataBase): boolean {
|
||||
return pb_1.Message.equals(this._data, other._data);
|
||||
}
|
||||
}
|
38
src/examples/app/graphics/IscsFanInteraction.ts
Normal file
38
src/examples/app/graphics/IscsFanInteraction.ts
Normal file
@ -0,0 +1,38 @@
|
||||
import * as pb_1 from 'google-protobuf';
|
||||
import { IIscsFanData } from 'src/graphics/iscs-fan/IscsFan';
|
||||
import { graphicData } from '../protos/draw_data_storage';
|
||||
import { GraphicDataBase } from './GraphicDataBase';
|
||||
|
||||
export class IscsFanData extends GraphicDataBase implements IIscsFanData {
|
||||
constructor(data?: graphicData.IscsFan) {
|
||||
let fan;
|
||||
if (data) {
|
||||
fan = data;
|
||||
} else {
|
||||
fan = new graphicData.IscsFan({
|
||||
common: GraphicDataBase.defaultCommonInfo(),
|
||||
});
|
||||
}
|
||||
super(fan);
|
||||
}
|
||||
|
||||
public get data(): graphicData.IscsFan {
|
||||
return this.getData<graphicData.IscsFan>();
|
||||
}
|
||||
|
||||
get code(): string {
|
||||
return this.data.code;
|
||||
}
|
||||
set code(v: string) {
|
||||
this.data.code = v;
|
||||
}
|
||||
clone(): IscsFanData {
|
||||
return new IscsFanData(this.data.cloneMessage());
|
||||
}
|
||||
copyFrom(data: IscsFanData): void {
|
||||
pb_1.Message.copyInto(data.data, this.data);
|
||||
}
|
||||
eq(other: IscsFanData): boolean {
|
||||
return pb_1.Message.equals(this.data, other.data);
|
||||
}
|
||||
}
|
77
src/examples/app/graphics/LinkInteraction.ts
Normal file
77
src/examples/app/graphics/LinkInteraction.ts
Normal file
@ -0,0 +1,77 @@
|
||||
import * as pb_1 from 'google-protobuf';
|
||||
import { IPointData } from 'pixi.js';
|
||||
import { ILinkData } from 'src/graphics/link/Link';
|
||||
import { graphicData } from '../protos/draw_data_storage';
|
||||
import { GraphicDataBase } from './GraphicDataBase';
|
||||
|
||||
export class LinkData extends GraphicDataBase implements ILinkData {
|
||||
constructor(data?: graphicData.Link) {
|
||||
let link;
|
||||
if (!data) {
|
||||
link = new graphicData.Link({
|
||||
common: GraphicDataBase.defaultCommonInfo(),
|
||||
});
|
||||
} else {
|
||||
link = data;
|
||||
}
|
||||
super(link);
|
||||
}
|
||||
|
||||
public get data(): graphicData.Link {
|
||||
return this.getData<graphicData.Link>();
|
||||
}
|
||||
|
||||
get code(): string {
|
||||
return this.data.code;
|
||||
}
|
||||
set code(v: string) {
|
||||
this.data.code = v;
|
||||
}
|
||||
get curve(): boolean {
|
||||
return this.data.curve;
|
||||
}
|
||||
set curve(v: boolean) {
|
||||
this.data.curve = v;
|
||||
}
|
||||
get curveNumber(): number {
|
||||
return this.data.curve ? 1 : 0;
|
||||
}
|
||||
set curveNumber(v: number) {
|
||||
this.data.curve = v === 0 ? false : true;
|
||||
}
|
||||
get segmentsCount(): number {
|
||||
return this.data.segmentsCount;
|
||||
}
|
||||
set segmentsCount(v: number) {
|
||||
this.data.segmentsCount = v;
|
||||
}
|
||||
get points(): IPointData[] {
|
||||
return this.data.points;
|
||||
}
|
||||
set points(points: IPointData[]) {
|
||||
this.data.points = points.map(
|
||||
(p) => new graphicData.Point({ x: p.x, y: p.y })
|
||||
);
|
||||
}
|
||||
get lineWidth(): number {
|
||||
return this.data.lineWidth;
|
||||
}
|
||||
set lineWidth(v: number) {
|
||||
this.data.lineWidth = v;
|
||||
}
|
||||
get lineColor(): string {
|
||||
return this.data.lineColor;
|
||||
}
|
||||
set lineColor(v: string) {
|
||||
this.data.lineColor = v;
|
||||
}
|
||||
clone(): LinkData {
|
||||
return new LinkData(this.data.cloneMessage());
|
||||
}
|
||||
copyFrom(data: LinkData): void {
|
||||
pb_1.Message.copyInto(data.data, this.data);
|
||||
}
|
||||
eq(other: LinkData): boolean {
|
||||
return pb_1.Message.equals(this.data, other.data);
|
||||
}
|
||||
}
|
82
src/examples/app/graphics/PlatformInteraction.ts
Normal file
82
src/examples/app/graphics/PlatformInteraction.ts
Normal file
@ -0,0 +1,82 @@
|
||||
import * as pb_1 from 'google-protobuf';
|
||||
import { IPointData } from 'pixi.js';
|
||||
import { IPlatformData } from 'src/graphics/platform/Platform';
|
||||
import { graphicData } from '../protos/draw_data_storage';
|
||||
import { GraphicDataBase } from './GraphicDataBase';
|
||||
|
||||
export class PlatformData extends GraphicDataBase implements IPlatformData {
|
||||
constructor(data?: graphicData.Platform) {
|
||||
let platform;
|
||||
if (!data) {
|
||||
platform = new graphicData.Platform({
|
||||
common: GraphicDataBase.defaultCommonInfo(),
|
||||
});
|
||||
} else {
|
||||
platform = data;
|
||||
}
|
||||
super(platform);
|
||||
}
|
||||
|
||||
public get data(): graphicData.Platform {
|
||||
return this.getData<graphicData.Platform>();
|
||||
}
|
||||
|
||||
get code(): string {
|
||||
return this.data.code;
|
||||
}
|
||||
set code(v: string) {
|
||||
this.data.code = v;
|
||||
}
|
||||
get hasdoor(): boolean {
|
||||
return this.data.hasdoor;
|
||||
}
|
||||
set hasdoor(v: boolean) {
|
||||
this.data.hasdoor = v;
|
||||
}
|
||||
get lineWidth(): number {
|
||||
return this.data.lineWidth;
|
||||
}
|
||||
set lineWidth(v: number) {
|
||||
this.data.lineWidth = v;
|
||||
}
|
||||
get lineColor(): string {
|
||||
return this.data.lineColor;
|
||||
}
|
||||
set lineColor(v: string) {
|
||||
this.data.lineColor = v;
|
||||
}
|
||||
get lineColorDoor(): string {
|
||||
return this.data.lineColorDoor;
|
||||
}
|
||||
set lineColorDoor(v: string) {
|
||||
this.data.lineColorDoor = v;
|
||||
}
|
||||
get point(): IPointData {
|
||||
return this.data.point;
|
||||
}
|
||||
set point(point: IPointData) {
|
||||
this.data.point = new graphicData.Point({ x: point.x, y: point.y });
|
||||
}
|
||||
get width(): number {
|
||||
return this.data.width;
|
||||
}
|
||||
set width(v: number) {
|
||||
this.data.width = v;
|
||||
}
|
||||
get height(): number {
|
||||
return this.data.height;
|
||||
}
|
||||
set height(v: number) {
|
||||
this.data.height = v;
|
||||
}
|
||||
|
||||
clone(): PlatformData {
|
||||
return new PlatformData(this.data.cloneMessage());
|
||||
}
|
||||
copyFrom(data: PlatformData): void {
|
||||
pb_1.Message.copyInto(data.data, this.data);
|
||||
}
|
||||
eq(other: PlatformData): boolean {
|
||||
return pb_1.Message.equals(this.data, other.data);
|
||||
}
|
||||
}
|
223
src/examples/app/index.ts
Normal file
223
src/examples/app/index.ts
Normal file
@ -0,0 +1,223 @@
|
||||
import { fromUint8Array, toUint8Array } from 'js-base64';
|
||||
import { IPointData, Point } from 'pixi.js';
|
||||
import { IscsFan } from 'src/graphics/iscs-fan/IscsFan';
|
||||
import { IscsFanDraw } from 'src/graphics/iscs-fan/IscsFanDrawAssistant';
|
||||
import { Link } from 'src/graphics/link/Link';
|
||||
import { LinkDraw } from 'src/graphics/link/LinkDrawAssistant';
|
||||
import { Platform } from 'src/graphics/platform/Platform';
|
||||
import { PlatformDraw } from 'src/graphics/platform/PlatformDrawAssistant';
|
||||
import {
|
||||
CombinationKey,
|
||||
GraphicApp,
|
||||
GraphicData,
|
||||
GraphicTransform,
|
||||
JlDrawApp,
|
||||
KeyListener,
|
||||
} from 'src/jlgraphic';
|
||||
import { ContextMenu } from 'src/jlgraphic/ui/ContextMenu';
|
||||
import { MenuItemOptions } from 'src/jlgraphic/ui/Menu';
|
||||
import { IscsFanData } from './graphics/IscsFanInteraction';
|
||||
import { LinkData } from './graphics/LinkInteraction';
|
||||
import { PlatformData } from './graphics/PlatformInteraction';
|
||||
import { graphicData } from './protos/draw_data_storage';
|
||||
|
||||
export function fromStoragePoint(p: graphicData.Point): Point {
|
||||
return new Point(p.x, p.y);
|
||||
}
|
||||
|
||||
export function toStoragePoint(p: IPointData): graphicData.Point {
|
||||
return new graphicData.Point({ x: p.x, y: p.y });
|
||||
}
|
||||
|
||||
export function fromStorageTransfrom(
|
||||
transfrom: graphicData.Transform
|
||||
): GraphicTransform {
|
||||
return new GraphicTransform(
|
||||
fromStoragePoint(transfrom.position),
|
||||
fromStoragePoint(transfrom.scale),
|
||||
transfrom.rotation,
|
||||
fromStoragePoint(transfrom.skew)
|
||||
);
|
||||
}
|
||||
|
||||
export function toStorageTransform(
|
||||
transform: GraphicTransform
|
||||
): graphicData.Transform {
|
||||
return new graphicData.Transform({
|
||||
position: toStoragePoint(transform.position),
|
||||
scale: toStoragePoint(transform.scale),
|
||||
rotation: transform.rotation,
|
||||
skew: toStoragePoint(transform.skew),
|
||||
});
|
||||
}
|
||||
|
||||
const UndoOptions: MenuItemOptions = {
|
||||
name: '撤销',
|
||||
};
|
||||
const RedoOptions: MenuItemOptions = {
|
||||
name: '重做',
|
||||
};
|
||||
const SelectAllOptions: MenuItemOptions = {
|
||||
name: '全选',
|
||||
};
|
||||
|
||||
export const DefaultCanvasMenu = new ContextMenu({
|
||||
name: '绘制-画布菜单',
|
||||
groups: [
|
||||
{
|
||||
items: [UndoOptions, RedoOptions],
|
||||
},
|
||||
{
|
||||
items: [SelectAllOptions],
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
let drawApp: JlDrawApp | null = null;
|
||||
|
||||
export function getDrawApp(): JlDrawApp | null {
|
||||
return drawApp;
|
||||
}
|
||||
|
||||
export function destroyDrawApp(): void {
|
||||
if (drawApp) {
|
||||
drawApp.destroy();
|
||||
drawApp = null;
|
||||
}
|
||||
}
|
||||
|
||||
export function initDrawApp(dom: HTMLElement): JlDrawApp {
|
||||
drawApp = new JlDrawApp(dom);
|
||||
const app = drawApp;
|
||||
app.setOptions({
|
||||
drawAssistants: [
|
||||
new LinkDraw(app, () => {
|
||||
return new LinkData();
|
||||
}),
|
||||
new IscsFanDraw(app, () => {
|
||||
return new IscsFanData();
|
||||
}),
|
||||
new PlatformDraw(app, () => {
|
||||
return new PlatformData();
|
||||
}),
|
||||
],
|
||||
});
|
||||
|
||||
// 画布右键菜单
|
||||
app.registerMenu(DefaultCanvasMenu);
|
||||
app.canvas.on('_rightclick', (e) => {
|
||||
if (app._drawing) return;
|
||||
UndoOptions.disabled = !app.opRecord.hasUndo;
|
||||
RedoOptions.disabled = !app.opRecord.hasRedo;
|
||||
UndoOptions.handler = () => {
|
||||
app.opRecord.undo();
|
||||
};
|
||||
RedoOptions.handler = () => {
|
||||
app.opRecord.redo();
|
||||
};
|
||||
SelectAllOptions.handler = () => {
|
||||
app.selectAllGraphics();
|
||||
};
|
||||
DefaultCanvasMenu.open(e.global);
|
||||
});
|
||||
|
||||
app.addKeyboardListener(
|
||||
new KeyListener({
|
||||
value: 'KeyL',
|
||||
onPress: () => {
|
||||
app.interactionPlugin(Link.Type).resume();
|
||||
},
|
||||
})
|
||||
);
|
||||
app.addKeyboardListener(
|
||||
new KeyListener({
|
||||
value: 'KeyF',
|
||||
onPress: () => {
|
||||
app.interactionPlugin(IscsFan.Type).resume();
|
||||
},
|
||||
})
|
||||
);
|
||||
app.addKeyboardListener(
|
||||
new KeyListener({
|
||||
value: 'KeyP',
|
||||
onPress: () => {
|
||||
app.interactionPlugin(Platform.Type).resume();
|
||||
},
|
||||
})
|
||||
);
|
||||
app.addKeyboardListener(
|
||||
new KeyListener({
|
||||
value: '1',
|
||||
onPress: () => {
|
||||
app.queryStore.queryByType<IscsFan>(IscsFan.Type).forEach((fan) => {
|
||||
fan.__state = fan.__state + 1;
|
||||
fan.__state = fan.__state % 5;
|
||||
fan.repaint();
|
||||
});
|
||||
},
|
||||
})
|
||||
);
|
||||
app.addKeyboardListener(
|
||||
new KeyListener({
|
||||
value: 'KeyS',
|
||||
global: true,
|
||||
combinations: [CombinationKey.Ctrl],
|
||||
onPress: () => {
|
||||
saveDrawDatas(app);
|
||||
},
|
||||
})
|
||||
);
|
||||
return drawApp;
|
||||
}
|
||||
|
||||
const StorageKey = 'graphic-storage';
|
||||
export function saveDrawDatas(app: JlDrawApp) {
|
||||
const storage = new graphicData.RtssGraphicStorage();
|
||||
const canvasData = app.canvas.saveData();
|
||||
storage.canvas = new graphicData.Canvas({
|
||||
...canvasData,
|
||||
viewportTransform: toStorageTransform(canvasData.viewportTransform),
|
||||
});
|
||||
const graphics = app.queryStore.getAllGraphics();
|
||||
graphics.forEach((g) => {
|
||||
if (Link.Type === g.type) {
|
||||
const linkData = (g as Link).saveData();
|
||||
storage.links.push((linkData as LinkData).data);
|
||||
} else if (IscsFan.Type === g.type) {
|
||||
const IscsFanData = (g as IscsFan).saveData();
|
||||
storage.iscsFans.push((IscsFanData as IscsFanData).data);
|
||||
} else if (Platform.Type === g.type) {
|
||||
const platformData = (g as Platform).saveData();
|
||||
storage.Platforms.push((platformData as PlatformData).data);
|
||||
}
|
||||
});
|
||||
const base64 = fromUint8Array(storage.serialize());
|
||||
console.log('保存数据', storage);
|
||||
localStorage.setItem(StorageKey, base64);
|
||||
}
|
||||
|
||||
export function loadDrawDatas(app: GraphicApp) {
|
||||
// localStorage.removeItem(StorageKey);
|
||||
const base64 = localStorage.getItem(StorageKey);
|
||||
// console.log('加载数据', base64);
|
||||
if (base64) {
|
||||
const storage = graphicData.RtssGraphicStorage.deserialize(
|
||||
toUint8Array(base64)
|
||||
);
|
||||
console.log('加载数据', storage);
|
||||
app.updateCanvas(storage.canvas);
|
||||
const datas: GraphicData[] = [];
|
||||
storage.links.forEach((link) => {
|
||||
datas.push(new LinkData(link));
|
||||
});
|
||||
storage.iscsFans.forEach((fan) => {
|
||||
datas.push(new IscsFanData(fan));
|
||||
});
|
||||
storage.Platforms.forEach((platform) => {
|
||||
datas.push(new PlatformData(platform));
|
||||
});
|
||||
app.loadGraphic(datas);
|
||||
} else {
|
||||
app.loadGraphic([]);
|
||||
}
|
||||
}
|
1334
src/examples/app/protos/draw_data_storage.ts
Normal file
1334
src/examples/app/protos/draw_data_storage.ts
Normal file
File diff suppressed because it is too large
Load Diff
125
src/graphics/iscs-fan/IscsFan.ts
Normal file
125
src/graphics/iscs-fan/IscsFan.ts
Normal file
@ -0,0 +1,125 @@
|
||||
import {
|
||||
GraphicAnimation,
|
||||
GraphicData,
|
||||
JlGraphic,
|
||||
JlGraphicTemplate,
|
||||
} from 'src/jlgraphic';
|
||||
import ISCS_FAN_Assets from './iscs-fan-spritesheet.png';
|
||||
import ISCS_FAN_JSON from './iscs-fan-data.json';
|
||||
|
||||
import { Assets, Sprite, Spritesheet, Texture } from 'pixi.js';
|
||||
|
||||
interface FanTextures {
|
||||
border: Texture;
|
||||
blue: Texture;
|
||||
gray: Texture;
|
||||
green: Texture;
|
||||
red: Texture;
|
||||
yellow: Texture;
|
||||
}
|
||||
|
||||
export interface IIscsFanData extends GraphicData {
|
||||
get code(): string;
|
||||
set code(v: string);
|
||||
}
|
||||
|
||||
export class IscsFan extends JlGraphic {
|
||||
static Type = 'IscsFan';
|
||||
_border: Sprite;
|
||||
_fan: Sprite;
|
||||
fanTextures: FanTextures;
|
||||
__state = 0;
|
||||
|
||||
constructor(fanTextures: FanTextures) {
|
||||
super(IscsFan.Type);
|
||||
this.fanTextures = fanTextures;
|
||||
this._border = new Sprite();
|
||||
this._border.texture = this.fanTextures.border;
|
||||
this._border.anchor.set(0.5);
|
||||
this._fan = new Sprite();
|
||||
this._fan.texture = this.fanTextures.gray;
|
||||
this._fan.anchor.set(0.5);
|
||||
this.addChild(this._border);
|
||||
this.addChild(this._fan);
|
||||
}
|
||||
doRepaint(): void {
|
||||
if (this.__state === 0) {
|
||||
// 停止
|
||||
this.stopFanRun();
|
||||
this._fan.rotation = 0;
|
||||
this._fan.texture = this.fanTextures.gray;
|
||||
} else if (this.__state === 1) {
|
||||
// 正常运行
|
||||
this._fan.texture = this.fanTextures.green;
|
||||
// 动画
|
||||
this.initFanRun();
|
||||
} else if (this.__state === 2) {
|
||||
// 报警运行
|
||||
this._fan.texture = this.fanTextures.yellow;
|
||||
// 动画
|
||||
this.initFanRun();
|
||||
} else if (this.__state === 3) {
|
||||
// 故障
|
||||
this.stopFanRun();
|
||||
this._fan.rotation = 0;
|
||||
this._fan.texture = this.fanTextures.red;
|
||||
} else if (this.__state === 4) {
|
||||
// 通信故障
|
||||
// 停止
|
||||
this.stopFanRun();
|
||||
this._fan.rotation = 0;
|
||||
this._fan.texture = this.fanTextures.blue;
|
||||
}
|
||||
}
|
||||
initFanRun() {
|
||||
// 动画
|
||||
const name = 'fan_run';
|
||||
let fanRun = this.animation(name);
|
||||
if (!fanRun) {
|
||||
fanRun = GraphicAnimation.init({
|
||||
name: 'fan_run',
|
||||
run: (dt: number) => {
|
||||
this._fan.angle = (this._fan.angle + dt) % 360;
|
||||
},
|
||||
});
|
||||
this.addAnimation(fanRun);
|
||||
}
|
||||
const speed = Math.round(Math.random() * 10) + 1;
|
||||
fanRun.xSpeed = speed;
|
||||
fanRun.resume();
|
||||
}
|
||||
stopFanRun() {
|
||||
const name = 'fan_run';
|
||||
const fanRun = this.animation(name);
|
||||
if (fanRun) {
|
||||
fanRun.pause();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export class IscsFanTemplate extends JlGraphicTemplate<IscsFan> {
|
||||
fanTextures?: FanTextures;
|
||||
constructor() {
|
||||
super(IscsFan.Type);
|
||||
}
|
||||
new(): IscsFan {
|
||||
if (this.fanTextures) {
|
||||
return new IscsFan(this.fanTextures);
|
||||
}
|
||||
throw new Error('资源未加载/加载失败');
|
||||
}
|
||||
async loadAssets(): Promise<FanTextures> {
|
||||
const texture = await Assets.load(ISCS_FAN_Assets);
|
||||
const iscsFanSheet = new Spritesheet(texture, ISCS_FAN_JSON);
|
||||
const result = await iscsFanSheet.parse();
|
||||
this.fanTextures = {
|
||||
border: result['fan-border.png'],
|
||||
blue: result['fan-blue.png'],
|
||||
gray: result['fan-gray.png'],
|
||||
green: result['fan-green.png'],
|
||||
red: result['fan-red.png'],
|
||||
yellow: result['fan-yellow.png'],
|
||||
};
|
||||
return this.fanTextures as FanTextures;
|
||||
}
|
||||
}
|
77
src/graphics/iscs-fan/IscsFanDrawAssistant.ts
Normal file
77
src/graphics/iscs-fan/IscsFanDrawAssistant.ts
Normal file
@ -0,0 +1,77 @@
|
||||
import { FederatedMouseEvent, Point } from 'pixi.js';
|
||||
import {
|
||||
GraphicDrawAssistant,
|
||||
GraphicInteractionPlugin,
|
||||
JlDrawApp,
|
||||
JlGraphic,
|
||||
} from 'src/jlgraphic';
|
||||
import { IIscsFanData, IscsFan, IscsFanTemplate } from './IscsFan';
|
||||
|
||||
export class IscsFanDraw extends GraphicDrawAssistant<
|
||||
IscsFanTemplate,
|
||||
IIscsFanData
|
||||
> {
|
||||
_iscsFan: IscsFan | null = null;
|
||||
|
||||
constructor(app: JlDrawApp, createData: () => IIscsFanData) {
|
||||
const template = new IscsFanTemplate();
|
||||
super(app, template, createData, IscsFan.Type, '风机');
|
||||
IscsFanInteraction.init(app);
|
||||
}
|
||||
|
||||
bind(): void {
|
||||
super.bind();
|
||||
if (!this._iscsFan) {
|
||||
this._iscsFan = this.graphicTemplate.new();
|
||||
this.container.addChild(this._iscsFan);
|
||||
}
|
||||
}
|
||||
|
||||
public get iscsFan(): IscsFan {
|
||||
if (!this._iscsFan) {
|
||||
throw new Error('风机绘制逻辑异常');
|
||||
}
|
||||
return this._iscsFan;
|
||||
}
|
||||
|
||||
redraw(cp: Point): void {
|
||||
this.iscsFan.position.copyFrom(cp);
|
||||
}
|
||||
onLeftUp(e: FederatedMouseEvent): void {
|
||||
this.iscsFan.position.copyFrom(this.toCanvasCoordinates(e.global));
|
||||
this.createAndStore(false);
|
||||
}
|
||||
prepareData(data: IIscsFanData): boolean {
|
||||
data.transform = this.iscsFan.saveTransform();
|
||||
return true;
|
||||
}
|
||||
onEsc(): void {
|
||||
this.finish();
|
||||
}
|
||||
}
|
||||
|
||||
export class IscsFanInteraction extends GraphicInteractionPlugin<IscsFan> {
|
||||
static Name = 'iscs_fan_transform';
|
||||
constructor(app: JlDrawApp) {
|
||||
super(IscsFanInteraction.Name, app);
|
||||
}
|
||||
static init(app: JlDrawApp) {
|
||||
return new IscsFanInteraction(app);
|
||||
}
|
||||
filter(...grahpics: JlGraphic[]): IscsFan[] | undefined {
|
||||
return grahpics
|
||||
.filter((g) => g.type === IscsFan.Type)
|
||||
.map((g) => g as IscsFan);
|
||||
}
|
||||
bind(g: IscsFan): void {
|
||||
g.eventMode = 'static';
|
||||
g.cursor = 'pointer';
|
||||
g.scalable = true;
|
||||
g.rotatable = true;
|
||||
}
|
||||
unbind(g: IscsFan): void {
|
||||
g.eventMode = 'none';
|
||||
g.scalable = false;
|
||||
g.rotatable = false;
|
||||
}
|
||||
}
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user