@ue-shed/protocol 0.7.0 → 0.8.0

package/contracts/cameras/authoring/v1/recipe.schema.json

@@ -0,0 +1,340 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "https://ue-shed.dev/contracts/cameras/authoring/v1/recipe.schema.json",
+	"type": "object",
+	"properties": {
+		"version": {
+			"type": "number",
+			"enum": [1]
+		},
+		"name": {
+			"type": "string",
+			"allOf": [
+				{
+					"minLength": 1
+				}
+			]
+		},
+		"settings": {
+			"type": "object",
+			"properties": {
+				"fieldOfViewDegrees": {
+					"type": "number",
+					"allOf": [
+						{
+							"minimum": 5,
+							"maximum": 170
+						}
+					]
+				},
+				"distanceScale": {
+					"type": "number",
+					"allOf": [
+						{
+							"minimum": 0.01,
+							"maximum": 100
+						}
+					]
+				},
+				"heightOffset": {
+					"type": "number"
+				},
+				"margin": {
+					"type": "number",
+					"allOf": [
+						{
+							"minimum": 0,
+							"maximum": 0.45
+						}
+					]
+				},
+				"elevationDegrees": {
+					"type": "number",
+					"allOf": [
+						{
+							"minimum": -89,
+							"maximum": 89
+						}
+					]
+				},
+				"yawOffset": {
+					"type": "number"
+				},
+				"aimOffset": {
+					"type": "object",
+					"properties": {
+						"x": {
+							"type": "number"
+						},
+						"y": {
+							"type": "number"
+						},
+						"z": {
+							"type": "number"
+						}
+					},
+					"required": ["x", "y", "z"],
+					"additionalProperties": false
+				}
+			},
+			"required": ["fieldOfViewDegrees", "distanceScale", "heightOffset", "margin"],
+			"additionalProperties": false
+		},
+		"groups": {
+			"type": "array",
+			"items": {
+				"type": "object",
+				"properties": {
+					"id": {
+						"type": "string",
+						"allOf": [
+							{
+								"pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+							}
+						]
+					},
+					"name": {
+						"type": "string",
+						"allOf": [
+							{
+								"minLength": 1
+							}
+						]
+					},
+					"overrides": {
+						"type": "object",
+						"properties": {
+							"fieldOfViewDegrees": {
+								"type": "number",
+								"allOf": [
+									{
+										"minimum": 5,
+										"maximum": 170
+									}
+								]
+							},
+							"distanceScale": {
+								"type": "number",
+								"allOf": [
+									{
+										"minimum": 0.01,
+										"maximum": 100
+									}
+								]
+							},
+							"heightOffset": {
+								"type": "number"
+							},
+							"margin": {
+								"type": "number",
+								"allOf": [
+									{
+										"minimum": 0,
+										"maximum": 0.45
+									}
+								]
+							},
+							"elevationDegrees": {
+								"type": "number",
+								"allOf": [
+									{
+										"minimum": -89,
+										"maximum": 89
+									}
+								]
+							},
+							"yawOffset": {
+								"type": "number"
+							},
+							"aimOffset": {
+								"type": "object",
+								"properties": {
+									"x": {
+										"type": "number"
+									},
+									"y": {
+										"type": "number"
+									},
+									"z": {
+										"type": "number"
+									}
+								},
+								"required": ["x", "y", "z"],
+								"additionalProperties": false
+							}
+						},
+						"additionalProperties": false
+					}
+				},
+				"required": ["id", "name", "overrides"],
+				"additionalProperties": false
+			}
+		},
+		"cameras": {
+			"type": "array",
+			"items": {
+				"type": "object",
+				"properties": {
+					"displayName": {
+						"type": "string",
+						"allOf": [
+							{
+								"minLength": 1
+							}
+						]
+					},
+					"yawDegrees": {
+						"type": "number"
+					},
+					"overrides": {
+						"type": "object",
+						"properties": {
+							"fieldOfViewDegrees": {
+								"type": "number",
+								"allOf": [
+									{
+										"minimum": 5,
+										"maximum": 170
+									}
+								]
+							},
+							"distanceScale": {
+								"type": "number",
+								"allOf": [
+									{
+										"minimum": 0.01,
+										"maximum": 100
+									}
+								]
+							},
+							"heightOffset": {
+								"type": "number"
+							},
+							"margin": {
+								"type": "number",
+								"allOf": [
+									{
+										"minimum": 0,
+										"maximum": 0.45
+									}
+								]
+							},
+							"elevationDegrees": {
+								"type": "number",
+								"allOf": [
+									{
+										"minimum": -89,
+										"maximum": 89
+									}
+								]
+							},
+							"yawOffset": {
+								"type": "number"
+							},
+							"aimOffset": {
+								"type": "object",
+								"properties": {
+									"x": {
+										"type": "number"
+									},
+									"y": {
+										"type": "number"
+									},
+									"z": {
+										"type": "number"
+									}
+								},
+								"required": ["x", "y", "z"],
+								"additionalProperties": false
+							}
+						},
+						"additionalProperties": false
+					},
+					"groupId": {
+						"type": "string",
+						"allOf": [
+							{
+								"pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+							}
+						]
+					},
+					"relativePose": {
+						"type": "object",
+						"properties": {
+							"aspectRatio": {
+								"type": "string",
+								"enum": ["16:9"]
+							},
+							"fieldOfViewDegrees": {
+								"type": "number",
+								"allOf": [
+									{
+										"minimum": 5,
+										"maximum": 170
+									}
+								]
+							},
+							"location": {
+								"type": "object",
+								"properties": {
+									"x": {
+										"type": "number"
+									},
+									"y": {
+										"type": "number"
+									},
+									"z": {
+										"type": "number"
+									}
+								},
+								"required": ["x", "y", "z"],
+								"additionalProperties": false
+							},
+							"projection": {
+								"type": "string",
+								"enum": ["perspective"]
+							},
+							"rotation": {
+								"type": "object",
+								"properties": {
+									"pitch": {
+										"type": "number"
+									},
+									"roll": {
+										"type": "number"
+									},
+									"yaw": {
+										"type": "number"
+									}
+								},
+								"required": ["pitch", "roll", "yaw"],
+								"additionalProperties": false
+							}
+						},
+						"required": [
+							"aspectRatio",
+							"fieldOfViewDegrees",
+							"location",
+							"projection",
+							"rotation"
+						],
+						"additionalProperties": false
+					}
+				},
+				"required": ["displayName", "yawDegrees", "overrides"],
+				"additionalProperties": false
+			},
+			"allOf": [
+				{
+					"minItems": 1
+				},
+				{
+					"maxItems": 256
+				}
+			]
+		}
+	},
+	"required": ["version", "name", "settings", "groups", "cameras"],
+	"additionalProperties": false,
+	"$defs": {}
+}

package/contracts/cameras/authoring/v1/visibility-preset.schema.json

@@ -0,0 +1,205 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "https://ue-shed.dev/contracts/cameras/authoring/v1/visibility-preset.schema.json",
+	"type": "object",
+	"properties": {
+		"version": {
+			"type": "number",
+			"enum": [1]
+		},
+		"id": {
+			"type": "string",
+			"allOf": [
+				{
+					"pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+				}
+			]
+		},
+		"name": {
+			"type": "string",
+			"allOf": [
+				{
+					"minLength": 1
+				}
+			]
+		},
+		"projectName": {
+			"type": "string",
+			"allOf": [
+				{
+					"minLength": 1
+				}
+			]
+		},
+		"mapPath": {
+			"type": "string",
+			"allOf": [
+				{
+					"pattern": "^\\/Game\\/"
+				}
+			]
+		},
+		"actors": {
+			"type": "object",
+			"properties": {
+				"hide": {
+					"type": "array",
+					"items": {
+						"type": "object",
+						"properties": {
+							"locator": {
+								"anyOf": [
+									{
+										"type": "object",
+										"properties": {
+											"kind": {
+												"type": "string",
+												"enum": ["actor_path"]
+											},
+											"actorPath": {
+												"type": "string",
+												"allOf": [
+													{
+														"pattern": "^\\/Game\\/"
+													},
+													{
+														"maxLength": 4096
+													}
+												]
+											}
+										},
+										"required": ["kind", "actorPath"],
+										"additionalProperties": false
+									},
+									{
+										"type": "object",
+										"properties": {
+											"kind": {
+												"type": "string",
+												"enum": ["actor_guid"]
+											},
+											"actorGuid": {
+												"type": "string",
+												"allOf": [
+													{
+														"pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
+													}
+												]
+											},
+											"lastKnownActorPath": {
+												"type": "string",
+												"allOf": [
+													{
+														"maxLength": 4096
+													}
+												]
+											}
+										},
+										"required": ["kind", "actorGuid", "lastKnownActorPath"],
+										"additionalProperties": false
+									}
+								]
+							},
+							"label": {
+								"type": "string",
+								"allOf": [
+									{
+										"maxLength": 256
+									}
+								]
+							}
+						},
+						"required": ["locator", "label"],
+						"additionalProperties": false
+					},
+					"allOf": [
+						{
+							"maxItems": 256
+						}
+					]
+				},
+				"protect": {
+					"type": "array",
+					"items": {
+						"type": "object",
+						"properties": {
+							"locator": {
+								"anyOf": [
+									{
+										"type": "object",
+										"properties": {
+											"kind": {
+												"type": "string",
+												"enum": ["actor_path"]
+											},
+											"actorPath": {
+												"type": "string",
+												"allOf": [
+													{
+														"pattern": "^\\/Game\\/"
+													},
+													{
+														"maxLength": 4096
+													}
+												]
+											}
+										},
+										"required": ["kind", "actorPath"],
+										"additionalProperties": false
+									},
+									{
+										"type": "object",
+										"properties": {
+											"kind": {
+												"type": "string",
+												"enum": ["actor_guid"]
+											},
+											"actorGuid": {
+												"type": "string",
+												"allOf": [
+													{
+														"pattern": "^(?!00000000-00000000-00000000-00000000$)[0-9a-fA-F]{8}(?:-[0-9a-fA-F]{8}){3}$"
+													}
+												]
+											},
+											"lastKnownActorPath": {
+												"type": "string",
+												"allOf": [
+													{
+														"maxLength": 4096
+													}
+												]
+											}
+										},
+										"required": ["kind", "actorGuid", "lastKnownActorPath"],
+										"additionalProperties": false
+									}
+								]
+							},
+							"label": {
+								"type": "string",
+								"allOf": [
+									{
+										"maxLength": 256
+									}
+								]
+							}
+						},
+						"required": ["locator", "label"],
+						"additionalProperties": false
+					},
+					"allOf": [
+						{
+							"maxItems": 256
+						}
+					]
+				}
+			},
+			"required": ["hide", "protect"],
+			"additionalProperties": false
+		}
+	},
+	"required": ["version", "id", "name", "projectName", "mapPath", "actors"],
+	"additionalProperties": false,
+	"$defs": {}
+}

package/contracts/cameras/map-tile/v1/README.md

@@ -6,7 +6,10 @@ They are a sibling to, and do not change, `ue-shed-review-capture` v1.
 `plan.schema.json` describes an external Map Capture Plan. `capture-request.schema.json` and
 `capture-response.schema.json` describe a bounded editor operation named
 `ue-shed-map-tile-capture`. `manifest.schema.json` describes neutral host-published
-`ue-shed-map-tile-pyramid` evidence. All are major 1, minor 0.
+`ue-shed-map-tile-pyramid` evidence. All are major 1; legacy minor 0 remains readable. Minor 1 adds renderer evidence and minor 2 adds
+optional `capture.visibility` / `capturePolicy.visibility` hide/protect lists. Visibility requires
+minor 2 and the matching Cameras renderer. It applies before metering and to every batch, including
+the live preview; it never changes tile framing.
 
 Rows progress from world max-X toward min-X. Columns progress from world min-Y toward max-Y. The
 orientation is explicit and versioned. A level halves units-per-pixel and doubles rows and columns;