@konitif/viewer-3d 0.284.1 → 0.285.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +60 -32
- package/dist/renderer/Viewer3DRenderer.d.ts +2 -2
- package/dist/renderer/Viewer3DRenderer.d.ts.map +1 -1
- package/dist/renderer/Viewer3DRenderer.js +3 -3
- package/dist/renderer/Viewer3DRenderer.js.map +1 -1
- package/package.json +5 -4
- package/reference/README.md +10 -0
- package/reference/catalog.json +111 -0
- package/reference/diagrams.json +70 -0
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@konitif/viewer-3d",
|
|
3
3
|
"license": "PolyForm-Noncommercial-1.0.0",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.285.0",
|
|
5
5
|
"private": false,
|
|
6
6
|
"type": "module",
|
|
7
|
-
"description": "
|
|
7
|
+
"description": "Three.js spatial projection contracts and an explicit-provider renderer for KONITIF viewers.",
|
|
8
8
|
"repository": {
|
|
9
9
|
"type": "git",
|
|
10
10
|
"url": "git+https://github.com/LeMouf/konitif-viewer-3d.git"
|
|
@@ -29,7 +29,8 @@
|
|
|
29
29
|
"LICENSE.md",
|
|
30
30
|
"dist",
|
|
31
31
|
"README.md",
|
|
32
|
-
"package.json"
|
|
32
|
+
"package.json",
|
|
33
|
+
"reference"
|
|
33
34
|
],
|
|
34
35
|
"scripts": {
|
|
35
36
|
"build": "tsc -p tsconfig.json",
|
|
@@ -39,7 +40,7 @@
|
|
|
39
40
|
"prepublishOnly": "npm run build && npm test"
|
|
40
41
|
},
|
|
41
42
|
"dependencies": {
|
|
42
|
-
"@konitif/physics": "0.
|
|
43
|
+
"@konitif/physics": "0.285.0",
|
|
43
44
|
"@konitif/temporal": "0.284.1",
|
|
44
45
|
"@konitif/tools": "0.284.3",
|
|
45
46
|
"@konitif/viewer": "0.284.1",
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Viewer 3D reference
|
|
2
|
+
|
|
3
|
+
This directory contains authored, machine-readable documentation for
|
|
4
|
+
`@konitif/viewer-3d`.
|
|
5
|
+
|
|
6
|
+
- [`catalog.json`](catalog.json) groups spatial contracts and renderer responsibilities.
|
|
7
|
+
- [`diagrams.json`](diagrams.json) describes the subject-to-scene boundary.
|
|
8
|
+
|
|
9
|
+
These files support documentation tooling. They do not identify a subject,
|
|
10
|
+
configure simulation policy or transfer subject authority to the renderer.
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "1.0.0",
|
|
3
|
+
"package": "@konitif/viewer-3d",
|
|
4
|
+
"intent": "Project a subject into a 3D scene without granting the view authority over the subject.",
|
|
5
|
+
"clusters": [
|
|
6
|
+
{
|
|
7
|
+
"id": "spatial-contracts",
|
|
8
|
+
"title": "Spatial contracts",
|
|
9
|
+
"summary": "Geometric values for the 3D projection.",
|
|
10
|
+
"authority": "Spatial representation contracts.",
|
|
11
|
+
"owns": [
|
|
12
|
+
"vectors",
|
|
13
|
+
"rotations",
|
|
14
|
+
"transforms"
|
|
15
|
+
],
|
|
16
|
+
"doesNotOwn": [
|
|
17
|
+
"subject identity"
|
|
18
|
+
],
|
|
19
|
+
"workflow": [
|
|
20
|
+
"Describe",
|
|
21
|
+
"Transform",
|
|
22
|
+
"Project"
|
|
23
|
+
],
|
|
24
|
+
"symbolNames": [
|
|
25
|
+
"Viewer3DVector",
|
|
26
|
+
"Viewer3DQuaternion",
|
|
27
|
+
"Viewer3DTransform"
|
|
28
|
+
]
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"id": "scene-projection",
|
|
32
|
+
"title": "Scene projection",
|
|
33
|
+
"summary": "Snapshots and ports that make a scene observable.",
|
|
34
|
+
"authority": "Derived scene state.",
|
|
35
|
+
"owns": [
|
|
36
|
+
"snapshot",
|
|
37
|
+
"port"
|
|
38
|
+
],
|
|
39
|
+
"doesNotOwn": [
|
|
40
|
+
"domain state"
|
|
41
|
+
],
|
|
42
|
+
"workflow": [
|
|
43
|
+
"Adapt",
|
|
44
|
+
"Project",
|
|
45
|
+
"Observe"
|
|
46
|
+
],
|
|
47
|
+
"symbolNames": [
|
|
48
|
+
"Viewer3DSceneSnapshot",
|
|
49
|
+
"Viewer3DPort",
|
|
50
|
+
"createViewer3DSceneSnapshot"
|
|
51
|
+
]
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"id": "renderer-projection",
|
|
55
|
+
"title": "Renderer projection",
|
|
56
|
+
"summary": "Three.js runtime supplied through an explicit entry point and fed by borrowed ports.",
|
|
57
|
+
"authority": "State and lifecycle of the visual projection.",
|
|
58
|
+
"owns": [
|
|
59
|
+
"Three.js scene",
|
|
60
|
+
"projection camera",
|
|
61
|
+
"display cadence",
|
|
62
|
+
"renderer lifecycle"
|
|
63
|
+
],
|
|
64
|
+
"doesNotOwn": [
|
|
65
|
+
"subject identity",
|
|
66
|
+
"simulation policy",
|
|
67
|
+
"observation protocol",
|
|
68
|
+
"host shell"
|
|
69
|
+
],
|
|
70
|
+
"workflow": [
|
|
71
|
+
"Receive",
|
|
72
|
+
"Project",
|
|
73
|
+
"Observe",
|
|
74
|
+
"Dispose"
|
|
75
|
+
],
|
|
76
|
+
"symbolNames": [
|
|
77
|
+
"Viewer3D",
|
|
78
|
+
"Viewer3DOptions",
|
|
79
|
+
"normalizeConfiguredDisplayFrameRate"
|
|
80
|
+
]
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"id": "composition-integration",
|
|
84
|
+
"title": "Composition and host contribution",
|
|
85
|
+
"summary": "3D specialization of a composition source and a portable host contribution.",
|
|
86
|
+
"authority": "Amodal Viewer contract specialized by the 3D incarnation.",
|
|
87
|
+
"owns": [
|
|
88
|
+
"composition source",
|
|
89
|
+
"intent",
|
|
90
|
+
"module"
|
|
91
|
+
],
|
|
92
|
+
"doesNotOwn": [
|
|
93
|
+
"host runtime",
|
|
94
|
+
"amodal Viewer contract"
|
|
95
|
+
],
|
|
96
|
+
"workflow": [
|
|
97
|
+
"Declare",
|
|
98
|
+
"Connect",
|
|
99
|
+
"Use"
|
|
100
|
+
],
|
|
101
|
+
"symbolNames": [
|
|
102
|
+
"Viewer3DIntent",
|
|
103
|
+
"ViewerWorkflowCompositionSource",
|
|
104
|
+
"createViewerWorkflowCompositionSource",
|
|
105
|
+
"Viewer3DWorkflowCompositionSource",
|
|
106
|
+
"createViewer3DWorkflowCompositionSource",
|
|
107
|
+
"viewer3DToolModule"
|
|
108
|
+
]
|
|
109
|
+
}
|
|
110
|
+
]
|
|
111
|
+
}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "1.0.0",
|
|
3
|
+
"package": "@konitif/viewer-3d",
|
|
4
|
+
"diagrams": [
|
|
5
|
+
{
|
|
6
|
+
"id": "subject-to-scene",
|
|
7
|
+
"title": "From subject to 3D scene",
|
|
8
|
+
"kind": "boundary",
|
|
9
|
+
"summary": "Viewer adapts a subject and its transforms into an observable scene without acquiring its identity.",
|
|
10
|
+
"nodes": [
|
|
11
|
+
{
|
|
12
|
+
"id": "subject",
|
|
13
|
+
"label": "Canonical subject",
|
|
14
|
+
"description": "The observed object remains owned by its domain."
|
|
15
|
+
},
|
|
16
|
+
{
|
|
17
|
+
"id": "source",
|
|
18
|
+
"label": "Composition source",
|
|
19
|
+
"description": "A compatible reading is prepared."
|
|
20
|
+
},
|
|
21
|
+
{
|
|
22
|
+
"id": "snapshot",
|
|
23
|
+
"label": "Scene snapshot",
|
|
24
|
+
"description": "Transforms and visible objects are derived."
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"id": "port",
|
|
28
|
+
"label": "3D port",
|
|
29
|
+
"description": "The renderer receives a stable contract.",
|
|
30
|
+
"tone": "runtime"
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"id": "renderer",
|
|
34
|
+
"label": "Explicit renderer",
|
|
35
|
+
"description": "Three.js projects the scene without acquiring authority over the subject.",
|
|
36
|
+
"tone": "runtime"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"id": "scene",
|
|
40
|
+
"label": "Perceptible scene",
|
|
41
|
+
"description": "The user observes the projection.",
|
|
42
|
+
"tone": "projection"
|
|
43
|
+
}
|
|
44
|
+
],
|
|
45
|
+
"edges": [
|
|
46
|
+
{
|
|
47
|
+
"from": "subject",
|
|
48
|
+
"to": "source"
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"from": "source",
|
|
52
|
+
"to": "snapshot"
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"from": "snapshot",
|
|
56
|
+
"to": "port"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"from": "port",
|
|
60
|
+
"to": "renderer"
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"from": "renderer",
|
|
64
|
+
"to": "scene"
|
|
65
|
+
}
|
|
66
|
+
],
|
|
67
|
+
"caption": "Camera, framing, and view transforms remain projection state."
|
|
68
|
+
}
|
|
69
|
+
]
|
|
70
|
+
}
|