跳到主要内容

Interface: LayoutDataApi

Defined in: useLayoutData.ts:21

门面 hook 的返回类型(具名导出,消费方无需 typeof 推导)

Properties

activeId

activeId: string

Defined in: useLayoutData.ts:24

当前活跃布局 id


areaStates

areaStates: Record<number, AreaSlots>

Defined in: useLayoutData.ts:38

实例状态总表 map[areaId][contentType]


createLayout

createLayout: (name?) => string

Defined in: useLayoutData.ts:30

以当前布局为模板新建布局,返回新布局 id

Parameters

name?

string

Returns

string


getSnapshot

getSnapshot: () => LayoutEvent

Defined in: useLayoutData.ts:64

命令式读取当前活跃布局 id + 快照

Returns

LayoutEvent


layouts

layouts: LayoutInfo[]

Defined in: useLayoutData.ts:26

全部布局条目(id/名称)


moveMesh

moveMesh: (dx) => void

Defined in: useLayoutData.ts:56

移动共享场景物体(全局共享,所有视图同步)

Parameters

dx

number

Returns

void


onChange

onChange: (fn) => () => void

Defined in: useLayoutData.ts:60

订阅布局变化,返回取消订阅函数

订阅布局变化:回调 (当前, 上一次)。微任务异步投递,同 tick 多次变更折叠为一次。 返回取消订阅函数

Parameters

fn

Listener

变化回调

Returns

取消订阅函数

() => void


redo

redo: () => void

Defined in: useLayoutData.ts:46

重做

Returns

void


removeLayout

removeLayout: (id?) => void

Defined in: useLayoutData.ts:32

删除布局(缺省删除当前活跃;仅剩一个时无操作)

Parameters

id?

string

Returns

void


restore

restore: (snap) => void

Defined in: useLayoutData.ts:48

恢复任意来源的快照数据(内部经 migrateSnapshot 校验归一)

Parameters

snap

unknown

Returns

void


screen

screen: Screen

Defined in: useLayoutData.ts:36

当前屏幕几何(引用语义:浅拷贝顶层触发重渲)


serialize

serialize: () => string

Defined in: useLayoutData.ts:50

当前布局序列化为 JSON 字符串

Returns

string


setAreaContent

setAreaContent: (id, type) => void

Defined in: useLayoutData.ts:52

程序化切换区域内容(进历史栈)

Parameters

id

number

type

string

Returns

void


setAreaState

setAreaState: (id, type, patch) => void

Defined in: useLayoutData.ts:54

增量写某区域某类型的实例状态

Parameters

id

number

type

string

patch

AreaState

Returns

void


shared

shared: MeshObject

Defined in: useLayoutData.ts:40

共享场景数据(全局一份)


subscribe

subscribe: (fn) => () => void

Defined in: useLayoutData.ts:62

onChange 别名

Parameters

fn

Listener

Returns

() => void


switchTo

switchTo: (id) => void

Defined in: useLayoutData.ts:28

切换到指定布局(先存档当前活跃再恢复目标)

Parameters

id

string

Returns

void


undo

undo: () => void

Defined in: useLayoutData.ts:44

撤销上一步

Returns

void