📚 Macro API Reference

Include with: include fxGlobals.var

Blade Profile Input Modes

Constant	Value	Description
i_BLADE_TWO_POINTS	1	Two XY points define blade line (vertical only)
i_BLADE_POINT_NORMAL_LENGTH	2	Center + normal + explicit length (compound angles)
i_BLADE_POINT_NORMAL_AUTO	3	Center + normal, auto-length (compound angles)

Contact Arc Offset Modes

Constant	Value	Description
i_FX_CONTACT_ARC_MODE	0	NONE: No offset on contact arcs
	1	GRAVITY: Centre moves in gravity direction (default)
	2	PERPENDICULAR: Centre moves in averaged normal direction

Gravity Approach Directions

Pass as strings to gravity-aware macros:

String	Description
'NONE'	No gravity, uniform offset on all faces
'TOP'	Blade from above, contact on +Y faces
'BOTTOM'	Blade from below, contact on -Y faces (typical fixture)
'LEFT'	Blade from left, contact on -X faces
'RIGHT'	Blade from right, contact on +X faces
'x y'	Custom vector, e.g. '-0.707 -0.707' for 45°

Scratch Kurve Numbers

Constant	Value
i_FX_KURVE_TEMP1	31900
i_FX_KURVE_TEMP2	31901
i_FX_KURVE_RESULT	31902
i_FX_KURVE_TEST	31800

Set in fxGlobals.var to control debug output verbosity:

Level	Name	Output	Use Case
0	OFF	No debug messages	Production
1	SUMMARY	Key milestones, errors, results	Default / Testing
2	VERBOSE	Full debug output (face-by-face)	Development / Debugging

Purpose: Vector-based blade profile generation with compound angle support.

Mode 1: Two XY Points (Vertical Blade)

Mode 2: Point + Normal + Length (Compound Angles)

Mode 3: Point + Normal + Auto-Length

Returns

Variable	Value
i_return	i_OK or i_ERROR
w_return	Starting kurve number
w_return2	Total kurves created
$_return	Status message

Purpose: Test suite for gravity-aware offset using construction geometry approach.

Parameter	Description
i_mode	Test mode number (see below)
w_xPos	X position offset for test shape (optional, default 0)

Test Modes

Mode	Shape	Approach
0	Simple rectangle	BOTTOM
1	Staircase	BOTTOM
2	Simple rectangle	TOP
3	Staircase	TOP
4	Simple rectangle	LEFT
5	Simple rectangle	RIGHT
6	Simple rectangle	45° custom vector
7	Diamond shape	45° custom vector
8	Simple rectangle	NONE (uniform)
9	Staircase	NONE (uniform)
10	Rounded rectangle	BOTTOM
11	Circle	BOTTOM (fallback)
12	Mixed lines/arcs	BOTTOM
13	Zigzag angled profile	BOTTOM
14	Scalloped bottom	BOTTOM
15	Arc-to-Arc tangent wave	BOTTOM
16	Arc-to-Arc non-tangent	BOTTOM (fallback test)
17	Asymmetric scallop	BOTTOM
18	Offset-offset-back blend	Corner radii technique
19	Contact Arc Mode test	NONE
20	Contact Arc Mode test	GRAVITY
21	Contact Arc Mode test	PERPENDICULAR

Special Modes

99	Run ALL tests - Executes modes 0-21 sequentially with spacing
100	Multi-direction grid - Tests key shapes in all approach directions

Purpose: Converts a blade profile solid to kurves by extracting cut face edges.

Parameter	Description
i_profileBody	Body ID of the blade profile solid
w_centerX/Y/Z	Blade center position (for rotation origin)
w_normX/Y/Z	Blade normal vector
i_kurveOut	Kurve number for output

Processing Steps

1. Get slice body center for rotation origin
2. Rotate slice to XY plane using matrix transform
3. Find cut faces (planar with Z-aligned normal)
4. Convert faces to wire bodies (sld cnv ent 6 7)
5. Convert wire bodies to kurves
6. Union kurves via mosaic to get outer envelope

Returns

i_return	i_OK or i_ERROR
w_return	Output kurve number
w_return2	Number of kurves created

Purpose: Full blade test harness with hole detection and capping.

Parameter	Description
i_partBody	Part solid body to generate blades for

Internal Parameters (hardcoded in macro)

Variable	Value	Description
w_bladeThick	3mm	Blade material thickness
w_taperAngle	-2.0°	Taper angle on pocket faces
w_margin	0.5"	Overshoot margin
i_pocketMode	0	0=intersection, 1=bbox
i_holeMode	1	0=off, 1=detect and cap

Purpose: Detect holes on gravity-facing side and create caps.

Parameter	Description
i_bladeBody	Blade solid body
i_partBody	Part solid body (for hole detection)
i_thinAxis	0=thin in X, 1=thin in Y
w_capDepth	Cap thickness (e.g. 6mm)

Cap Mode (Internal)

i_capMode	Description
0	CLOSURE SHEET - Single flat slab seals entire bottom
1	INDIVIDUAL CAPS - Separate cap per detected hole

Configuration Switches (Internal)

Variable	Default	Description
w_minRadius	0.125"	Min radius to qualify as hole (vs fillet)
w_zFilterPct	0.5	Z height filter (50% from bottom)
w_zCapOffset	6mm	Total height of cap above part bottom
w_wallThick	3mm	Wall thickness for hollow caps
w_negativeExtrusion	3mm	Extension below part bottom
i_skipNonZAxis	0	0=process all axes, 1=skip X/Y holes

Purpose: Make a solid body watertight by capping holes.

Parameter	Description
i_body	Body ID to process
i_replaceInput	0=preserve original, 1=delete original after

Variants

Macro	Description
fxMakeWatertight	Caps ALL holes
fxMakeWatertightSkipGravity	Caps holes except gravity-facing side

Settings stored in i_VDM_FIXTURE_SETTINGS:

Slot	Variable	Description
313	i_debugMode	Debug mode flag (0/1)
326	w_bladeThickness	Blade material thickness