跳转到内容

签名关联类型:BevyFocusTransition – BooleanSettingDefinition

本页由当前 SDK 声明自动生成。

返回接口索引

BevyFocusTransition · BevyHistoryDotState · BevyHistoryStripDot · BevyHistoryStripPresentation · BevyHover · BevyImageFocus · BevyModelEditor · BevyModelFocus · BevyModelReference · BevyNodeAction · BevyNodeActionsPresentation · BevyNodeChrome · BevyNodeHover · BevyNodeKind · BevyRenderDraft · BevyRenderEdge · BevyRenderMarquee · BevyRenderNode · BevyRenderSelection · BevyRenderSurface · BevyRuntime · BevyShotCamera · BevyVideoFocus · BooleanSettingDefinition

BevyFocusTransition

export type BevyFocusTransition = {
version: FocusTransitionVersion;
nodeId: string;
kind: string;
progress: number;
runtimeGeneration: number;
transitionId: number;
};

关联类型:FocusTransitionVersion

成员说明:

  • nodeId:目标节点 id(必须与当前聚焦目标一致才生效)。
  • kind:目标 kind(model / image / video / extension)。
  • progress:0..1 原始进度(未缓动;缓动由两侧共享 smoothstep 施加)。
  • runtimeGeneration:前端 runtime generation;旧代更小值被丢弃。
  • transitionId:过渡身份(同一连续聚焦旅程内递增;诊断与去重)。

BevyHistoryDotState

历史条圆点状态。

与 run-state 的操作状态对应但收敛为底条可表达的最小集合: 成功绿点、失败红点、执行中呼吸点、排队/取消/中断/部分成功的可区分语义。

export type BevyHistoryDotState = "succeeded" | "failed" | "running" | "queued" | "cancelled" | "interrupted" | "partial";

BevyHistoryStripDot

单个历史条圆点。

current 表示该圆点对应的版本是节点当前生效版本,由独立装饰(外圈)表达, MUST NOT 挤占状态颜色。

export type BevyHistoryStripDot = {
selected?: boolean;
hovered?: boolean;
pressed?: boolean;
unseen?: boolean;
presentationId?: string;
operationId?: string;
recoverable?: boolean;
state: BevyHistoryDotState;
current: boolean;
entryId?: string;
};

关联类型:BevyHistoryDotState

成员说明:

  • selected:Local preview selection and pointer feedback, independent of canonical current.
  • unseen:New terminal version the user has not inspected yet; drawn as a small corner badge.

BevyHistoryStripPresentation

节点底部历史条呈现。

只承载渲染所需的圆点状态与折叠计数;完整历史列表与详情经受控历史接口按需读取。

export type BevyHistoryStripPresentation = {
dots: BevyHistoryStripDot[];
truncated: number;
};

关联类型:BevyHistoryStripDot

成员说明:

  • dots:按 createdAt 升序的圆点(有界)。
  • truncated:被折叠(未绘制)的较早记录数;>0 时底条显示折叠提示。

BevyHover

指针悬停态:节点或连线;null 表示无悬停。

export type BevyHover = BevyNodeHover | BevyEdgeHover;

关联类型:BevyNodeHover · BevyEdgeHover

成员说明:

  • cursor:Pointer world position; the delete control follows the selected curve. Pointer world position for bounded magnetic port feedback.

BevyImageFocus

export type BevyImageFocus = {
version: ImageFocusVersion;
nodeId: string;
presentationReady?: boolean;
viewport: {
x: number;
y: number;
zoom: number;
};
sourceWidth: number;
sourceHeight: number;
documentView?: {
sourceWidth: number;
sourceHeight: number;
viewport: {
x: number;
y: number;
zoom: number;
};
};
};

关联类型:ImageFocusVersion

成员说明:

  • presentationReady:入场完成后切换遮罩与节点外框;省略时兼容既有聚焦呈现。
  • viewport:本地二维取景:zoom 为「1 源像素 = zoom 个 CSS px」,x/y 为画布局部平移(CSS px)。 由前端依据可用内容矩形与源尺寸计算,Bevy 只消费。
  • sourceWidth:源像素尺寸(用于 fit/清晰度判定与校验)。
  • documentView:捕获整块编辑视口时,相机仍跟随文档本身的取景,纹理按 viewport 独立对齐。

BevyModelEditor

export type BevyModelEditor = {
version: ModelEditorVersion;
nodeId: string;
toolMode: "model" | "camera";
grid?: {
origin: [
number,
number,
number
];
spacing: number;
};
feedback?: GizmoFeedback;
cameraTool?: "orbit" | "elevation" | "distance" | "focus";
cameraId?: string;
shot?: BevyShotCamera;
focus: [
number,
number,
number
];
radius: number;
};

关联类型:ModelEditorVersion · GizmoFeedback · BevyShotCamera

成员说明:

  • version:schema 版本;Bevy 据此校验。
  • nodeId:编辑目标 canonical 模型 nodeId。
  • toolMode:工具模式:整体模型 placement gizmo 或镜头 shot gizmo。
  • grid:Disposable XZ reference grid in display space.
  • cameraTool:显式镜头工具。 orbit/elevation/distance 允许主按钮在画布任意处拖动编辑选中镜头;focus 只操作注视点 gizmo。
  • cameraId:兼容旧 gizmo 手势的瞬态字段;当前没有 UI 写入。
  • focus:聚焦模型 focus(世界坐标,placement 后 AABB 中心)。
  • radius:模型包围球半径(gizmo 尺寸)。

BevyModelFocus

模型聚焦瞬时投影。

这是浏览器本地呈现态:只承载稳定 canonical nodeId 与本地相机 pose,用于让同一 Camera3d 切换到透视聚焦并过滤可见内容。它不进入 ServerCanvas / CanvasCommand / Y.Doc。 缺省(undefined)表示普通正交画布。

export type BevyModelFocus = ModelFocusProjection;

关联类型:ModelFocusProjection

成员说明:

  • nodeId:稳定 canonical 节点 id。
  • target:聚焦目标中心(世界空间,含 root 锚点)。
  • yaw:环绕 yaw / pitch(弧度)。
  • distance:目标到相机距离。
  • fov:垂直 FOV(弧度)。
  • radius:观察指示用的模型半径(世界单位)。

BevyModelReference

轻量模型引用。

节点只携带稳定 resourceKey;模型内容由独立的不可变资源通道 (prepare_and_register_model_resource)注册,CanvasRenderScene 不再内联 ops。signature 用于 Bevy 判断是否需要替换 ECS entity 树,sceneVersion 决定渲染语义。

世界根只使用 sharedWorldInstance.transform;modelPlacement 仍是 nodeData 上的内容/历史 快照字段,但不进入场景 wire。

export type BevyModelReference = {
groundAnchorLocal?: [
number,
number,
number
];
partPositions?: Record<string, readonly [
number,
number,
number
]>;
partRotations?: Record<string, readonly [
number,
number,
number,
number
]>;
sceneVersion: string;
resourceKey: string;
signature: string;
};

成员说明:

  • groundAnchorLocal:Stable bind-pose anchor in asset XYZ; editor projects it onto world ground.
  • partPositions:Local additive joint/group rotations; model axes, normalized xyzw quaternion.
  • sceneVersion:Scene IR 版本(V1 或 V2);显式携带以便 Bevy 区分渲染语义。
  • resourceKey:按内容签名注册的资源 key(sceneVersion:signature);不含节点 id。
  • signature:模型内容签名;placement/viewport 变化时不变。

BevyNodeAction

export type BevyNodeAction = {
tone?: "primary" | "neutral";
icon?: "download" | "edit" | "box" | "arrange-horizontal" | "arrange-vertical" | "arrange-grid" | "arrange-diagonal-up" | "arrange-diagonal-down" | "collapse-groups" | "expand-groups" | "rotate-clockwise";
iconOnly?: boolean;
id: string;
label: string;
enabled: boolean;
menu?: boolean;
};

成员说明:

  • tone:通用动作强调与图标呈现。
  • id:稳定动作 ID;Rust 命中后回传,贡献据此派发。
  • label:可见文案(中文)。
  • enabled:是否可用;false 时弱化绘制,仍回传命中由贡献决定是否响应。
  • menu:是否为独立设置箭头(图片/视频转换);箭头自身是独立命中矩形。

BevyNodeActionsPresentation

节点顶部操作横条呈现。

export type BevyNodeActionsPresentation = {
actions: BevyNodeAction[];
summary?: string;
};

关联类型:BevyNodeAction

成员说明:

  • actions:从左到右排列的动作。
  • summary:节点摘要(可选,显示在动作左侧)。

BevyNodeChrome

非内容节点的画布 chrome。

  • card(缺省):普通内容卡片外壳;
  • frame:2D 组的外框,只画包围框/标签,不画内容卡片;成员身份随节点下发;
  • none:共享世界实例等只保留世界对象与选择身份,不画卡片、端口和内容底。

缺省字段保持旧 wire 兼容:旧渲染器按卡片绘制。新渲染器 MUST 在 chrome.kind 为 frame/none 时抑制通用卡片,否则导演区/2D 组/世界模型仍会露出内容卡片。

export type BevyNodeChrome = {
kind: "card";
} | {
kind: "frame";
groupId: string;
memberNodeIds: string[];
} | {
kind: "none";
};

BevyNodeHover

节点端点悬停瞬时态。

这是浏览器本地呈现态:只承载指针下的节点 id 与端点侧,用于让 Bevy 决定在哪个节点的 左右中点画「+」圆钮。它不进入 ServerCanvas / CanvasCommand / Y.Doc。

export type BevyNodeHover = {
nodeId: string;
cursor?: {
x: number;
y: number;
};
port?: "input" | "output" | null;
};

成员说明:

  • nodeId:指针下的节点 id(命中节点、关闭按钮、历史动作、端点或 resize 抓手均算悬停)。
  • cursor:Pointer world position for bounded magnetic port feedback.
  • port:指针落在某侧端点命中区时的端点侧;否则缺省/null。

BevyNodeKind

参考实现的 palette kind(决定 Bevy 中的配色与图标)。

export type BevyNodeKind = "text" | "image" | "model" | "audio" | "video" | "shot" | "node";

BevyRenderDraft

export type BevyRenderDraft = {
source: string;
side: "input" | "output";
x: number;
y: number;
};

BevyRenderEdge

export type BevyRenderEdge = {
id: string;
source: string;
target: string;
label: string;
};

BevyRenderMarquee

框选选区矩形。

世界坐标轴对齐矩形;width/height 可为负(拖拽方向决定),Bevy 会归一化。 这是浏览器本地瞬时呈现态:不进入 ServerCanvas / CanvasCommand / Y.Doc。

export type BevyRenderMarquee = {
x: number;
y: number;
width: number;
height: number;
};

BevyRenderNode

与 Rust GraphNode 对应。

export type BevyRenderNode = {
editScope?: {
category: CanvasEditScopeCategory;
mode: CanvasScopeMode;
};
sharedWorldInstance?: WorldInstanceData;
worldCamera?: WorldCameraData;
cameraShot?: WorldCameraShotState;
chrome?: BevyNodeChrome;
id: string;
type: BevyNodeKind;
x: number;
y: number;
width: number;
height: number;
body: string;
title: string;
typeLabel: string;
progress: number;
progressStartedAt?: number;
busy: boolean;
mediaLoading?: boolean;
texture: boolean;
resizable: boolean;
ghost?: boolean;
cardLabel?: string;
model?: BevyModelReference;
historyStrip?: BevyHistoryStripPresentation;
};

关联类型:CanvasEditScopeCategory · CanvasScopeMode · WorldInstanceData · WorldCameraData · WorldCameraShotState · BevyNodeChrome · BevyNodeKind · BevyModelReference · BevyHistoryStripPresentation

成员说明:

  • editScope:Browser-local category/mode used for editor filtering and lock visuals.
  • worldCamera:共享世界镜头的真实位姿与投影参数(shared-world v1)。 只承载渲染/拾取所需的相机快照;镜头卡片仍由通用节点字段表达。缺省表示该节点不是 镜头或旧场景,Bevy 不绘制视锥。
  • cameraShot:镜头卡片语义:动态镜头显示时长与 preview/ready/stale/failed。 只作为呈现投影随帧下发,不写规范文档;实时预览画面永不因为该状态变成可下载媒体。
  • chrome:可选画布 chrome;缺省为通用内容卡片。
  • body:正文内容预览(不包含作品名称;名称由 title 承载)。
  • title:主标题:作品显示名称(显式名优先、其次已提交提示词摘要、最后中文默认名) 。
  • typeLabel:次要类型标记(中文);与主标题分列布局,不挤占名称。 复合资产节点由可信 adapter 声明的业务类型名覆盖(如「片场」「游戏炼丹炉」), 否则回落通用内容类型标签。
  • progressStartedAt:该运行开始的时刻(Unix epoch 毫秒);节点进度环据此按经过时间估算。 由运行状态投影从该 run 记录(活动面板同一条记录)的 createdAt 派生,因此节点与活动面板 用的是同一个起点:刷新页面、重建渲染器或换一个渲染实例后,节点进度不会从 0 重新估算。 缺失时渲染器退回「本节点首次进入运行态」的本地时钟(旧协议帧、仅 canonical taskStatus 的任务)。 。
  • mediaLoading:浏览器媒体解码/缓冲中的瞬时状态;不表示生成任务正在运行。
  • texture:是否有可显示纹理(图片/视频封面)。
  • resizable:是否绘制四角 resize 抓手。
  • ghost:是否上传中的幽灵节点。 Rust 侧忽略该字段(serde 默认允许未知字段);前端交互/命中测试据此门禁。
  • cardLabel:卡片分类名覆盖。 默认(缺省)由 Bevy 主题 palette 按 kind 给出分类名;自包含 3D 节点用它区分 「3D 模型」与「导演场」,避免两类都显示同一分类名。
  • model:3D 模型轻量引用(仅受支持的共享世界模型且资源已准备时)。
  • historyStrip:节点下方独立历史条呈现。 普通内容节点携带;聚合节点与 group 缺失。dots 按 createdAt 升序,每个圆点的 状态与当前装饰由 run-state 摘要派生。truncated 为被折叠的较早记录数。 只承载浏览器本地派生状态,不进入 ServerCanvas / Y.Doc。

BevyRenderSelection

export type BevyRenderSelection = {
nodes: string[];
edge: string | null;
};

BevyRenderSurface

export type BevyRenderSurface = {
width: number;
height: number;
pixelRatio: number;
contentRight?: number;
contentRect?: {
x: number;
y: number;
width: number;
height: number;
};
originX?: number;
originY?: number;
};

成员说明:

  • contentRight:右侧遮挡宽度(CSS 像素)。缺省为 0,内容区铺满表面。
  • contentRect:Shared focus workspace rectangle in canvas CSS pixels.
  • originX:表面相对窗口客户区左上角的偏移(CSS 像素)。 桌面顶栏把画布往下推时,原生交换链仍覆盖整个窗口,相机视口用这个原点对齐 DOM。

BevyRuntime

export type BevyRuntime = {
getFrameCounters?(): {
generation: number;
renders: number;
updates: number;
drawCalls3d?: number;
stageQueueMs?: number;
stageQueueFrames?: number;
stagePrepareMs?: number;
stagePrepareFrames?: number;
stageRenderMs?: number;
stageRenderFrames?: number;
drawnInstances?: number;
stageMainMs?: number;
stageMainFrames?: number;
stageModelMs?: number;
stageModelFrames?: number;
pacing?: string;
previews?: string;
} | undefined;
getRuntimeIssues?(): readonly RuntimeIssue[];
subscribeRuntimeIssues?(listener: () => void): () => void;
reportRuntimeIssue?(issue: RuntimeIssue): void;
clearRuntimeIssue?(key: string): void;
retryRuntimeIssues?(): void;
subscribeRuntimeRetry?(listener: () => void): () => void;
retryVersion?(): number;
recoverRuntime?(): void;
getRenderIssues?(): readonly ModelRenderIssue[];
subscribeRenderIssues?(listener: () => void): () => void;
retryFailedModels?(): void;
isReady(): boolean;
acceptsPlayback?(): boolean;
renderedRevision(): number;
generation(): number;
getWorkDiagnostics?(): Record<string, unknown>;
acceptedScene?(): CanvasRenderScene | null;
readSceneDiagnostics?(): Promise<WorkDiagnosticResult>;
rendererBackend?(): "native" | "wasm";
runtimeHealthSnapshot?(): Record<string, unknown> | null;
lastScene?(): unknown;
interactionGeneration?(): number;
baseSceneGeneration?(): number;
setViewport?(input: {
baseSceneGeneration: number;
viewport: {
x: number;
y: number;
zoom: number;
};
}): number;
queueViewport?(input: {
baseSceneGeneration: number;
viewport: {
x: number;
y: number;
zoom: number;
};
}): void;
setObserver?(input: Omit<CanvasObserverUpdate, "version">): number;
setResourceStates?(input: Omit<import("@woohaa3/contracts").CanvasResourceStateUpdate, "version">): number;
setPositions?(input: Omit<CanvasPositionUpdate, "version">): number;
flushTextureReceipts?(): void;
textureApplied?(id: string, width: number, height: number, content: string, plane?: boolean): boolean;
setTexture(id: string, width: number, height: number, rgba: import("@woohaa3/contracts").ImagePixelSource, source?: TextureUploadSource): boolean | void;
setImageFocusDetails?(frame: ImageFocusDetails | null): void;
setModelMediaTexture(id: string, width: number, height: number, rgba: import("@woohaa3/contracts").ImagePixelSource, source?: TextureUploadSource): boolean | void;
registerModelResource(resource: PreparedModelResource): void;
setModelPayloadLeases?(keys: Iterable<string>): void;
setModelPrepareBudget?(input: {
concurrency: number;
budgetMs: number;
}): void;
advanceModelPreparation?(): void;
prepareAndRegisterModelResource?(input: {
sceneVersion: string;
ops: readonly unknown[];
opsJson?: string;
expectedSignature?: string;
expectedExtent?: number;
}): PreparedModelMetadata | null;
setScene(scene: CanvasRenderScene, resources?: ReadonlyMap<string, PreparedModelResource>): void;
queryPoint?(input: {
generation: number;
x: number;
y: number;
zoom: number;
hoveredEdgeId?: string | null;
}): QueryResult<PointHit | null>;
queryMarquee?(input: {
generation: number;
x: number;
y: number;
width: number;
height: number;
}): QueryResult<string[]>;
queryProbe?(input: {
generation: number;
source: string;
direction: "prev" | "next";
}): QueryResult<ProbeCandidate[]>;
queryDropTarget?(input: {
generation: number;
x: number;
y: number;
excludedIds?: readonly string[];
}): QueryResult<string | null>;
queryModelPick?(input: {
generation: number;
x: number;
y: number;
width: number;
height: number;
tolerance?: number;
}): QueryResult<{
nodeId: string;
target: [
number,
number,
number
];
radius: number;
} | null>;
queryModelMarquee?(input: {
generation: number;
x: number;
y: number;
width: number;
height: number;
}): QueryResult<string[]>;
queryWorldGround?(input: {
generation: number;
x: number;
y: number;
width: number;
height: number;
}): QueryResult<{
u: number;
v: number;
} | null>;
queryCameraEditorSurface?(input: {
generation: number;
x: number;
y: number;
width: number;
height: number;
}): QueryResult<import("@woohaa3/contracts").WorldPoint | null>;
queryGizmoHit?(input: GizmoQueryInput): GizmoHitResult | null;
requestCapture(input: {
generation: number;
nodeId: string;
width?: number;
height?: number;
source?: string;
}): Promise<{
rgba: Uint8Array;
width: number;
height: number;
} | null>;
shotDiagnostics(): {
rigs: number;
previewImages: number;
gizmoEntities: number;
capturesInFlight: number;
capturesQueued: number;
};
requestHistoryThumbnail?(input: {
generation: number;
sceneVersion: string;
ops: readonly unknown[];
width?: number;
height?: number;
}): Promise<HistoryThumbnailFrame | null>;
requestWorldCapture?(input: {
generation: number;
cameraId: string;
width: number;
height: number;
}): Promise<WorldCaptureFrame | null>;
dispose(): void;
};

关联类型:RuntimeIssue · ModelRenderIssue · CanvasRenderScene · WorkDiagnosticResult · CanvasObserverUpdate · CanvasResourceStateUpdate · CanvasPositionUpdate · ImagePixelSource · TextureUploadSource · ImageFocusDetails · PreparedModelResource · PreparedModelMetadata · QueryResult · PointHit · ProbeCandidate · WorldPoint · GizmoQueryInput · GizmoHitResult · HistoryThumbnailFrame · WorldCaptureFrame

成员说明:

  • getFrameCounters:性能读数读取的累计帧计数;render 完成表示调度完成,不表示 GPU 呈现确认。开发构建与桌面壳提供。
  • isReady:Bevy App 是否已 ready(字体/相机就绪)。
  • acceptsPlayback:Synchronous owner gate, without crossing the WASM boundary.
  • renderedRevision:最近已渲染的 2D revision。
  • generation:当前运行时 generation;每次 WASM 初始化递增(恢复时据此重放资源)。
  • getWorkDiagnostics:实际工作计数快照(JSON):供 E2E/排障读取(D1 卡片/边块/容器块重建计数)。
  • acceptedScene:Read-only accepted scene geometry; never serialize its content into reports.
  • readSceneDiagnostics:Bounded low frequency diagnostics. Native uses asynchronous RPC.
  • lastScene:最近提交并接受的渲染场景只读快照。 LOD 采样用它把「高优先消费者」细分为选中 / 聚焦 / 编辑 / 声明缺失; 旧 fake 可省略,缺省时采样退回笼统的 high-owner。
  • interactionGeneration:最近接受的 interaction generation;setScene 成功后更新,未接受任何场景时为 0 。 旧测试 fake 可省略;缺省时查询视为 unavailable。
  • baseSceneGeneration:最近一次完整场景接受的 base generation(base 身份) 。 纯视口增量不改动它;runtime 重启清空(返回 0)。
  • setViewport:提交一次纯视口增量(普通 overview 仅 pan/zoom) 。 成功返回新的 interaction generation;base/version/overview 不合法时抛稳定错误, 由调度器下一帧用最新 full 恢复。缺省(旧 fake/旧 WASM)视为不可用。
  • queueViewport:Native 连续导航入口;只排队,点击前由适配器同步结算最新视口。
  • setObserver:已聚焦节点的朝向增量。成功返回新的 interaction generation,不改 base。 缺省(旧 fake / 旧 WASM)时调度器回退完整 setScene。
  • flushTextureReceipts:上传/更新一张 RGBA 纹理。
  • setModelMediaTexture:上传片场媒体平面纹理。
  • registerModelResource:注册/复用一份不可变模型资源;同 generation 内相同 resourceKey 只上传一次 。
  • setModelPayloadLeases:提交当前需求持有的模型 payload lease(resource key 集合),由 Rust 按预算淘汰无 lease 的 重型 payload 并为需求内 cold 项重新准备 。 只接受已声明过的模型 key(资产/片场内容身份会被忽略)。需求集合未变化时幂等短路, 因此可在帧前导每帧调用;当前需求内的 cold payload 会在同一调用内补准备。
  • setModelPrepareBudget:覆盖模型准备的单帧并发/时间预算 。 由页面级协调器的集中策略注入:不同媒体 owner 不得各自放宽预算。未调用时用默认策略。
  • advanceModelPreparation:每帧推进有界数量的重型模型准备。 静止帧也必须调用:待准备队列由需求驱动,不能等到下一次场景提交才继续,否则大片模型 永远停在 preparing。无待办时是常量开销。
  • prepareAndRegisterModelResource:合并准备与注册:把已规范化 Scene IR 一次性交给 Rust,由其派生兼容 signature/AABB/extent、 注册资源并返回轻量 metadata。 缺新导出时返回 null(调用方保留旧 registration 隔离诊断,不回落 TS 派生)。
  • setScene:提交一份完整快照。先确保快照引用的模型资源已注册,再提交引用场景 (严格「先注册资源、后提交引用场景」)。
  • queryPoint:2D 点命中查询。调用方传入最近接受的 interaction generation;过期/未就绪时返回 ok:false,调用方 MUST NOT 回退到 TS 几何或开始手势 。 旧测试 fake 可省略;缺省时查询视为 unavailable。
  • queryMarquee:2D 框选查询(世界坐标矩形,允许负宽高)。
  • queryProbe:drag-touch probe 查询。
  • queryDropTarget:通用 drop target 查询:按既有顺序固定最上层实际节点(排除来源),只返回 identity。 ok:true 且 value=null 表示查询成功但该点无节点;ok:false 时调用方 MUST NOT 回退 TS 矩形几何或提交移动。
  • queryModelPick:普通正交画布模型 picking:返回最近 canonical 模型的 identity 与世界 bounds 。
  • queryModelMarquee:世界模型框选:x/y/width/height 为 canvas CSS 屏幕矩形;返回节点 id 列表。
  • queryCameraEditorSurface:Hit the visible model surface through the accepted perspective editor lens.
  • queryGizmoHit:模型编辑 gizmo 命中与轴拖动约束;返回稳定 handle 与(可选)屏幕轴约束 。
  • requestCapture:请求一次镜头截图并等待 RGBA 像素。 相机 pose/lens 由当前 rig 提供(调用方须先提交镜头到 canonical modelEditor.shot); 返回匹配 identity 的帧尺寸与 RGBA 字节,不支持/失败/超时返回 null。
  • shotDiagnostics:shot camera 运行时诊断快照(rig/preview/gizmo/capture 计数)。
  • requestHistoryThumbnail:请求一次模型历史缩略图并等待 RGBA 像素 。 入参是服务端权威脚本派生并校验过的 V2 Scene IR;在同一 App 内一次性离屏渲染, 不新建 App/context,也不写规范状态。不支持/失败/超时返回 null。 与 requestCapture 共用 latest-wins 单一回读通道,调用方必须串行发送。
  • requestWorldCapture:请求一次共享世界镜头捕获并等待 RGBA 像素。 只传镜头身份、输出尺寸与稳定 identity;姿态/投影由当前 Scene 解析,世界内容直接用页面 已渲染实体。返回匹配 identity 的帧尺寸与 RGBA 字节,不支持/失败/超时返回 null。 与 requestCapture / requestHistoryThumbnail 共用 latest-wins 单一回读通道,调用方必须 通过共享捕获锁串行发送。

BevyShotCamera

兼容旧 gizmo 手势的瞬态相机形状;当前没有 UI 写入。

export type BevyShotCamera = {
position: [
number,
number,
number
];
focus: [
number,
number,
number
];
fov: number;
azimuth: number;
elevation: number;
distance: number;
aspect: CameraAspect;
};

关联类型:CameraAspect

BevyVideoFocus

export type BevyVideoFocus = {
version: VideoFocusVersion;
nodeId: string;
viewport: {
x: number;
y: number;
zoom: number;
};
sourceWidth: number;
sourceHeight: number;
};

关联类型:VideoFocusVersion

成员说明:

  • viewport:本地二维取景:语义与 BevyImageFocus.viewport 一致。
  • sourceWidth:源视频像素尺寸(用于 fit/清晰度判定与校验;截帧仍按源尺寸)。

BooleanSettingDefinition

export type BooleanSettingDefinition = SettingBase & {
kind: "boolean";
default?: boolean;
};

关联类型:SettingBase

成员说明:

  • label:设置页上的名称。
  • reload:hot:运行中生效;restart:写入后需要重启进程。
  • legacyEnv:过渡期兼容的旧环境变量名;新配置项不要再声明。
  • group:设置页上的分组(插件配置项按插件分组)。
  • ownerExtensionId:声明这段配置的扩展 id(宿主装载器按插件名填入)。设置面据此把「这个配置段的启停」 放到配置旁边,而不是留在插件清单里。