VXL reference: requirements
Every entry of the top-level requirements[] table is tagged with its requirement kind; an unknown kind is VXL-R602.
Every kind-tagged entry also carries the common fields: id id, when boolean expression string, required bool, covers string[], at_each at_each clause[], notes string.
The table lists only the fields each kind adds beyond those common fields. A stray expect key on a kind that does not define one is VXL-R601; expectations live in the named tolerance and selector objects.
Type legend: expr is an expression (a JSON number literal or an expression string) and a boolean expression string is an expression that yields a bool; [expr; 2] and [expr; 3] are tuples; an [] suffix marks a list, and (each/emit item allowed) marks a list that also takes an {"each": [clause…], "emit": template} generator item (§3.2); italic names are object shapes described in the body of this manual; required fields are bold.
kind |
Fields |
|---|---|
scene_graph |
scene id, at id, roots unsigned integer, mesh_definitions unsigned integer, reuses map of unsigned integer |
scene_attribute_index |
scene id, at id, rows map of unsigned integer, dictionaries token base_materials/color_group/texture_2d_group/multi_properties[] |
scene_export_exact |
scene id, export id |
scene_placement |
scene id, at id, part_number string, before [expr; 3], delta [expr; 3], after [expr; 3], changed_roots unsigned integer, unchanged_roots unsigned integer |
scene_reopen_equal |
scene id, reopen id, equals id, fields token index/graph/dictionaries/counts/losses[] |
scene_channels |
scene id, at id, preserve token resources/materials/face_corner_colours/uv/texture_bytes/relationships/multiproperties/opaque_parts/uuids[] |
production_uuids |
scene id, at id, expect unsigned integer |
scene_bridge_map |
scene id, bridge id, domains map of unsigned integer |
scene_loss_policy |
scene id, operation id, expect channel policy row[] |
print_assembly |
delivery string, objects unsigned integer, parts string[], component_transforms token identity, root_transform token translation_only |
material_bindings |
delivery string, material string, colors any JSON |
ams_slots |
delivery string, configured unsigned integer[], used unsigned integer[], unused unsigned integer[], assignments any JSON |
slice_result |
delivery string, zero_based_tools unsigned integer[], positive_use_slots unsigned integer[], no_use_slots unsigned integer[], sequence_slots unsigned integer[], settings slice settings, geometry_equiv_tol_mm any JSON |
solid_count |
subject part id |
envelope |
subject part id, bounds bounds, size [expr; 3], min [expr; 3], max [expr; 3], tol expr |
hole |
subject part id, diameter expr, axis axis letter x, y or z, axis_at [expr; 3], through [expr; 2], blind blind hole stations {"mouth", "floor"}, countersink hole countersink expectation {"diameter", "angle", "at"}, mouths sharp hole-mouth expectation[], tol hole tolerance, locate expr |
planar_face |
subject part id, normal direction, at expr, through [expr; 3], flatness expr, tol planar tolerance, near window |
fillet_radius |
subject part id, radius expr, between [face selector; 2], tol expr, near window |
volume_range |
subject part id, min expr, max expr |
mass_range |
subject part id, density expr, min expr, max expr |
center_of_mass |
subject part id, within center of mass box, near center of mass neighbourhood |
closed_delivered_mesh |
subject part id, artifact string |
clearance |
operands [part id; 2], min expr, in assembly id, contacts clearance contact[] |
joint_travel |
in assembly id, joint part id, min_travel expr, stop_by part id, threshold_mm expr |
minimum_wall_mesh |
subject part id, min expr |
minimum_wall |
subject part id, min expr, tol expr, disk wall disk |
slot |
subject part id, from [expr; 3], to [expr; 3], axis axis letter x, y or z, width expr, through [expr; 2], blind blind hole stations {"mouth", "floor"}, tol slot tolerance, locate expr |
chamfer_size |
subject part id, distance expr, between [face selector; 2], tol expr, near window |
unmeasured |
subject part id, operands [part id; 2], describe string |
opening |
subject part id, at [expr; 3], axis direction, diameter expr, span [expr; 2] |
component_geometry |
subject part id, measurement component geometry measurement |
component_count |
subject part id, expect expr |
self_intersection_free |
subject part id |
sharp_boundary |
subject part id, between independent named support pair, run named straight run, tol support and run boundary tolerances, locate expr |
thread |
subject part id, measurement token sections_v1, form token external/internal, major_diameter expr, minor_diameter expr, pitch expr, length expr, ends token trimmed/full_profile/blind/through, audit [expr; 2], feature feature datum name, axis direction, at [expr; 3], from expr, locate expr, hand token right/left, starts expr, tol feature tolerance |
gear_teeth |
subject part id, axis gear_axis, window gear_window, module expr, teeth expr, pressure_angle expr, face_width expr, profile_shift expr, thinning expr, measurement string, phase gear_phase, tol gear_teeth_tolerance |
gear_mesh |
operands [part id; 2], in assembly id, gears [requirement id; 2], centre_distance expr, backlash gear_mesh_backlash, stations expr, measurement string, tol gear_mesh_tolerance |
outer_diameter |
subject part id, diameter expr, axis axis letter x, y or z, axis_at [expr; 3], span named axial span, tol cylinder tolerance, locate expr |
global_wall |
subject part id, operands [part id; 2] |
helix |
subject part id, measurement token sections_v1, radius expr, pitch expr, turns expr, section helix section, feature feature datum name, axis direction, at [expr; 3], from expr, locate expr, hand token right/left, starts expr, tol feature tolerance, ends token plain/closed/closed_ground, end_coils expr |
finishing_run |
subject part id, between independent named support pair, run named straight run, finish one named finish expectation, tol support and run boundary tolerances, locate expr |
conical_surface |
subject part id, axis direction, axis_at [expr; 3], span analytic_pair, diameters analytic_pair, angle expr, tol conical_tolerance, near window |
face_angle |
subject part id, between planar_support_pair, angle expr, tol expr, near window |
revolved_profile |
subject part id, axis direction, origin [expr; 3], radial direction, profile profile loop, angle expr, tol revolved_tolerance, near window |
spherical_surface |
subject part id, center [expr; 3], diameter expr, extent token full, tol spherical_tolerance, near window |
toroidal_surface |
subject part id, center [expr; 3], axis direction, major_radius expr, minor_radius expr, extent token full, tol toroidal_tolerance, near window |
draft_angle |
subject part id, wall draft wall reference {"normal", "through", "near"?}, pull direction, neutral neutral plane {"through"}, angle expr, locate expr, tol draft tolerance |
feature_distance |
operands [part id; 2], between ordered face pair {"first", "second"}, along direction, distance expr, locate expr, tol feature distance tolerance |
variable_fillet_radius |
subject part id, between [face selector; 2], run directed straight run {"from", "to"}, measurement token stations_v1, stations blend audit station {"at", "radius"}[], locate expr, tol blend tolerance |
text |
style token outline/stroke, stroke stroke text parameters, subject part id, content single text {"literal", "font", "size"} or spans {"spans", …}, placement one of planar/paragraph/path/cylinder/general_surface placement, mode token relief/engraving, depth expr, region text region {"min", "max"}, measurement token outline_depth_v1/stroke_region_depth_v1, checks optional text checks, tol text tolerance |
swept_section |
subject part id, path straight path, profile profile loop, x direction, near window, locate expr, tol path tolerance |
loft_sections |
subject part id, frame measurement frame, sections path section[] (each/emit item allowed), span linear vertex law, near window, locate expr, tol path tolerance |
guide_rail |
subject part id, points [expr; 3][], near window, locate expr, tol path tolerance |
section_frame |
subject part id, frame measurement frame, sections path section[] (each/emit item allowed), law token fixed/vertex_mean_twist, angles expr[], continuity token g0/g1/g2, near window, locate expr, tol path tolerance |
spline_surface |
subject part id, face face selector, nominal surface id or {select, from} lookup, tol expr, trim token natural/any |
surface_probe |
subject part id, face face selector, probes surface probe[], tol expr |
thickened_wall |
subject part id, faces [face selector; 2], mode token along/normal, along direction, thickness expr, tol expr |
deviation_from |
subject part id, reference part@step checkpoint reference, max expr |
enclosed_cavity_count |
subject part id, expect expr |
connector_clearance |
pin part id, socket part id, plane split plane, shafts shaft envelope[], min_radial expr, min_axial expr, tol expr |
surface_seam |
subject part id, between [face selector; 2], class token g0/g1, tol surface seam tolerance |
partition |
part part id, split step id, plane split plane, pieces expr, per_side [expr; 2], scope token boundary_v1/full_v1, tol partition tolerance |
section_contour |
subject part id, plane split plane, loops section loop[], area closed nominal interval, perimeter closed nominal interval, profile section contour named-profile match, tol section tolerance |
imprint_region |
subject part id, on imprint support plane, near window, extent window, area closed nominal interval, boundary imprint boundary, tol section tolerance |
import_admission |
subject part id, import id, as_read token exact/admitted |
repair_budget |
subject part id, import id, allow token same_parameter[], max_tolerance expr, max_growth expr, max_deviation expr |
face_displacement |
subject part id, before displacement before station, after direct-edit face selection, distance expr, locate expr, tol displacement tolerance |
material_region |
subject part id, region one closed cylinder or framed box, state token material/void, boundary_clearance expr |
flat_region |
subject part id, region mesh region, plane mesh surface object, tol expr |
observation_bounds |
subject construction-name reference, field string, min expr, max expr, exclusive bool |
observation_converged |
subject construction-name reference |
observation_rank |
subject construction-name reference, min expr |