@kittycad/lib 4.1.3 → 4.1.5
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.
|
@@ -1258,6 +1258,8 @@ export interface BodyUpdated {
|
|
|
1258
1258
|
surfaces: SurfaceCreated[];
|
|
1259
1259
|
}
|
|
1260
1260
|
export interface BooleanImprint {
|
|
1261
|
+
/** If the operation involved any intersecting solids. */
|
|
1262
|
+
any_intersections?: boolean;
|
|
1261
1263
|
/**
|
|
1262
1264
|
* {
|
|
1263
1265
|
* "format": "uuid"
|
|
@@ -1266,6 +1268,8 @@ export interface BooleanImprint {
|
|
|
1266
1268
|
extra_solid_ids?: string[];
|
|
1267
1269
|
}
|
|
1268
1270
|
export interface BooleanIntersection {
|
|
1271
|
+
/** If the operation involved any intersecting solids. */
|
|
1272
|
+
any_intersections?: boolean;
|
|
1269
1273
|
/**
|
|
1270
1274
|
* {
|
|
1271
1275
|
* "format": "uuid"
|
|
@@ -1274,6 +1278,8 @@ export interface BooleanIntersection {
|
|
|
1274
1278
|
extra_solid_ids?: string[];
|
|
1275
1279
|
}
|
|
1276
1280
|
export interface BooleanSubtract {
|
|
1281
|
+
/** If the operation involved any intersecting solids. */
|
|
1282
|
+
any_intersections?: boolean;
|
|
1277
1283
|
/**
|
|
1278
1284
|
* {
|
|
1279
1285
|
* "format": "uuid"
|
|
@@ -1282,6 +1288,8 @@ export interface BooleanSubtract {
|
|
|
1282
1288
|
extra_solid_ids?: string[];
|
|
1283
1289
|
}
|
|
1284
1290
|
export interface BooleanUnion {
|
|
1291
|
+
/** If the operation involved any intersecting solids. */
|
|
1292
|
+
any_intersections?: boolean;
|
|
1285
1293
|
/**
|
|
1286
1294
|
* {
|
|
1287
1295
|
* "format": "uuid"
|
|
@@ -2070,6 +2078,29 @@ export interface EdgeInfo {
|
|
|
2070
2078
|
}
|
|
2071
2079
|
export interface EdgeLinesVisible {
|
|
2072
2080
|
}
|
|
2081
|
+
export interface EdgeSpecifier {
|
|
2082
|
+
/**
|
|
2083
|
+
* {
|
|
2084
|
+
* "format": "uuid"
|
|
2085
|
+
* }
|
|
2086
|
+
*/
|
|
2087
|
+
end_faces?: string[];
|
|
2088
|
+
/**
|
|
2089
|
+
* {
|
|
2090
|
+
* "nullable": true,
|
|
2091
|
+
* "format": "uint32",
|
|
2092
|
+
* "minimum": 0,
|
|
2093
|
+
* "description": "Optional index for disambiguation when multiple edges share the same faces. If not provided (None), all matching edges will be used. If provided (Some(n)), only the edge at index n will be used."
|
|
2094
|
+
* }
|
|
2095
|
+
*/
|
|
2096
|
+
index?: number;
|
|
2097
|
+
/**
|
|
2098
|
+
* {
|
|
2099
|
+
* "format": "uuid"
|
|
2100
|
+
* }
|
|
2101
|
+
*/
|
|
2102
|
+
side_faces: string[];
|
|
2103
|
+
}
|
|
2073
2104
|
export interface EmailAuthenticationForm {
|
|
2074
2105
|
/**
|
|
2075
2106
|
* {
|
|
@@ -2204,15 +2235,143 @@ export interface EntityMirror {
|
|
|
2204
2235
|
/** The Face, edge, and entity ids of the patterned entities. */
|
|
2205
2236
|
entity_face_edge_ids?: FaceEdgeInfo[];
|
|
2206
2237
|
}
|
|
2238
|
+
export interface EntityMirrorAcross {
|
|
2239
|
+
/** The Face, edge, and entity ids of the patterned entities. */
|
|
2240
|
+
entity_face_edge_ids?: FaceEdgeInfo[];
|
|
2241
|
+
}
|
|
2207
2242
|
export interface EntityMirrorAcrossEdge {
|
|
2208
2243
|
/** The Face, edge, and entity ids of the patterned entities. */
|
|
2209
2244
|
entity_face_edge_ids?: FaceEdgeInfo[];
|
|
2210
2245
|
}
|
|
2246
|
+
export type EntityReference = {
|
|
2247
|
+
/** format:uuid, description:Id of the plane being referenced. */
|
|
2248
|
+
plane_id: string;
|
|
2249
|
+
/**
|
|
2250
|
+
* {
|
|
2251
|
+
* "nullable": true,
|
|
2252
|
+
* "description": "Optional primitive topology on a parent (not used for planes today)."
|
|
2253
|
+
* }
|
|
2254
|
+
*/
|
|
2255
|
+
topology_fallback?: PrimitiveTopologyFallback;
|
|
2256
|
+
type: 'plane';
|
|
2257
|
+
} | {
|
|
2258
|
+
/** format:uuid, description:Id of the face being referenced. */
|
|
2259
|
+
face_id: string;
|
|
2260
|
+
/**
|
|
2261
|
+
* {
|
|
2262
|
+
* "nullable": true,
|
|
2263
|
+
* "description": "Fallback: solid3d UUID + face index on that body when `face_id` cannot be resolved client-side."
|
|
2264
|
+
* }
|
|
2265
|
+
*/
|
|
2266
|
+
topology_fallback?: PrimitiveTopologyFallback;
|
|
2267
|
+
type: 'face';
|
|
2268
|
+
} | {
|
|
2269
|
+
/**
|
|
2270
|
+
* {
|
|
2271
|
+
* "format": "uuid"
|
|
2272
|
+
* }
|
|
2273
|
+
*/
|
|
2274
|
+
end_faces?: string[];
|
|
2275
|
+
/**
|
|
2276
|
+
* {
|
|
2277
|
+
* "nullable": true,
|
|
2278
|
+
* "format": "uint32",
|
|
2279
|
+
* "minimum": 0,
|
|
2280
|
+
* "description": "Optional index for disambiguation when multiple edges share the same faces. If not provided (None), all matching edges will be used. If provided (Some(n)), only the edge at index n will be used."
|
|
2281
|
+
* }
|
|
2282
|
+
*/
|
|
2283
|
+
index?: number;
|
|
2284
|
+
/**
|
|
2285
|
+
* {
|
|
2286
|
+
* "format": "uuid"
|
|
2287
|
+
* }
|
|
2288
|
+
*/
|
|
2289
|
+
side_faces: string[];
|
|
2290
|
+
/**
|
|
2291
|
+
* {
|
|
2292
|
+
* "nullable": true,
|
|
2293
|
+
* "description": "Fallback: solid3d UUID + edge index on that body for 3D BREP edges (distinct from `inner.index`)."
|
|
2294
|
+
* }
|
|
2295
|
+
*/
|
|
2296
|
+
topology_fallback?: PrimitiveTopologyFallback;
|
|
2297
|
+
type: 'edge';
|
|
2298
|
+
} | {
|
|
2299
|
+
/**
|
|
2300
|
+
* {
|
|
2301
|
+
* "nullable": true,
|
|
2302
|
+
* "format": "uint32",
|
|
2303
|
+
* "minimum": 0,
|
|
2304
|
+
* "description": "Optional index among the filtered candidates."
|
|
2305
|
+
* }
|
|
2306
|
+
*/
|
|
2307
|
+
index?: number;
|
|
2308
|
+
/**
|
|
2309
|
+
* {
|
|
2310
|
+
* "format": "uuid"
|
|
2311
|
+
* }
|
|
2312
|
+
*/
|
|
2313
|
+
side_faces: string[];
|
|
2314
|
+
/**
|
|
2315
|
+
* {
|
|
2316
|
+
* "nullable": true,
|
|
2317
|
+
* "description": "Fallback: solid3d UUID + vertex index on that body."
|
|
2318
|
+
* }
|
|
2319
|
+
*/
|
|
2320
|
+
topology_fallback?: PrimitiveTopologyFallback;
|
|
2321
|
+
type: 'vertex';
|
|
2322
|
+
} | {
|
|
2323
|
+
/** format:uuid, description:Id of the solid2d being referenced. */
|
|
2324
|
+
solid2d_id: string;
|
|
2325
|
+
/**
|
|
2326
|
+
* {
|
|
2327
|
+
* "nullable": true,
|
|
2328
|
+
* "description": "Typically omitted: `solid2d_id` is already the owning profile. Present for schema parity with other variants."
|
|
2329
|
+
* }
|
|
2330
|
+
*/
|
|
2331
|
+
topology_fallback?: PrimitiveTopologyFallback;
|
|
2332
|
+
type: 'solid2d';
|
|
2333
|
+
} | {
|
|
2334
|
+
/** format:uuid, description:Id of the solid3d being referenced. */
|
|
2335
|
+
solid3d_id: string;
|
|
2336
|
+
/**
|
|
2337
|
+
* {
|
|
2338
|
+
* "nullable": true,
|
|
2339
|
+
* "description": "Typically omitted: `solid3d_id` is already the owning body. Present for schema parity with other variants."
|
|
2340
|
+
* }
|
|
2341
|
+
*/
|
|
2342
|
+
topology_fallback?: PrimitiveTopologyFallback;
|
|
2343
|
+
type: 'solid3d';
|
|
2344
|
+
} | {
|
|
2345
|
+
/** format:uuid, description:Id of the edge being referenced. */
|
|
2346
|
+
edge_id: string;
|
|
2347
|
+
/**
|
|
2348
|
+
* {
|
|
2349
|
+
* "nullable": true,
|
|
2350
|
+
* "description": "Fallback: solid2d UUID + curve index in that profile."
|
|
2351
|
+
* }
|
|
2352
|
+
*/
|
|
2353
|
+
topology_fallback?: PrimitiveTopologyFallback;
|
|
2354
|
+
type: 'solid2d_edge';
|
|
2355
|
+
} | {
|
|
2356
|
+
/** format:uuid, description:Id of the path containing the segment. */
|
|
2357
|
+
path_id: string;
|
|
2358
|
+
/** format:uuid, description:Id of the segment (curve) being referenced. */
|
|
2359
|
+
segment_id: string;
|
|
2360
|
+
/** nullable:true, description:Fallback: path UUID + segment curve index. */
|
|
2361
|
+
topology_fallback?: PrimitiveTopologyFallback;
|
|
2362
|
+
type: 'segment';
|
|
2363
|
+
} | {
|
|
2364
|
+
/** format:uuid, description:Id of the region being referenced. */
|
|
2365
|
+
region_id: string;
|
|
2366
|
+
/** nullable:true, description:Fallback: path UUID + region index on that path. */
|
|
2367
|
+
topology_fallback?: PrimitiveTopologyFallback;
|
|
2368
|
+
type: 'region';
|
|
2369
|
+
};
|
|
2211
2370
|
export interface EntitySetOpacity {
|
|
2212
2371
|
}
|
|
2213
2372
|
export type EntityType =
|
|
2214
2373
|
/** The type of entity */
|
|
2215
|
-
'entity' | 'object' | 'path' | 'curve' | 'solid2d' | 'solid3d' | 'edge' | 'face' | 'plane' | 'vertex';
|
|
2374
|
+
'entity' | 'object' | 'path' | 'segment' | 'curve' | 'solid2d' | 'solid3d' | 'edge' | 'face' | 'plane' | 'vertex' | 'region';
|
|
2216
2375
|
export interface Error {
|
|
2217
2376
|
error_code?: string;
|
|
2218
2377
|
message: string;
|
|
@@ -2319,8 +2478,21 @@ export interface Extrude {
|
|
|
2319
2478
|
export type ExtrudeMethod = 'new' | 'merge';
|
|
2320
2479
|
export type ExtrudeReference = {
|
|
2321
2480
|
entity_reference: {
|
|
2322
|
-
/**
|
|
2323
|
-
|
|
2481
|
+
/**
|
|
2482
|
+
* {
|
|
2483
|
+
* "nullable": true,
|
|
2484
|
+
* "format": "uuid",
|
|
2485
|
+
* "description": "Legacy UUID of the entity to extrude to. If both `entity_id` and `entity_reference` are provided, `entity_reference` takes precedence."
|
|
2486
|
+
* }
|
|
2487
|
+
*/
|
|
2488
|
+
entity_id?: string;
|
|
2489
|
+
/**
|
|
2490
|
+
* {
|
|
2491
|
+
* "nullable": true,
|
|
2492
|
+
* "description": "Entity reference (e.g. edge by side_faces). If both `entity_id` and `entity_reference` are provided, `entity_reference` takes precedence."
|
|
2493
|
+
* }
|
|
2494
|
+
*/
|
|
2495
|
+
entity_reference?: EntityReference;
|
|
2324
2496
|
};
|
|
2325
2497
|
} | {
|
|
2326
2498
|
axis: {
|
|
@@ -2691,8 +2863,21 @@ export interface FileVolume {
|
|
|
2691
2863
|
volume?: number;
|
|
2692
2864
|
}
|
|
2693
2865
|
export interface FractionOfEdge {
|
|
2694
|
-
/**
|
|
2695
|
-
|
|
2866
|
+
/**
|
|
2867
|
+
* {
|
|
2868
|
+
* "nullable": true,
|
|
2869
|
+
* "format": "uuid",
|
|
2870
|
+
* "description": "The id of the edge (legacy). If both `edge_id` and `edge_specifier` are provided, `edge_specifier` takes precedence."
|
|
2871
|
+
* }
|
|
2872
|
+
*/
|
|
2873
|
+
edge_id?: string;
|
|
2874
|
+
/**
|
|
2875
|
+
* {
|
|
2876
|
+
* "nullable": true,
|
|
2877
|
+
* "description": "Edge specifier (side_faces, end_faces, index) identifying the edge. If both `edge_id` and `edge_specifier` are provided, `edge_specifier` takes precedence."
|
|
2878
|
+
* }
|
|
2879
|
+
*/
|
|
2880
|
+
edge_specifier?: EdgeSpecifier;
|
|
2696
2881
|
/**
|
|
2697
2882
|
* {
|
|
2698
2883
|
* "default": 0,
|
|
@@ -3273,8 +3458,28 @@ export type MbdSymbol =
|
|
|
3273
3458
|
/** MBD symbol type */
|
|
3274
3459
|
'none' | 'arclength' | 'between' | 'degrees' | 'plusminus' | 'angularity' | 'cylindricity' | 'roundness' | 'concentricity' | 'straightness' | 'parallelism' | 'flatness' | 'profileofline' | 'surfaceprofile' | 'symmetry' | 'perpendicularity' | 'runout' | 'totalrunout' | 'position' | 'centerline' | 'partingline' | 'isoenvelope' | 'isoenvelopenony145m' | 'freestate' | 'statisticaltolerance' | 'continuousfeature' | 'independency' | 'depth' | 'start' | 'leastcondition' | 'maxcondition' | 'conicaltaper' | 'projected' | 'slope' | 'micro' | 'tangentplane' | 'unilateral' | 'squarefeature' | 'countersink' | 'spotface' | 'target' | 'diameter' | 'radius' | 'sphericalradius' | 'sphericaldiameter' | 'controlledradius' | 'boxstart' | 'boxbar' | 'boxbarbetween' | 'letterbackwardunderline' | 'punctuationbackwardunderline' | 'modifierbackwardunderline' | 'numericbackwardunderline' | 'boxend' | 'datumup' | 'datumleft' | 'datumright' | 'datumdown' | 'datumtriangle' | 'halfspace' | 'quarterspace' | 'eighthspace' | 'modifierspace';
|
|
3275
3460
|
export type Method = 'OPTIONS' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'TRACE' | 'CONNECT' | 'PATCH' | 'EXTENSION';
|
|
3461
|
+
export type MirrorAcross = {
|
|
3462
|
+
edge: {
|
|
3463
|
+
/** format:uuid, description:Edge ID. */
|
|
3464
|
+
id: string;
|
|
3465
|
+
};
|
|
3466
|
+
} | {
|
|
3467
|
+
axis: {
|
|
3468
|
+
/** Axis to use as mirror. */
|
|
3469
|
+
axis: Point3d;
|
|
3470
|
+
/** Point through which the mirror axis passes. */
|
|
3471
|
+
point: Point3d;
|
|
3472
|
+
};
|
|
3473
|
+
} | {
|
|
3474
|
+
plane: {
|
|
3475
|
+
/** format:uuid, description:Plane ID. */
|
|
3476
|
+
id: string;
|
|
3477
|
+
};
|
|
3478
|
+
};
|
|
3276
3479
|
export type MlCopilotClientMessage = {
|
|
3277
3480
|
type: 'ping';
|
|
3481
|
+
} | {
|
|
3482
|
+
type: 'list_modes';
|
|
3278
3483
|
} | {
|
|
3279
3484
|
headers: {
|
|
3280
3485
|
[key: string]: string;
|
|
@@ -3342,6 +3547,16 @@ export interface MlCopilotFile {
|
|
|
3342
3547
|
name: string;
|
|
3343
3548
|
}
|
|
3344
3549
|
export type MlCopilotMode = 'fast' | 'thoughtful';
|
|
3550
|
+
export interface MlCopilotModeOption {
|
|
3551
|
+
/** Human-readable display description. */
|
|
3552
|
+
description: string;
|
|
3553
|
+
/** Client icon identifier. */
|
|
3554
|
+
icon: string;
|
|
3555
|
+
/** Stable mode identifier to send in user messages. */
|
|
3556
|
+
id: string;
|
|
3557
|
+
/** Human-readable display label. */
|
|
3558
|
+
label: string;
|
|
3559
|
+
}
|
|
3345
3560
|
export type MlCopilotServerMessage = {
|
|
3346
3561
|
pong: Record<string, unknown>;
|
|
3347
3562
|
} | {
|
|
@@ -3374,6 +3589,13 @@ export type MlCopilotServerMessage = {
|
|
|
3374
3589
|
/** The informational text. */
|
|
3375
3590
|
text: string;
|
|
3376
3591
|
};
|
|
3592
|
+
} | {
|
|
3593
|
+
modes_response: {
|
|
3594
|
+
/** Default mode identifier used when no mode is requested. */
|
|
3595
|
+
default_mode: string;
|
|
3596
|
+
/** Available modes in configuration order. */
|
|
3597
|
+
modes: MlCopilotModeOption[];
|
|
3598
|
+
};
|
|
3377
3599
|
} | {
|
|
3378
3600
|
backend_shutdown: {
|
|
3379
3601
|
/** nullable:true, description:The reason given for the backend shutdown. */
|
|
@@ -3815,11 +4037,19 @@ export type ModelingCmd = {
|
|
|
3815
4037
|
body_type?: BodyType;
|
|
3816
4038
|
/**
|
|
3817
4039
|
* {
|
|
4040
|
+
* "nullable": true,
|
|
3818
4041
|
* "format": "uuid",
|
|
3819
4042
|
* "description": "The edge to use as the axis of revolution, must be linear and lie in the plane of the solid"
|
|
3820
4043
|
* }
|
|
3821
4044
|
*/
|
|
3822
|
-
edge_id
|
|
4045
|
+
edge_id?: string;
|
|
4046
|
+
/**
|
|
4047
|
+
* {
|
|
4048
|
+
* "nullable": true,
|
|
4049
|
+
* "description": "Edge reference to use as the axis of revolution (new API). If both `edge_id` and `edge_reference` are provided, `edge_reference` takes precedence."
|
|
4050
|
+
* }
|
|
4051
|
+
*/
|
|
4052
|
+
edge_reference?: EdgeSpecifier;
|
|
3823
4053
|
/**
|
|
3824
4054
|
* {
|
|
3825
4055
|
* "default": "None",
|
|
@@ -4119,8 +4349,21 @@ export type ModelingCmd = {
|
|
|
4119
4349
|
start_angle?: Angle;
|
|
4120
4350
|
type: 'entity_make_helix_from_params';
|
|
4121
4351
|
} | {
|
|
4122
|
-
/**
|
|
4123
|
-
|
|
4352
|
+
/**
|
|
4353
|
+
* {
|
|
4354
|
+
* "nullable": true,
|
|
4355
|
+
* "format": "uuid",
|
|
4356
|
+
* "description": "Edge ID about which to make the helix (legacy API, for backwards compatibility). If both `edge_id` and `edge_reference` are provided, `edge_reference` takes precedence."
|
|
4357
|
+
* }
|
|
4358
|
+
*/
|
|
4359
|
+
edge_id?: string;
|
|
4360
|
+
/**
|
|
4361
|
+
* {
|
|
4362
|
+
* "nullable": true,
|
|
4363
|
+
* "description": "Edge reference about which to make the helix (new API). If both `edge_id` and `edge_reference` are provided, `edge_reference` takes precedence."
|
|
4364
|
+
* }
|
|
4365
|
+
*/
|
|
4366
|
+
edge_reference?: EdgeSpecifier;
|
|
4124
4367
|
/** Is the helix rotation clockwise? */
|
|
4125
4368
|
is_clockwise: boolean;
|
|
4126
4369
|
/**
|
|
@@ -4137,6 +4380,16 @@ export type ModelingCmd = {
|
|
|
4137
4380
|
/** default:{unit:degrees, value:0}, description:Start angle. */
|
|
4138
4381
|
start_angle?: Angle;
|
|
4139
4382
|
type: 'entity_make_helix_from_edge';
|
|
4383
|
+
} | {
|
|
4384
|
+
/** What to mirror across */
|
|
4385
|
+
across: MirrorAcross;
|
|
4386
|
+
/**
|
|
4387
|
+
* {
|
|
4388
|
+
* "format": "uuid"
|
|
4389
|
+
* }
|
|
4390
|
+
*/
|
|
4391
|
+
ids: string[];
|
|
4392
|
+
type: 'entity_mirror_across';
|
|
4140
4393
|
} | {
|
|
4141
4394
|
/** Axis to use as mirror. */
|
|
4142
4395
|
axis: Point3d;
|
|
@@ -4152,11 +4405,19 @@ export type ModelingCmd = {
|
|
|
4152
4405
|
} | {
|
|
4153
4406
|
/**
|
|
4154
4407
|
* {
|
|
4408
|
+
* "nullable": true,
|
|
4155
4409
|
* "format": "uuid",
|
|
4156
|
-
* "description": "The edge to use as the mirror axis
|
|
4410
|
+
* "description": "The edge to use as the mirror axis (legacy API). Must be linear and lie in the plane of the solid. If both `edge_id` and `edge_reference` are provided, `edge_reference` takes precedence."
|
|
4157
4411
|
* }
|
|
4158
4412
|
*/
|
|
4159
|
-
edge_id
|
|
4413
|
+
edge_id?: string;
|
|
4414
|
+
/**
|
|
4415
|
+
* {
|
|
4416
|
+
* "nullable": true,
|
|
4417
|
+
* "description": "Edge reference to use as the mirror axis (new API). If both `edge_id` and `edge_reference` are provided, `edge_reference` takes precedence."
|
|
4418
|
+
* }
|
|
4419
|
+
*/
|
|
4420
|
+
edge_reference?: EdgeSpecifier;
|
|
4160
4421
|
/**
|
|
4161
4422
|
* {
|
|
4162
4423
|
* "format": "uuid"
|
|
@@ -4170,6 +4431,16 @@ export type ModelingCmd = {
|
|
|
4170
4431
|
/** What entity was selected? */
|
|
4171
4432
|
selection_type: SceneSelectionType;
|
|
4172
4433
|
type: 'select_with_point';
|
|
4434
|
+
} | {
|
|
4435
|
+
/** Where in the window was selected */
|
|
4436
|
+
selected_at_window: Point2d;
|
|
4437
|
+
/** What entity was selected? */
|
|
4438
|
+
selection_type: SceneSelectionType;
|
|
4439
|
+
type: 'query_entity_type_with_point';
|
|
4440
|
+
} | {
|
|
4441
|
+
/** format:uuid, description:The entity id to query */
|
|
4442
|
+
entity_id: string;
|
|
4443
|
+
type: 'query_entity_type';
|
|
4173
4444
|
} | {
|
|
4174
4445
|
/**
|
|
4175
4446
|
* {
|
|
@@ -4363,6 +4634,8 @@ export type ModelingCmd = {
|
|
|
4363
4634
|
* }
|
|
4364
4635
|
*/
|
|
4365
4636
|
edge_ids?: string[];
|
|
4637
|
+
/** A struct containing the information required to reference an edge. */
|
|
4638
|
+
edges_references?: EdgeSpecifier[];
|
|
4366
4639
|
/**
|
|
4367
4640
|
* {
|
|
4368
4641
|
* "format": "uuid"
|
|
@@ -4380,6 +4653,31 @@ export type ModelingCmd = {
|
|
|
4380
4653
|
type: 'solid3d_fillet_edge';
|
|
4381
4654
|
/** If true, use the legacy CSG algorithm. */
|
|
4382
4655
|
use_legacy?: boolean;
|
|
4656
|
+
} | {
|
|
4657
|
+
/** The cut type and information required to perform the cut. */
|
|
4658
|
+
cut_type: CutTypeV2;
|
|
4659
|
+
/**
|
|
4660
|
+
* {
|
|
4661
|
+
* "default": [],
|
|
4662
|
+
* "description": "A struct containing the information required to reference an edge."
|
|
4663
|
+
* }
|
|
4664
|
+
*/
|
|
4665
|
+
edges_references?: EdgeSpecifier[];
|
|
4666
|
+
/**
|
|
4667
|
+
* {
|
|
4668
|
+
* "format": "uuid"
|
|
4669
|
+
* }
|
|
4670
|
+
*/
|
|
4671
|
+
extra_face_ids?: string[];
|
|
4672
|
+
/** format:uuid, description:Which object is being cut. */
|
|
4673
|
+
object_id: string;
|
|
4674
|
+
/** default:automatic, description:Which cutting algorithm to use. */
|
|
4675
|
+
strategy?: CutStrategy;
|
|
4676
|
+
/** The maximum acceptable surface gap computed between the cut surfaces. Must be positive (i.e. greater than zero). */
|
|
4677
|
+
tolerance: LengthUnit;
|
|
4678
|
+
type: 'solid3d_cut_edge_references';
|
|
4679
|
+
/** If true, use the legacy CSG algorithm. */
|
|
4680
|
+
use_legacy?: boolean;
|
|
4383
4681
|
} | {
|
|
4384
4682
|
/** The cut type and information required to perform the cut. */
|
|
4385
4683
|
cut_type: CutTypeV2;
|
|
@@ -4555,9 +4853,22 @@ export type ModelingCmd = {
|
|
|
4555
4853
|
curve_id: string;
|
|
4556
4854
|
type: 'curve_get_control_points';
|
|
4557
4855
|
} | {
|
|
4558
|
-
/**
|
|
4559
|
-
|
|
4560
|
-
|
|
4856
|
+
/**
|
|
4857
|
+
* {
|
|
4858
|
+
* "nullable": true,
|
|
4859
|
+
* "format": "uuid",
|
|
4860
|
+
* "description": "Which entity to project (vertex or edge). Legacy; if both `entity_id` and `entity_reference` are provided, `entity_reference` takes precedence."
|
|
4861
|
+
* }
|
|
4862
|
+
*/
|
|
4863
|
+
entity_id?: string;
|
|
4864
|
+
/**
|
|
4865
|
+
* {
|
|
4866
|
+
* "nullable": true,
|
|
4867
|
+
* "description": "Entity reference (e.g. edge by side_faces, vertex, face) to project. If both `entity_id` and `entity_reference` are provided, `entity_reference` takes precedence."
|
|
4868
|
+
* }
|
|
4869
|
+
*/
|
|
4870
|
+
entity_reference?: EntityReference;
|
|
4871
|
+
/** format:uuid, description:Which plane to project the entity onto. */
|
|
4561
4872
|
plane_id: string;
|
|
4562
4873
|
type: 'project_entity_to_plane';
|
|
4563
4874
|
/** If true: the projected points are returned in the plane_id's coordinate system, else: the projected points are returned in the world coordinate system. */
|
|
@@ -4871,6 +5182,10 @@ export type ModelingCmd = {
|
|
|
4871
5182
|
type: 'solid3d_get_adjacency_info';
|
|
4872
5183
|
} | {
|
|
4873
5184
|
type: 'select_clear';
|
|
5185
|
+
} | {
|
|
5186
|
+
/** Which entities to select (face-based references for edges/vertices, face_id for faces) */
|
|
5187
|
+
entities: EntityReference[];
|
|
5188
|
+
type: 'select_entity';
|
|
4874
5189
|
} | {
|
|
4875
5190
|
type: 'select_get';
|
|
4876
5191
|
} | {
|
|
@@ -5062,12 +5377,16 @@ export type ModelingCmd = {
|
|
|
5062
5377
|
/** format:uuid, description:First segment to follow to find the region. */
|
|
5063
5378
|
segment: string;
|
|
5064
5379
|
type: 'create_region';
|
|
5380
|
+
/** Which version of the Region endpoint to call. */
|
|
5381
|
+
version?: RegionVersion;
|
|
5065
5382
|
} | {
|
|
5066
5383
|
/** format:uuid, description:Which sketch object to create the region from. */
|
|
5067
5384
|
object_id: string;
|
|
5068
5385
|
/** The query point (in the same coordinates as the sketch itself) if a possible sketch region contains this point, then that region will be created */
|
|
5069
5386
|
query_point: Point2d;
|
|
5070
5387
|
type: 'create_region_from_query_point';
|
|
5388
|
+
/** Which version of the Region endpoint to call. */
|
|
5389
|
+
version?: RegionVersion;
|
|
5071
5390
|
} | {
|
|
5072
5391
|
/** format:uuid, description:Which region to search within */
|
|
5073
5392
|
region_id: string;
|
|
@@ -5532,6 +5851,14 @@ export type OkModelingCmdResponse = {
|
|
|
5532
5851
|
*/
|
|
5533
5852
|
data: Solid3dFilletEdge;
|
|
5534
5853
|
type: 'solid3d_fillet_edge';
|
|
5854
|
+
} | {
|
|
5855
|
+
/**
|
|
5856
|
+
* {
|
|
5857
|
+
* "$ref": "#/components/schemas/Solid3dCutEdgeReferences"
|
|
5858
|
+
* }
|
|
5859
|
+
*/
|
|
5860
|
+
data: Solid3dCutEdgeReferences;
|
|
5861
|
+
type: 'solid3d_cut_edge_references';
|
|
5535
5862
|
} | {
|
|
5536
5863
|
/**
|
|
5537
5864
|
* {
|
|
@@ -5772,6 +6099,14 @@ export type OkModelingCmdResponse = {
|
|
|
5772
6099
|
*/
|
|
5773
6100
|
data: SelectClear;
|
|
5774
6101
|
type: 'select_clear';
|
|
6102
|
+
} | {
|
|
6103
|
+
/**
|
|
6104
|
+
* {
|
|
6105
|
+
* "$ref": "#/components/schemas/SelectEntity"
|
|
6106
|
+
* }
|
|
6107
|
+
*/
|
|
6108
|
+
data: SelectEntity;
|
|
6109
|
+
type: 'select_entity';
|
|
5775
6110
|
} | {
|
|
5776
6111
|
/**
|
|
5777
6112
|
* {
|
|
@@ -5804,6 +6139,22 @@ export type OkModelingCmdResponse = {
|
|
|
5804
6139
|
*/
|
|
5805
6140
|
data: SelectWithPoint;
|
|
5806
6141
|
type: 'select_with_point';
|
|
6142
|
+
} | {
|
|
6143
|
+
/**
|
|
6144
|
+
* {
|
|
6145
|
+
* "$ref": "#/components/schemas/QueryEntityTypeWithPoint"
|
|
6146
|
+
* }
|
|
6147
|
+
*/
|
|
6148
|
+
data: QueryEntityTypeWithPoint;
|
|
6149
|
+
type: 'query_entity_type_with_point';
|
|
6150
|
+
} | {
|
|
6151
|
+
/**
|
|
6152
|
+
* {
|
|
6153
|
+
* "$ref": "#/components/schemas/QueryEntityType"
|
|
6154
|
+
* }
|
|
6155
|
+
*/
|
|
6156
|
+
data: QueryEntityType;
|
|
6157
|
+
type: 'query_entity_type';
|
|
5807
6158
|
} | {
|
|
5808
6159
|
/**
|
|
5809
6160
|
* {
|
|
@@ -6372,6 +6723,14 @@ export type OkModelingCmdResponse = {
|
|
|
6372
6723
|
*/
|
|
6373
6724
|
data: EntityMirror;
|
|
6374
6725
|
type: 'entity_mirror';
|
|
6726
|
+
} | {
|
|
6727
|
+
/**
|
|
6728
|
+
* {
|
|
6729
|
+
* "$ref": "#/components/schemas/EntityMirrorAcross"
|
|
6730
|
+
* }
|
|
6731
|
+
*/
|
|
6732
|
+
data: EntityMirrorAcross;
|
|
6733
|
+
type: 'entity_mirror_across';
|
|
6375
6734
|
} | {
|
|
6376
6735
|
/**
|
|
6377
6736
|
* {
|
|
@@ -7528,6 +7887,23 @@ export interface PriceUpsertRequest {
|
|
|
7528
7887
|
/** format:double, description:Amount in USD. */
|
|
7529
7888
|
unit_amount: number;
|
|
7530
7889
|
}
|
|
7890
|
+
export interface PrimitiveTopologyFallback {
|
|
7891
|
+
/**
|
|
7892
|
+
* {
|
|
7893
|
+
* "format": "uuid",
|
|
7894
|
+
* "description": "UUID of the parent entity that owns the primitive (solid3d, solid2d, or path)."
|
|
7895
|
+
* }
|
|
7896
|
+
*/
|
|
7897
|
+
parent_id: string;
|
|
7898
|
+
/**
|
|
7899
|
+
* {
|
|
7900
|
+
* "format": "uint32",
|
|
7901
|
+
* "minimum": 0,
|
|
7902
|
+
* "description": "Index of the face, edge, vertex, profile curve, or path segment on `parent_id`."
|
|
7903
|
+
* }
|
|
7904
|
+
*/
|
|
7905
|
+
primitive_index: number;
|
|
7906
|
+
}
|
|
7531
7907
|
export interface PrivacySettings {
|
|
7532
7908
|
/** If we can train on the data. If the user is a member of an organization, the organization's setting will override this. The organization's setting takes priority. */
|
|
7533
7909
|
can_train_on_data: boolean;
|
|
@@ -7731,6 +8107,19 @@ export interface PublicProjectVoteResponse {
|
|
|
7731
8107
|
/** Whether the authenticated viewer currently likes the project. */
|
|
7732
8108
|
liked: boolean;
|
|
7733
8109
|
}
|
|
8110
|
+
export interface QueryEntityType {
|
|
8111
|
+
/** How to reference the provided entity using face ids. */
|
|
8112
|
+
reference: EntityReference;
|
|
8113
|
+
}
|
|
8114
|
+
export interface QueryEntityTypeWithPoint {
|
|
8115
|
+
/**
|
|
8116
|
+
* {
|
|
8117
|
+
* "nullable": true,
|
|
8118
|
+
* "description": "How to reference the selected entity using face ids. None if no entity was found at the given point (e.g. clicked in empty space)."
|
|
8119
|
+
* }
|
|
8120
|
+
*/
|
|
8121
|
+
reference?: EntityReference;
|
|
8122
|
+
}
|
|
7734
8123
|
export interface RawFile {
|
|
7735
8124
|
/**
|
|
7736
8125
|
* {
|
|
@@ -7797,6 +8186,7 @@ export interface RegionGetQueryPoint {
|
|
|
7797
8186
|
/** A point that is inside of the queried region, in the same coordinate frame as the sketch itself */
|
|
7798
8187
|
query_point: Point2d;
|
|
7799
8188
|
}
|
|
8189
|
+
export type RegionVersion = 'V0' | 'V1';
|
|
7800
8190
|
export type RelativeTo = 'sketch_plane' | 'trajectory_curve';
|
|
7801
8191
|
export interface RemoveSceneObjects {
|
|
7802
8192
|
}
|
|
@@ -7939,6 +8329,8 @@ export interface SelectAdd {
|
|
|
7939
8329
|
}
|
|
7940
8330
|
export interface SelectClear {
|
|
7941
8331
|
}
|
|
8332
|
+
export interface SelectEntity {
|
|
8333
|
+
}
|
|
7942
8334
|
export interface SelectGet {
|
|
7943
8335
|
/**
|
|
7944
8336
|
* {
|
|
@@ -8130,6 +8522,8 @@ export interface SketchModeDisable {
|
|
|
8130
8522
|
}
|
|
8131
8523
|
export interface Solid2dAddHole {
|
|
8132
8524
|
}
|
|
8525
|
+
export interface Solid3dCutEdgeReferences {
|
|
8526
|
+
}
|
|
8133
8527
|
export interface Solid3dCutEdges {
|
|
8134
8528
|
}
|
|
8135
8529
|
export interface Solid3dFilletEdge {
|
|
@@ -10257,6 +10651,7 @@ export interface Models {
|
|
|
10257
10651
|
DxfStorage: DxfStorage;
|
|
10258
10652
|
EdgeInfo: EdgeInfo;
|
|
10259
10653
|
EdgeLinesVisible: EdgeLinesVisible;
|
|
10654
|
+
EdgeSpecifier: EdgeSpecifier;
|
|
10260
10655
|
EmailAuthenticationForm: EmailAuthenticationForm;
|
|
10261
10656
|
EmailMarketingConfirmTokenBody: EmailMarketingConfirmTokenBody;
|
|
10262
10657
|
EmailMarketingConsentState: EmailMarketingConsentState;
|
|
@@ -10282,7 +10677,9 @@ export interface Models {
|
|
|
10282
10677
|
EntityMakeHelixFromEdge: EntityMakeHelixFromEdge;
|
|
10283
10678
|
EntityMakeHelixFromParams: EntityMakeHelixFromParams;
|
|
10284
10679
|
EntityMirror: EntityMirror;
|
|
10680
|
+
EntityMirrorAcross: EntityMirrorAcross;
|
|
10285
10681
|
EntityMirrorAcrossEdge: EntityMirrorAcrossEdge;
|
|
10682
|
+
EntityReference: EntityReference;
|
|
10286
10683
|
EntitySetOpacity: EntitySetOpacity;
|
|
10287
10684
|
EntityType: EntityType;
|
|
10288
10685
|
Error: Error;
|
|
@@ -10357,9 +10754,11 @@ export interface Models {
|
|
|
10357
10754
|
Mass: Mass;
|
|
10358
10755
|
MbdSymbol: MbdSymbol;
|
|
10359
10756
|
Method: Method;
|
|
10757
|
+
MirrorAcross: MirrorAcross;
|
|
10360
10758
|
MlCopilotClientMessage: MlCopilotClientMessage;
|
|
10361
10759
|
MlCopilotFile: MlCopilotFile;
|
|
10362
10760
|
MlCopilotMode: MlCopilotMode;
|
|
10761
|
+
MlCopilotModeOption: MlCopilotModeOption;
|
|
10363
10762
|
MlCopilotServerMessage: MlCopilotServerMessage;
|
|
10364
10763
|
MlCopilotSupportedModels: MlCopilotSupportedModels;
|
|
10365
10764
|
MlCopilotSystemCommand: MlCopilotSystemCommand;
|
|
@@ -10452,6 +10851,7 @@ export interface Models {
|
|
|
10452
10851
|
Pong: Pong;
|
|
10453
10852
|
PostEffectType: PostEffectType;
|
|
10454
10853
|
PriceUpsertRequest: PriceUpsertRequest;
|
|
10854
|
+
PrimitiveTopologyFallback: PrimitiveTopologyFallback;
|
|
10455
10855
|
PrivacySettings: PrivacySettings;
|
|
10456
10856
|
ProjectArchiveFormat: ProjectArchiveFormat;
|
|
10457
10857
|
ProjectCategoryResponse: ProjectCategoryResponse;
|
|
@@ -10467,10 +10867,13 @@ export interface Models {
|
|
|
10467
10867
|
PublicProjectOwnerResponse: PublicProjectOwnerResponse;
|
|
10468
10868
|
PublicProjectResponse: PublicProjectResponse;
|
|
10469
10869
|
PublicProjectVoteResponse: PublicProjectVoteResponse;
|
|
10870
|
+
QueryEntityType: QueryEntityType;
|
|
10871
|
+
QueryEntityTypeWithPoint: QueryEntityTypeWithPoint;
|
|
10470
10872
|
RawFile: RawFile;
|
|
10471
10873
|
ReasoningMessage: ReasoningMessage;
|
|
10472
10874
|
ReconfigureStream: ReconfigureStream;
|
|
10473
10875
|
RegionGetQueryPoint: RegionGetQueryPoint;
|
|
10876
|
+
RegionVersion: RegionVersion;
|
|
10474
10877
|
RelativeTo: RelativeTo;
|
|
10475
10878
|
RemoveSceneObjects: RemoveSceneObjects;
|
|
10476
10879
|
Revolve: Revolve;
|
|
@@ -10488,6 +10891,7 @@ export interface Models {
|
|
|
10488
10891
|
SceneToolType: SceneToolType;
|
|
10489
10892
|
SelectAdd: SelectAdd;
|
|
10490
10893
|
SelectClear: SelectClear;
|
|
10894
|
+
SelectEntity: SelectEntity;
|
|
10491
10895
|
SelectGet: SelectGet;
|
|
10492
10896
|
SelectRegionFromPoint: SelectRegionFromPoint;
|
|
10493
10897
|
SelectRemove: SelectRemove;
|
|
@@ -10518,6 +10922,7 @@ export interface Models {
|
|
|
10518
10922
|
SideFace: SideFace;
|
|
10519
10923
|
SketchModeDisable: SketchModeDisable;
|
|
10520
10924
|
Solid2dAddHole: Solid2dAddHole;
|
|
10925
|
+
Solid3dCutEdgeReferences: Solid3dCutEdgeReferences;
|
|
10521
10926
|
Solid3dCutEdges: Solid3dCutEdges;
|
|
10522
10927
|
Solid3dFilletEdge: Solid3dFilletEdge;
|
|
10523
10928
|
Solid3dFlip: Solid3dFlip;
|