跳转到内容

签名关联类型:GizmoHitResult – ImageEditTool

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

返回接口索引

GizmoHitResult · GizmoQueryInput · GroundAabb · GroundPoint · HasDefault · HistoryThumbnailFrame · HostSafeModeView · HumanoidMotionReference · HumanoidParameterKey · HumanoidParameters · HumanoidWalkProfile · IdentityAuthenticateInput · IdentityAuthenticateResult · IdentityFailureCode · IdentityProvider · IdentityTransport · ImageEditCompleteMedia · ImageEditCompleteRequest · ImageEditDocument · ImageEditDocumentVersion · ImageEditPoint · ImageEditProjectObjectRef · ImageEditShape · ImageEditTool

GizmoHitResult

gizmo 命中结果(与 Rust GizmoHitResult 同构)。

export type GizmoHitResult = {
available: boolean;
reason?: string | null;
handle: string | null;
constraint?: AxisDragConstraint | null;
yawConstraint?: {
origin: [
number,
number,
number
];
u: [
number,
number,
number
];
v: [
number,
number,
number
];
normal: [
number,
number,
number
];
startAngle: number;
mode: "plane" | "tangent";
direction: [
number,
number
];
radiansPerPixel: number;
} | null;
layoutId?: string | null;
generation?: number;
epoch?: number;
};

关联类型:AxisDragConstraint

GizmoQueryInput

gizmo 运行时查询入口(由 canvas controller 注入)。

export type GizmoQueryInput = {
kind: "model" | "object" | "shot" | "focus";
editor: BevyModelEditor | null;
projection: Pick<ModelFocusProjection, "target" | "yaw" | "pitch" | "distance"> | null;
surface: Surface;
point: {
x: number;
y: number;
};
};

关联类型:BevyModelEditor · ModelFocusProjection · Surface

成员说明:

  • kind:查询种类:model / object / shot / focus。

GroundAabb

Finite ordered endpoints, in meters. Zero width/height is valid, not empty.

export interface GroundAabb {
min: GroundPoint;
max: GroundPoint;
}

关联类型:GroundPoint

GroundPoint

export interface GroundPoint {
u: number;
v: number;
}

HasDefault

type HasDefault<D> = D extends {
default: infer V;
} ? (undefined extends V ? false : true) : false;

HistoryThumbnailFrame

export type HistoryThumbnailFrame = {
ok: true;
rgba: Uint8Array;
width: number;
height: number;
} | {
ok: false;
code: string;
};

HostSafeModeView

宿主安全模式。

boot-failures:连续多次未就绪后自动进入;forced:WOOHAA3_SAFE_MODE=1。suspended 是本次未装配的 扩展,它们的站点实际状态为 suspended,已保存的启停配置不变。

export type HostSafeModeView = {
reason: "boot-failures" | "forced";
since: string;
suspendedCount: number;
suspended: string[];
lastFailure?: string;
};

成员说明:

  • since:进入安全模式的时刻(ISO 8601)。
  • lastFailure:最近一次失败的安全摘要(可能缺省:崩溃进程的诊断不一定留得下来)。

HumanoidMotionReference

export type HumanoidMotionReference = {
profile: "humanoid-v1";
limbs: Array<{
name: "leftArm" | "rightArm" | "leftLeg" | "rightLeg";
rootJointId: string;
middleJointId: string;
endJointId: string;
}>;
joints: Array<{
jointId: string;
childId: string;
longAxisLocal: Vec3;
lengthMeters: number;
flexionAxisLocal: Vec3 | null;
}>;
armsDownPose: Record<string, Vec3>;
rotationSemantics: string;
};

关联类型:Vec3

HumanoidParameterKey

export type HumanoidParameterKey = (typeof HUMANOID_PARAMETER_KEYS)[number];

HumanoidParameters

export type HumanoidParameters = Record<HumanoidParameterKey, number>;

关联类型:HumanoidParameterKey

HumanoidWalkProfile

export type HumanoidWalkProfile = {
version: 'humanoid-walk-v1';
groundAnchorLocal: Vec3;
legs: {
Left: Leg;
Right: Leg;
};
armsDownPose: Record<string, Vec3>;
};

关联类型:Vec3 · Leg

IdentityAuthenticateInput

一次认证请求。只含原始受控输入:provider 自己判断可信来源,不能仅凭代理地址或 转发头判定登录。

export type IdentityAuthenticateInput = {
transport: IdentityTransport;
headers: Readonly<Record<string, string | string[] | undefined>>;
method?: string;
url?: string;
remoteAddress?: string;
now?: number;
};

关联类型:IdentityTransport

成员说明:

  • headers:原始请求头(结构形状,不 import node:http)。
  • remoteAddress:直连远端地址(仅用于 provider 判断是否 loopback 直连;不能替代密码学验证)。
  • now:认证时刻(毫秒;由宿主注入以便测试确定化)。

IdentityAuthenticateResult

export type IdentityAuthenticateResult = {
ok: true;
principal: PrincipalContext;
} | {
ok: false;
code: IdentityFailureCode;
message?: string;
};

关联类型:PrincipalContext · IdentityFailureCode

IdentityFailureCode

export type IdentityFailureCode = "unauthenticated" | "invalid";

IdentityProvider

身份提供者。由可信部署 profile 按 extensionId 引用;必需提供者缺失/故障时保护面拒绝。

providerId 是供给槽位 identity(稳定字符串),与 extensionId 分开,允许多提供者实现 共存时仍按 profile 选择。

export type IdentityProvider = {
providerId: string;
authenticate(input: IdentityAuthenticateInput): Promise<IdentityAuthenticateResult>;
ready?(): boolean;
};

关联类型:IdentityAuthenticateInput · IdentityAuthenticateResult

成员说明:

  • authenticate:认证一次请求;未认证返回 {ok:false},绝不抛出来源不明的成功。
  • ready:可选:当前提供者是否已就绪(配置完整)。缺省视为就绪。

IdentityTransport

export type IdentityTransport = (typeof IDENTITY_TRANSPORTS)[number];

ImageEditCompleteMedia

图片完成请求的最终媒体 metadata(稳定资产引用;bytes 由 Media Service 持有)。

outputStorageKey 是上传后的合成 PNG;baseStorageKey 是稳定原图;编辑定义为可选, 缺省表示恢复为纯媒体(清除旧标注)。

export type ImageEditCompleteMedia = {
baseAssetId: string;
baseStorageKey: string;
sourceWidth: number;
sourceHeight: number;
outputAssetId: string;
outputStorageKey: string;
checksum: string;
contentType: string;
size: number;
baseChecksum?: string;
baseContentType?: string;
baseSize?: number;
imageEdit?: ImageEditDocument;
canvasWidth?: number;
canvasHeight?: number;
project?: ImageEditProjectObjectRef;
};

关联类型:ImageEditDocument · ImageEditProjectObjectRef

成员说明:

  • baseChecksum:原图的稳定 metadata(checksum/contentType/size);缺省回退到输出 metadata。
  • imageEdit:可选严格编辑定义;缺省/零 shape 表示回原图。
  • canvasWidth:裁剪后的当前画布尺寸(工程分支必填;不等于原始来源尺寸)。 (编辑扩展工作区,design D4/D6)
  • project:工程对象的稳定 metadata(工程分支必填;与 imageEdit.project 一致)。 只在受控工程上传/读取链路使用。

ImageEditCompleteRequest

图片 complete 请求(design D6):冻结草稿在上传后由本请求提交。

export type ImageEditCompleteRequest = {
canvasId: string;
nodeId: string;
sessionId: string;
requestId: string;
kind: "image";
baselineContentIdentity: string;
media: ImageEditCompleteMedia;
};

关联类型:ImageEditCompleteMedia

ImageEditDocument

严格版本化编辑定义联合:两个分支互斥,禁止同时携带 shapes 与 project。

export type ImageEditDocument = LegacyImageEditDocument | ImageProjectDocument;

关联类型:LegacyImageEditDocument · ImageProjectDocument

成员说明:

  • baseAssetId:同画布稳定原图资产引用(StoredAsset.id)。 同画布稳定原图资产引用。
  • sourceWidth:原始来源尺寸(裁剪前,方向归一)。

ImageEditDocumentVersion

export type ImageEditDocumentVersion = typeof IMAGE_EDIT_DOCUMENT_VERSION;

ImageEditPoint

相对原始图片内容归一化坐标(不含 letterbox),分量位于 [0, 1]。

export type ImageEditPoint = {
x: number;
y: number;
};

ImageEditProjectObjectRef

工程对象的稳定 metadata(bytes 仍归 Media Service)。

export type ImageEditProjectObjectRef = {
storageKey: string;
checksum: string;
contentType: string;
size: number;
};

ImageEditShape

一条图片标注 shape(design D4)。

export type ImageEditShape = {
id: string;
tool: ImageEditTool;
color: string;
widthInSourcePixels: number;
points: ImageEditPoint[];
};

关联类型:ImageEditTool · ImageEditPoint

成员说明:

  • widthInSourcePixels:以源像素表达的线宽(1–64),不随显示缩放变化。
  • points:pen:≥2 个点;rect:恰好 2 个点(起点、终点)。

ImageEditTool

允许的标注工具。

export type ImageEditTool = "pen" | "rect";