Skip to content

Commit 82f2ae8

Browse files
tsturmtsturm
authored
🤖 Merge PR DefinitelyTyped#74188 [webvis] Update type definitions for the non-npm package webvis 3.12.x by @tsturm 
1 parent 4330aa1 commit 82f2ae8

12 files changed

Lines changed: 4519 additions & 528 deletions

‎types/webvis/index.d.ts‎

Lines changed: 4286 additions & 525 deletions
Large diffs are not rendered by default.

‎types/webvis/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"private": true,
33
"nonNpm": true,
4-
"nonNpmDescription": "Type definitions for non-npm package webvis 3.11",
4+
"nonNpmDescription": "Type definitions for non-npm package webvis 3.12",
55
"name": "@types/webvis",
6-
"version": "3.11.9999",
6+
"version": "3.12.9999",
77
"projects": [
88
"https://threedy.io"
99
],

‎types/webvis/test/ClipPlaneAPI.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ function test(testContext: webvis.ContextAPI): void {
5151

5252
const clipRoomRemoveState: webvis.RemoveState = testContext.removeClippingRoom(false);
5353

54-
const clipRoomId2: number = testContext.getClipRoom();
54+
const clipRoomId2: number | undefined = testContext.getClipRoom();
5555

5656
const clipRoomProps: Promise<webvis.ClipRoomProperties> = testContext.requestClipRoomData();
5757

‎types/webvis/test/MeasurementAPI.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,11 @@ function test(testContext: webvis.ContextAPI): void {
101101
measurementTargetLineSegment,
102102
);
103103

104+
const measureNormalResult: Promise<webvis.NormalMeasurementResult> = testContext.measureNormal(
105+
measurementTargetTopology,
106+
measurementTargetPoint,
107+
);
108+
104109
const measureTangentResult: Promise<webvis.TangentMeasurementResult> = testContext.measureTangent(
105110
measurementTargetTopology,
106111
measurementTargetPoint,

‎types/webvis/test/MemberAPI.ts‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
function test(testContext: webvis.ContextAPI): void {
2+
const setEntryPromise: Promise<void> = testContext.setMemberProfileEntry("testKey", "testValue");
3+
4+
const deleteEntryPromise: Promise<void> = testContext.deleteMemberProfileEntry("testKey");
5+
6+
const members: number[] = testContext.getMembers();
7+
8+
const memberActionsPromise: Promise<webvis.MemberAction[]> = testContext.requestMemberActions(0);
9+
10+
const memberPropertiesPromise: Promise<webvis.MemberProperties | undefined> = testContext.requestMemberProperties(
11+
0,
12+
);
13+
14+
const memberName: string | undefined = testContext.getMemberName();
15+
16+
const useActionPromise: Promise<void> = testContext.useMemberAction(0, webvis.MemberAction.DEMOTE, {
17+
role: webvis.MemberRole.VIEWER,
18+
});
19+
20+
testContext.setMemberName("Test Name");
21+
22+
testContext.registerListener([webvis.EventType.MEMBER_ACTION_ADDED], (event: webvis.MemberActionAddedEvent) => {
23+
console.log("MemberAction added", event.memberId, event.memberAction);
24+
});
25+
26+
testContext.registerListener([webvis.EventType.MEMBER_ACTION_REMOVED], (event: webvis.MemberActionRemovedEvent) => {
27+
console.log("MemberAction removed", event.memberId, event.memberAction);
28+
});
29+
30+
testContext.registerListener([webvis.EventType.MEMBER_ACTION_USED], (event: webvis.MemberActionUsedEvent) => {
31+
console.log("MemberAction used", event.sourceMemberId, event.targetMemberId, event.memberAction, event.details);
32+
});
33+
34+
testContext.registerListener([webvis.EventType.MEMBER_CREATED], (event: webvis.MemberCreatedEvent) => {
35+
console.log("Member created", event.memberId, event.memberProperties);
36+
});
37+
38+
testContext.registerListener([webvis.EventType.MEMBER_CHANGED], (event: webvis.MemberChangedEvent) => {
39+
console.log("Member changed", event.memberId, event.memberProperties);
40+
});
41+
42+
testContext.registerListener([webvis.EventType.MEMBER_REMOVED], (event: webvis.MemberRemovedEvent) => {
43+
console.log("Member removed", event.memberId);
44+
});
45+
}

‎types/webvis/test/SessionStorageAPI.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ function test(testContext: webvis.ContextAPI): void {
33
thumbnail: true,
44
thumbnailHeight: 100,
55
thumbnailWidth: 100,
6+
storeBackground: true,
67
});
78

89
const restoreSnapshotPromise: Promise<void> = testContext.restoreSnapshot(3);

‎types/webvis/test/SpaceAPI.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
function test(testContext: webvis.ContextAPI): void {
2+
const emptySpacePromise: Promise<void> = testContext.openSpace();
3+
const existingSpacePromise: Promise<void> = testContext.openSpace("default/1bb548e6-383d-47a5-ad10-cb7ddb9cbbcc");
4+
5+
const cloneSpacePromise: Promise<void> = testContext.cloneIntoNewSpace();
6+
7+
const spaceHandle: Promise<string> = testContext.requestSpaceHandle(webvis.MemberRole.OWNER);
8+
9+
testContext.registerListener([webvis.EventType.SPACE_OPENED], (event: webvis.SpaceOpenedEvent) => {
10+
console.log("Space opened");
11+
});
12+
}

‎types/webvis/test/TopologyAPI.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ function test(testContext: webvis.ContextAPI): void {
6565
topoHandle1,
6666
]);
6767

68+
const shapeHandles: Promise<webvis.TopologyHandle[]> = testContext.requestShapeHandles(1);
69+
6870
const topoDescriptor: Promise<webvis.TopologyDescriptor> = testContext.requestTopologyDescriptor(
6971
topoHandle0,
7072
);
@@ -88,4 +90,7 @@ function test(testContext: webvis.ContextAPI): void {
8890

8991
const setTopoSelectionPromise: Promise<void> = testContext.setTopologySelection(topoHandle0);
9092
const setToposSelectionPromise: Promise<void> = testContext.setTopologySelection([topoHandle0, topoHandle1]);
93+
94+
const neighboringEdgesPromise: Promise<webvis.TopologyHandle[]> = testContext.requestNeighboringEdges(topoHandle0);
95+
const neighboringFacesPromise: Promise<webvis.TopologyHandle[]> = testContext.requestNeighboringFaces(topoHandle0);
9196
}

‎types/webvis/test/ViewerBackgroundAPI.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
function test(testContext: webvis.ContextAPI, testViewer: webvis.ViewerAPI): void {
2+
testViewer.clearBackground();
3+
}

‎types/webvis/test/ViewerPointOfInterestAPI.ts‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
function test(testContext: webvis.ContextAPI, testViewer: webvis.ViewerAPI): void {
2+
const points: webvis.PointOfInterest[] = [
3+
{
4+
id: 2,
5+
label: "Test point 1",
6+
position: [0, 0, 0],
7+
},
8+
{
9+
id: 1,
10+
label: "Test point 2",
11+
position: [1, 1, 1],
12+
},
13+
];
14+
15+
const defaultPOIStyleId: number = testViewer.createPOIStyle();
16+
const customPOIStyleId: number = testViewer.createPOIStyle({
17+
color: [1, 0, 0, 0.7],
18+
size: 15,
19+
sprite: null,
20+
name: "Test Style",
21+
});
22+
23+
const changePOIStyleResult: webvis.POIStyleProperties = testViewer.changePOIStyle(1, {
24+
color: [0, 1, 0, 0.7],
25+
size: 20,
26+
sprite: null,
27+
name: "Changed Test Style",
28+
});
29+
30+
testViewer.removePOIStyle(1);
31+
32+
const getPOIStyleDataResult: webvis.POIStyleProperties | undefined = testViewer.getPOIStyleData(1);
33+
34+
const getPOIStylesResult: number[] = testViewer.getPOIStyles();
35+
36+
const defaultPOISetId: number = testViewer.createPOISet();
37+
const customPOISetId: number = testViewer.createPOISet({
38+
enabled: true,
39+
styleVisible: 0,
40+
styleOccluded: 1,
41+
styleHovered: 2,
42+
useWorldUnits: false,
43+
points: points,
44+
labelColor: [1, 0, 0],
45+
labelOutlineColor: [0, 0, 0],
46+
name: "Test Label",
47+
});
48+
49+
const changePOISetResult: webvis.POISetProperties = testViewer.changePOISet(0, {
50+
enabled: false,
51+
styleVisible: 2,
52+
styleOccluded: 1,
53+
styleHovered: 0,
54+
useWorldUnits: true,
55+
points: points,
56+
labelColor: [1, 1, 0],
57+
labelOutlineColor: [1, 0, 1],
58+
name: "Changed test Label",
59+
});
60+
61+
testViewer.removePOISet(3);
62+
63+
const getPOISetDataResult: webvis.POISetProperties | undefined = testViewer.getPOISetData(2);
64+
65+
const getPOISetsResult: number[] = testViewer.getPOISets();
66+
67+
const addPointsToSetResult: number[] = testViewer.addPointsToSet(3, points);
68+
69+
testViewer.removePointsFromSet(customPOISetId, [2]);
70+
71+
testViewer.changePointsInSet(1, [1, 2], points);
72+
73+
testContext.registerListener([webvis.EventType.VIEWER_POI_CLICKED], (event: webvis.ViewerPOIClickedEvent) => {
74+
console.log("POISet clicked", event.viewerId, event.poiSetId, event.poiId, event.originalEvent);
75+
});
76+
77+
testContext.registerListener(
78+
[webvis.EventType.VIEWER_POI_POINTER_ENTER],
79+
(event: webvis.ViewerPOIPointerEnterEvent) => {
80+
console.log("POISet enter", event.viewerId, event.poiSetId, event.poiId, event.originalEvent);
81+
},
82+
);
83+
84+
testContext.registerListener(
85+
[webvis.EventType.VIEWER_POI_POINTER_OUT],
86+
(event: webvis.ViewerPOIPointerOutEvent) => {
87+
console.log("POISet out", event.viewerId, event.poiSetId, event.poiId, event.originalEvent);
88+
},
89+
);
90+
91+
testContext.registerListener(
92+
[webvis.EventType.VIEWER_POI_SET_CHANGED],
93+
(event: webvis.ViewerPOISetChangedEvent) => {
94+
console.log("POISet changed", event.viewerId, event.poiSetId, event.properties);
95+
},
96+
);
97+
98+
testContext.registerListener(
99+
[webvis.EventType.VIEWER_POI_SET_CREATED],
100+
(event: webvis.ViewerPOISetCreatedEvent) => {
101+
console.log("POISet created", event.viewerId, event.poiSetId, event.properties);
102+
},
103+
);
104+
105+
testContext.registerListener(
106+
[webvis.EventType.VIEWER_POI_SET_REMOVED],
107+
(event: webvis.ViewerPOISetRemovedEvent) => {
108+
console.log("POISet removed", event.viewerId, event.poiSetId);
109+
},
110+
);
111+
112+
testContext.registerListener(
113+
[webvis.EventType.VIEWER_POI_SET_POINTS_ADDED],
114+
(event: webvis.ViewerPOISetPointsAddedEvent) => {
115+
console.log("Points added", event.viewerId, event.poiSetId, event.poiIds, event.properties);
116+
},
117+
);
118+
119+
testContext.registerListener(
120+
[webvis.EventType.VIEWER_POI_SET_POINTS_CHANGED],
121+
(event: webvis.ViewerPOISetPointsChangedEvent) => {
122+
console.log("Points changed", event.viewerId, event.poiSetId, event.poiIds);
123+
},
124+
);
125+
126+
testContext.registerListener(
127+
[webvis.EventType.VIEWER_POI_SET_POINTS_REMOVED],
128+
(event: webvis.ViewerPOISetPointsRemovedEvent) => {
129+
console.log("Points removed", event.viewerId, event.poiSetId, event.poiIds);
130+
},
131+
);
132+
133+
testContext.registerListener(
134+
[webvis.EventType.VIEWER_POI_STYLE_CHANGED],
135+
(event: webvis.ViewerPOIStyleChangedEvent) => {
136+
console.log("POIStyle changed", event.viewerId, event.poiStyleId, event.poiStyleProperties);
137+
},
138+
);
139+
140+
testContext.registerListener(
141+
[webvis.EventType.VIEWER_POI_STYLE_CREATED],
142+
(event: webvis.ViewerPOIStyleCreatedEvent) => {
143+
console.log("POIStyle created", event.viewerId, event.poiStyleId, event.poiStyleProperties);
144+
},
145+
);
146+
147+
testContext.registerListener(
148+
[webvis.EventType.VIEWER_POI_STYLE_REMOVED],
149+
(event: webvis.ViewerPOIStyleRemovedEvent) => {
150+
console.log("POIStyle removed", event.viewerId, event.poiStyleId);
151+
},
152+
);
153+
}

0 commit comments

Comments
 (0)