跳转到内容

前端 SDK 导出:HistoryIcon – LockIcon

本页由当前 SDK 声明自动生成。 导入入口:@woohaa3/frontend/extension-api。

返回接口索引

HistoryIcon · HourglassIcon · HoverStateService · IMAGE_EDIT_SERVICE · IconButton · IconButtonProps · IdentityIcon · ImageEditService · ImageIcon · InputScopesService · InteractionController · InteractionControllerOptions · InvalidIcon · LassoIcon · LayersIcon · LayoutGridIcon · LinkIcon · Listbox · ListboxOption · ListboxProps · LoadingIcon · LocateIcon · LocateNodesResult · LockIcon

HistoryIcon

历史与撤销。

export const HistoryIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

HourglassIcon

export const HourglassIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

HoverStateService

悬停节点事实源;模型镜头编辑器已删除。

export type HoverStateService = {
getNodeId(): string | null;
subscribe(listener: () => void): () => void;
};

IMAGE_EDIT_SERVICE

图片聚焦编辑 capability(由图片编辑扩展提供) 。

宿主节点历史只依赖本契约读取活动文档身份、草稿状态与只读历史预览,不判断扩展 id、也不 import 具体编辑器。缺少 provider(扩展停用或尚未加载)时历史列表仍可浏览,预览与草稿 提示按「不可用」降级。

export const IMAGE_EDIT_SERVICE: "imageEdit";

IconButton

紧凑图标按钮。默认图标 aria-hidden;label 是唯一的可访问名称来源。 陌生操作由调用方用 Tooltip 包裹本组件提供可见说明。

export const IconButton: React.ForwardRefExoticComponent<Omit<ButtonHTMLAttributes<HTMLButtonElement>, "type" | "children"> & { label: string; size?: ButtonSize; tone?: ButtonTone; loading?: boolean; children: ReactNode; pressed?: boolean; type?: "button" | "submit" | "reset"; } & React.RefAttributes<HTMLButtonElement>>;

关联类型:ButtonSize · ButtonTone

IconButtonProps

export type IconButtonProps = Omit<ButtonHTMLAttributes<HTMLButtonElement>, "type" | "children"> & {
label: string;
size?: ButtonSize;
tone?: ButtonTone;
loading?: boolean;
children: ReactNode;
pressed?: boolean;
type?: "button" | "submit" | "reset";
};

关联类型:ButtonSize · ButtonTone

成员说明:

  • label:强制可访问名称(icon-only MUST 有名称,design D3)。
  • children:图标(默认 aria-hidden)。
  • pressed:切换类控件的按下态。

IdentityIcon

身份与访问。

export const IdentityIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

ImageEditService

export type ImageEditService = {
isActive(): boolean;
nodeId(): string | null;
setHistoryOverride(override: {
url: string;
} | null, nodeId?: string): void;
refreshFromCanonical(revision: number): void;
draftState(): "saved" | "unsaved" | "saving" | "history-pending" | "error";
};

成员说明:

  • isActive:窗口内是否仍持有图片编辑文档会话。
  • nodeId:当前活动文档对应的来源节点;文件文档或没有活动文档时为 null。
  • setHistoryOverride:安装/清除只读历史预览 override。 nodeId 由调用方(历史面板)显式给出:多标签下活动文档可能是另一篇,只改活动文档会让 预览「点了没反应」;缺省时作用于活动节点。
  • refreshFromCanonical:历史恢复成功后,等待对应权威修订并刷新当前编辑内容。
  • draftState:当前草稿状态(供历史面板「当前版本 · 未保存」呈现)。

ImageIcon

export const ImageIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

InputScopesService

export interface InputScopesService {
addGate(gate: () => boolean): () => void;
addScope(scope: InputScope, gate: () => boolean): () => void;
isActive(scope: InputScope): boolean;
blocksCanvas(): boolean;
blocksFocusInput(): boolean;
}

关联类型:InputScope

成员说明:

  • addGate:注册一个门禁谓词(例如 modal 打开时返回 true)。
  • addScope:注册到指定 scope 的门禁谓词;返回注销函数。
  • blocksCanvas:modal/menu/editor 任一激活时,画布 pointer/keyboard/paste/drop 门禁为 true。
  • blocksFocusInput:聚焦相机输入门禁。 focus 期间只有真正的 modal Dialog 才阻断主观察相机缩放/观察;非模态的 editor/history panel 与菜单 MUST NOT 抢走 focus canvas 上的滚轮/捏合/键盘飞行。

InteractionController

export type InteractionController = {
start(): void;
dispose(): void;
flush(): void;
invalidate(reason?: string): void;
surface(): {
width: number;
height: number;
pixelRatio: number;
originX?: number;
originY?: number;
};
zoomBy(factor: number): void;
zoomTo(zoom: number): void;
zoomToFit(): void;
viewport(): {
x: number;
y: number;
zoom: number;
};
lastPointerWorld(): {
x: number;
y: number;
} | null;
renderError(): string | null;
subscribeViewport(listener: () => void): () => void;
clientToWorld(client: {
x: number;
y: number;
}): {
x: number;
y: number;
};
worldToClient(world: {
x: number;
y: number;
}): {
x: number;
y: number;
};
historyDotScreenPoint?(nodeId: string, operationId: string): {
x: number;
y: number;
generation: number;
} | null;
queryDropTarget(point: {
x: number;
y: number;
}, excludedIds?: readonly string[]): InteractionQuery<string | null>;
cancelTransientGesture(): void;
focusProjection(): ModelFocusProjection | null;
exitModelFocus(): void;
isModelFocused(): boolean;
setWorldGroundPreview(nodeId: string, delta: {
u: number;
v: number;
} | null): boolean;
setSceneAreaPreview(nodeId: string, bounds: import("@woohaa3/contracts").GroundAabb | null, moveMembers?: boolean): boolean;
queryWorldGround(point: {
x: number;
y: number;
}): {
u: number;
v: number;
} | null;
beginWorldGroundPreview(nodeId: string, point: {
x: number;
y: number;
}): boolean;
updateWorldGroundPreview(point: {
x: number;
y: number;
}): boolean;
cancelWorldGroundPreview(): void;
setWorldCameraPreview(nodeId: string, delta: {
u: number;
v: number;
} | null): boolean;
clearWorldCameraPreviews(): void;
enterModelFocusForNode(nodeId: string): boolean;
setContentRect(rect: {
right: number;
left?: number;
top?: number;
bottom?: number;
}): void;
setSceneAreaGestures(handler: InteractionControllerOptions["sceneAreaGestures"] | null): void;
beginSceneAreaGesture(input: SceneAreaGestureBeginInput): SceneAreaGestureStart | null;
endSceneAreaGesture(): Promise<SceneAreaGestureResult>;
cancelSceneAreaGesture(): void;
restoreViewport(viewport: {
x: number;
y: number;
zoom: number;
}): void;
panViewportTo(viewport: {
x: number;
y: number;
zoom: number;
}, options?: {
durationMs?: number;
}): void;
reframeModelFocus(nodeId: string): void;
setFocusedModelView(view: "perspective" | "front" | "top" | "right"): void;
zoomFocusedModel(factor: number): void;
setShotGesture(handler: InteractionControllerOptions["shotGesture"] | null): void;
setFocusGesture(handler: InteractionControllerOptions["focusGesture"] | null): void;
setShotWheel(handler: InteractionControllerOptions["shotWheel"] | null): void;
applyFocusTarget(target: CanvasFocusTarget | null, transition: {
preserveSession: boolean;
restoreDirectCamera?: boolean;
}): {
ok: true;
} | {
ok: false;
reason: string;
};
selectNode(nodeId: string): boolean;
nodeScreenRect(nodeId: string, part?: "scope-title" | "panel" | "action-toolbar"): import("@woohaa3/contracts").ScreenRect | null;
alignmentGuides(): readonly AlignmentGuide[];
alignmentGuidesVersion(): number;
setAlignmentSnapPolicy(policy: AlignmentSnapPolicy | null): void;
};

关联类型:InteractionQuery · ModelFocusProjection · GroundAabb · InteractionControllerOptions · SceneAreaGestureBeginInput · SceneAreaGestureStart · SceneAreaGestureResult · CanvasFocusTarget · ScreenRect · AlignmentGuide · AlignmentSnapPolicy

成员说明:

  • invalidate:请求失效。 Store/模型/主题/媒体/资源/输入只合并 dirty flags,不强制同步构建;由下一帧统一结算。
  • zoomBy:在当前基础上按因子缩放(以画布中心为锚点)并提交。
  • zoomTo:缩放到指定 zoom(以画布中心为锚点)并提交。
  • zoomToFit:缩放到适合内容(节点包围盒),无节点时回到 100%。
  • viewport:当前规范视口。
  • lastPointerWorld:最近一次有效画布指针的世界坐标。 缺失(从未在画布上移动指针)时返回 null。
  • renderError:最近一次快照提交失败原因;成功或未失败时为 null 。单帧失败不影响后续帧与输入。
  • subscribeViewport:订阅本地视口变化(捏合/滚轮/平移/按钮);返回退订函数 。宿主缩放读数据此跟进。
  • clientToWorld:client 坐标 → 世界坐标(与 pointerWorld 同一换算:减去 canvas 外框偏移,再按本地视口缩放)。 供 drop/paste 锚点使用,不读写服务端 viewport。
  • worldToClient:世界坐标 → client 坐标(含 canvas 外框偏移)。供导入预览等瞬时 DOM overlay 定位, 不读写服务端 viewport。
  • queryDropTarget:通用 drop target 查询。 按 accepted snapshot 固定最上层实际节点(排除来源);ok:false 时调用方 MUST NOT 回退 TS 矩形几何或提交移动。
  • cancelTransientGesture:取消尚未提交的瞬时画布交互(modal 从空变非空时由宿主调用,design D6)。
  • focusProjection:当前模型聚焦投影;未聚焦返回 null。
  • exitModelFocus:退出模型聚焦并恢复进入前的 2D 视口(无聚焦时为 no-op)。
  • isModelFocused:是否处于模型聚焦查看。
  • setWorldGroundPreview:Transient renderer-only ground displacement. Null cancels without a document write.
  • setSceneAreaPreview:导演区地面范围瞬时预览(搬动/调范围)。只影响本页呈现,松手或取消传 null 清除; 不写规范 nodeData,也不代替权威 scene-area 提交。
  • queryWorldGround:Resolve a client point against the accepted renderer camera’s ground plane.
  • setWorldCameraPreview:镜头视锥瞬时位姿(按地面增量);null 清除。只影响本页呈现,不写规范 nodeData, 也不代替权威 world-camera-save(见 world-camera-drag.ts)。
  • clearWorldCameraPreviews:清除全部镜头瞬时位姿(取消/卸载)。
  • enterModelFocusForNode:以 canonical nodeId 请求进入聚焦(历史 owner 用) 。目标不合法返回 false。
  • setContentRect:更新右侧遮挡宽度,按未遮挡左侧区域重新取景(任务 4.2)。
  • setSceneAreaGestures:注入/替换导演区手势运行时(T07 scope gestures);传 null 恢复页面绑定实例。 导演区卡片/地面边缘按下时由 2D 输入层转发,不新建指针监听。
  • beginSceneAreaGesture:Overlay bridge for externally started scene gestures (projected 搬场景 handle). The controller records the external owner so its frame reconciliation cannot cancel the gesture on the next animation frame.
  • panViewportTo:带动画地平移到目标视口(保持传入 zoom)。尊重减少动态效果偏好;duration 为 0 时瞬时。
  • reframeModelFocus:按当前本地 Scene IR override 重新取景聚焦目标 。
  • setShotGesture:注入/替换镜头 pose 手势处理器。
  • setFocusGesture:注入/替换镜头焦点三轴位移手势处理器。
  • setShotWheel:注入/替换主画面滚轮与捏合对镜头 distance 的处理。
  • applyFocusTarget:应用完整 focus target transition(Canvas Navigation focus adapter) 。
  • selectNode:把某个 canonical 节点设为唯一 selection(供活动栈「定位节点」等宿主入口) 。 只改本地 selection,不写 Y.Doc;节点不存在时返回 false。
  • nodeScreenRect:节点当前屏幕矩形(CSS px,含 canvas 外框偏移) 。 优先使用 working 拖动/改尺寸预览,其次规范绝对坐标与节点尺寸,经唯一本地视口换算; 不写状态、不建第二套相机。节点不存在时返回 null。供节点顶部操作横条与生成面板锚定; part: "action-toolbar" 使用 accepted 卡片投影,世界对象/隐藏节点返回空; part: "panel" 为生成面板专用锚点(世界镜头在机位可见时改用 3D 机位底点)。
  • alignmentGuides:本次拖动的辅助对齐线(世界坐标) (内置插件 alignment-guides;宿主只在拖动中返回非空数组)。 覆盖层把它按唯一本地视口换算成屏幕线段绘制;不写画布、不参与命中。
  • alignmentGuidesVersion:参考线版本号;内容变化才递增,覆盖层据此决定是否重绘。
  • setAlignmentSnapPolicy:注入/替换拖动吸附策略(内置插件提供;不注入即完全不吸附)。

InteractionControllerOptions

export type InteractionControllerOptions = {
nodeCapabilities?: NodeImplementationRegistry;
mediaContent?: MediaContentService;
canvas: HTMLCanvasElement;
getRuntime: () => BevyRuntime | null;
getSession: () => CanvasSession | null;
getModelResources?: () => ReadonlyMap<string, import("@woohaa3/contracts").PreparedModelResource>;
isModelLoading?: (nodeId: string) => boolean;
getModelLoading?: () => ((nodeId: string) => boolean) | undefined;
getTheme?: () => AppThemeSnapshot;
onScene?: (scene: CanvasRenderScene) => void;
onSceneSubmitted?: () => void;
target?: Window & typeof globalThis;
isWritable?: () => boolean;
onEditCommands?: (commands: readonly CanvasCommand[], label: string) => void | Promise<void | {
ok: boolean;
entry?: {
state: string;
};
}>;
saveWorldCamera?: WorldCameraSavePort["save"];
moveWorldCameraCard?: WorldCameraGestureDeps["moveCard"];
recordExternal?: WorldCameraGestureDeps["recordExternal"];
onInteractionError?: (error: unknown) => void;
viewportTransitionMs?: number;
onFindRequest?: () => void;
onUndoRequest?: () => void;
onRedoRequest?: () => void;
textureSync?: TextureUploader;
projectResidency?: () => void;
onSurface?: (surface: {
width: number;
height: number;
pixelRatio: number;
}) => void;
onViewportForResidency?: (viewport: {
x: number;
y: number;
zoom: number;
}) => void;
canvasId?: string;
onImagePreview?: (request: {
assetId: string;
nodeId: string;
title: string;
}) => void;
onTextPreviewIntent?: (request: {
nodeId: string;
}) => void;
onImageFocusIntent?: (request: {
nodeId: string;
}) => void;
onVideoFocusIntent?: (request: {
nodeId: string;
}) => void;
onVideoFrameCapture?: (request: {
nodeId: string;
}) => void;
videoSessions?: VideoFrameSessions | null;
isModalActive?: () => boolean;
isFocusInputBlocked?: () => boolean;
onContextMenu?: (request: {
screen: Point;
world: Point;
node: {
nodeId: string;
} | null;
}) => void;
onConnectToEmpty?: (request: {
screen: Point;
world: Point;
sourceNodeId: string;
sourceNodeType: string;
}) => void;
onViewportChange?: (viewport: {
x: number;
y: number;
zoom: number;
}) => void;
onFrame?: () => void;
getGhostNodes?: () => readonly import("@woohaa3/contracts").GhostRenderNode[];
onNodeHistory?: (request: {
nodeId: string;
}) => void;
onNodeHistorySelect?: (request: {
nodeId: string;
index?: number;
step?: number;
presentationId?: string;
entryId?: string;
operationId?: string;
}) => void;
onNodeAction?: (request: {
nodeId: string;
actionId: string;
menu: boolean;
}) => void;
getModelFocusTargets?: () => readonly FocusTargetInput[];
hasModelFocusTarget?: (nodeId: string) => boolean;
onModelFocusChange?: (projection: ModelFocusProjection | null) => void;
onModelFocusIntent?: (intent: {
type: "enter";
nodeId: string;
kind?: "model" | "extension";
} | {
type: "exit";
}) => void;
onModelFocusInvalid?: (reason: string) => void;
getModelFocus?: () => ModelFocusProjection | null;
getModelFocusMode?: () => "edit" | "history";
isImageFocused?: () => boolean;
getImageFocus?: () => import("@woohaa3/contracts").BevyImageFocus | null;
isImageFocusPending?: () => boolean;
getImageViewportTarget?: () => FocusViewportTarget | null;
isVideoFocused?: () => boolean;
getVideoFocus?: () => import("@woohaa3/contracts").BevyVideoFocus | null;
getModelSceneOverride?: (nodeId: string) => {
version: string;
ops: readonly unknown[];
} | null;
getContentRect?: () => {
right: number;
};
getFocusContentRect?: () => FocusContentRect | null;
getRunState?: () => RunStateProjectionInput | null;
projectHistoryCanvas?: (canvas: import("@woohaa3/contracts").ServerCanvas | null) => import("@woohaa3/contracts").ServerCanvas | null;
getModelEditor?: () => BevyModelEditor | null;
onGizmoFeedback?: (feedback: import("@woohaa3/contracts").GizmoFeedback) => void;
getAnimationPlayback?: () => import("@woohaa3/contracts").BevyAnimationPlayback | null;
getWorldAnimationContext?: () => import("@woohaa3/contracts").WorldAnimationSamplingContext;
getWorldAnimationTimes?: () => ReadonlyMap<string, number>;
getWorldAnimationPlayheads?: () => ReadonlyMap<string, number>;
getWorldAnimationPlayer?: () => {
nodeId: string | null;
playing: boolean;
};
getWorldAnimationLoop?: (nodeId: string) => boolean;
getFocusTransition?: () => import("@woohaa3/contracts").BevyFocusTransition | null;
alignmentSnap?: () => AlignmentSnapPolicy | null;
shotGesture?: {
begin(handle: "orbit-ring" | "elevation-ring" | "distance", point: {
x: number;
y: number;
}): boolean;
move(handle: "orbit-ring" | "elevation-ring" | "distance", point: {
x: number;
y: number;
}): void;
end(): void;
cancel(): void;
};
focusGesture?: {
begin(axis: "x" | "y" | "z" | "center", point: {
x: number;
y: number;
}): boolean;
move(axis: "x" | "y" | "z" | "center", point: {
x: number;
y: number;
}): void;
end(): void;
cancel(): void;
};
shotWheel?: {
wheel(deltaY: number, deltaMode: number): void;
scaleBegin(): void;
scale(scale: number): void;
scaleEnd(): void;
};
sceneAreaGestures?: SceneAreaGesturePort | null;
};

关联类型:NodeImplementationRegistry · MediaContentService · BevyRuntime · CanvasSession · PreparedModelResource · AppThemeSnapshot · CanvasRenderScene · CanvasCommand · WorldCameraSavePort · WorldCameraGestureDeps · TextureUploader · VideoFrameSessions · Point · GhostRenderNode · FocusTargetInput · ModelFocusProjection · BevyImageFocus · FocusViewportTarget · BevyVideoFocus · FocusContentRect · RunStateProjectionInput · ServerCanvas · BevyModelEditor · GizmoFeedback · BevyAnimationPlayback · WorldAnimationSamplingContext · BevyFocusTransition · AlignmentSnapPolicy · SceneAreaGesturePort

成员说明:

  • getModelResources:每节点不可变 prepared model resource。 快照只引用 resourceKey;controller 把它交给 runtime 先注册后提交。
  • getModelLoading:Resolve the current loading provider once per scene build, allowing late registration/reload.
  • getTheme:当前主题 snapshot。 缺省用内置默认主题;非法值由 buildCanvasRenderScene 拒绝。
  • onEditCommands:结构动作经页面编辑历史(可撤销) 。 缺省时回退到直接提交(保持单测/最小 fixture 可用)。
  • saveWorldCamera:共享世界镜头的权威保存端口(视锥拖动释放时提交位姿)。 缺省时镜头只能选中、不能拖动位姿;拖动手势本身仍由 2D 输入层编排。
  • moveWorldCameraCard:镜头拖动时同步移动卡片;不新增撤销条目(由镜头手势的外部历史统一管理)。
  • recordExternal:页面撤销历史入口(镜头位姿的可逆回调)。 缺省时回落到 onEditCommands 的页面编辑历史;两者都没有时只提交,不进撤销时间线。
  • onInteractionError:指针手势派发错误出口(提交/回调失败时)。缺省静默;输入层始终复位手势,绝不卡死。
  • viewportTransitionMs:采用过渡动画的视口平移时长(毫秒);0 或负值表示瞬时。
  • onFindRequest:Ctrl/⌘+F:主画布拥有输入且无编辑器/模态/菜单阻止时请求打开「查找作品」 。
  • onUndoRequest:撤销/重做快捷键路由。输入框/聚焦编辑器优先, 只有主画布拥有输入时到达这里。
  • textureSync:可注入的纹理上传器(测试用);缺省从 runtime 创建。
  • projectResidency:每帧资源需求投影。 必须在纹理/视频/片场媒体 sync() 之前执行:先准入再创建。
  • onSurface:本帧 surface 尺寸变化(供资源协调器按物理尺寸选缩略图档);缺省不通知。
  • onViewportForResidency:本帧已接受视口(资源需求投影与缩略图档位用);缺省不通知。
  • canvasId:画布 ID;本地视口按它记忆(各浏览器独立)。
  • onImagePreview:双击携带图片的节点时请求 media-preview。 Dialog Host 打开;控制器不再直接传 URL 或渲染弹窗(design D8)。
  • onTextPreviewIntent:双击文本节点时请求宿主按当前 canonical 内容打开 Markdown 预览。
  • onImageFocusIntent:双击命中 canonical ready 图片节点时请求进入图片聚焦工作区 。 只传稳定 canonical nodeId;建立 focus identity 由 Canvas Navigation 负责。缺省时回落到 onImagePreview(保持既有媒体 Dialog 行为,测试用)。
  • onVideoFocusIntent:双击命中 canonical ready 视频节点时请求进入视频聚焦工作区 。 只传稳定 canonical nodeId;建立 focus identity 由 Canvas Navigation 负责。缺省时回落到 onVideoFrameCapture(保持既有截帧 Dialog 行为,测试用)。
  • onVideoFrameCapture:双击命中 video 节点时请求截帧。 只传 nodeId;解析节点自身 ready 输出与打开 Dialog 由 Task Execution Plugin 负责。
  • videoSessions:视频帧会话。 缺省为 null 时不驱动 hover 播放。
  • isModalActive:modal 门禁(design D6):返回 true 时画布不开始任何手势、快捷键、paste 或 wheel 缩放。 缺省恒为 false(无弹窗),保持既有行为。
  • isFocusInputBlocked:聚焦相机输入门禁。 聚焦期间只有真正的 modal Dialog 才阻断主观察相机缩放/观察;非模态 editor/history panel 与菜单不阻断。缺省回退到 isModalActive(保持既有行为)。
  • onContextMenu:右键短点击(位移 < 10 CSS px)时打开上下文菜单;右键拖拽(≥ 10px)改为平移, 不回调。node 为命中的规范节点(命中空白/边时为 null)。
  • onConnectToEmpty:从输出端口拉线释放到空白处:打开「生成 X」菜单。sourceNodeId 是拉线起点, world 是释放位置的世界坐标(新节点插入处)。
  • onViewportChange:本地视口变化回调(pan/zoom/commit)。供瞬时 DOM overlay(导入预览)重新定位; 不写服务端 viewport。按帧节流,只在视口实际变化时触发。
  • onFrame:每次画布刷新帧回调;供与渲染节奏同步的瞬时 overlay 使用。
  • getGhostNodes:上传中的幽灵节点。 由 canvasRuntime 持有,buildScene 每帧读取并合并。
  • onNodeHistory:点击节点右上角历史动作。 只传 canonical nodeId;打开历史面板不改变 selection、不提交 Canvas 命令。
  • onNodeAction:顶部操作横条动作命中。 横条由 Bevy 绘制、Rust 命中;宿主据 actionId(= 贡献 id)派发,menu 为设置箭头。
  • getModelFocusTargets:当前所有可聚焦模型目标。 由宿主从 model-scene provider + canonical/working 画布解析;空数组表示无模型。
  • onModelFocusChange:模型聚焦变化(进入 / 相机更新 / 退出)。回调收到的 null 表示回到普通正交画布。 控制器只上报浏览器本地状态;宿主据此 flush 渲染快照。
  • onModelFocusIntent:模型聚焦入口 intent。 双击进入 / Escape 退出统一走 Canvas Navigation;缺省时回落到直接控制器调用(测试)。
  • onModelFocusInvalid:聚焦目标/runtime projection 失效上报。 runtime/host 据此请求 Canvas Navigation 原子收敛(不再由 selection 直接退出)。
  • getModelFocus:当前聚焦投影(供宿主在 buildScene 时读取);缺省恒为 null(普通画布)。
  • isImageFocused:当前图片聚焦投影。 缺省恒为 null(普通画布)。
  • isImageFocusPending:图片聚焦已进入、编辑器却还没接管画面(引擎/首帧未就绪)。 此时没有编辑面消费输入,滚轮与 Space 平移按普通画布处理,画布不会被“聚焦取景目标缺失”吃掉。
  • isVideoFocused:当前视频聚焦投影。 缺省恒为 null(普通画布)。
  • getModelSceneOverride:当前节点本地已校验模型 Scene IR snapshot override 。
  • getContentRect:右侧实际占用区域(CSS content rect);right 为 0 表示无遮挡。 用于按未遮挡左侧区域取景(design D7)。
  • getRunState:统一生成运行状态快照。 返回按 (canvasId,nodeId) 索引的已归约运行摘要、有界操作记录集合,以及可选“当前版本” 操作身份映射(nodeId -> operationId,由 node-history 插件提供)。缺省时不投影历史条与 聚合遮罩。全部为浏览器本地派生状态,不进入 ServerCanvas / Y.Doc。
  • getModelEditor:模型编辑 gizmo/镜头工具瞬时态。 缺省/返回 null 时不绘制编辑 gizmo。由宿主从编辑会话与聚焦目标派生。
  • getAnimationPlayback:活动动画节点播放瞬时投影 。 由持有动画播放会话的宿主提供;缺省/返回 null 时表示当前无活动动画节点。控制器只把它 投影进快照,不持有播放时钟。
  • getWorldAnimationContext:导演区整对象动画播放头(秒);缺省不采样。
  • getFocusTransition:公共聚焦过渡进度 。 由 Canvas Runtime coordinator 提供;携带时 Rust 三维聚焦相机按该进度求值,不再独立计时。 缺省/返回 null 时不发送(Rust 回退既有内部计时)。只承载浏览器本地呈现态。
  • alignmentSnap:拖动吸附策略(内置插件 alignment-guides 注入)。 宿主在每次拖动预览时向它求一次吸附偏移与参考线;返回 null 或未注入时完全不吸附, 行为与本能力上线前一致。几何求解在 contracts 的纯函数里,插件只提供开关与候选裁剪。
  • shotGesture:镜头 pose gizmo 手势。 命中 shot gizmo 时由控制器读取/推进/结束镜头 pose;实际提交由宿主的编辑会话负责。 缺省时不处理镜头手势。
  • focusGesture:镜头焦点三轴位移 gizmo 手势。 命中焦点 gizmo 的 X/Y/Z 轴时由控制器读取/推进/结束 focusOffset;实际 preview 与提交由 宿主的编辑会话负责。缺省时不处理焦点手势。
  • shotWheel:选中镜头占主画面时的滚轮与捏合。 只改当前镜头 distance;不改聚焦相机。
  • sceneAreaGestures:导演区手势运行时(T07 scope gestures)。 缺省时读取 world-scopes 绑定的页面实例;测试与宿主可显式注入。控制器只把指针 交给它,不在这里判断场景权限或直接改共享世界。

InvalidIcon

export const InvalidIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

LassoIcon

export const LassoIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

LayersIcon

export const LayersIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

LayoutGridIcon

export const LayoutGridIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

LinkIcon

export const LinkIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

Listbox

export function Listbox(props: ListboxProps): React.JSX.Element;

关联类型:ListboxProps

ListboxOption

export type ListboxOption = {
value: string;
label: ReactNode;
disabled?: boolean;
className?: string;
ariaLabel?: string;
dataAttributes?: Record<string, string | undefined>;
};

成员说明:

  • className:选项额外 class。
  • ariaLabel:选项可访问名(label 为复杂结构时提供)。
  • dataAttributes:选项附加数据属性。

ListboxProps

export type ListboxProps = {
value: string;
onValueChange: (value: string) => void;
options: readonly ListboxOption[];
label: string;
className?: string;
optionClassName?: string;
autoFocus?: boolean;
empty?: ReactNode;
dataAttributes?: Record<string, string | undefined>;
};

关联类型:ListboxOption

成员说明:

  • autoFocus:首个可选项获得焦点(键盘进入时)。
  • empty:空态内容(无匹配时)。
  • dataAttributes:透传到根的数据属性。

LoadingIcon

export const LoadingIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

LocateIcon

export const LocateIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps

LocateNodesResult

export type LocateNodesResult = {
ok: true;
} | {
ok: false;
reason: string;
};

LockIcon

export const LockIcon: { ({ size, strokeWidth, absoluteStrokeWidth, ...rest }: UiIconProps): React.JSX.Element; displayName: string; };

关联类型:UiIconProps