HAPI Script Overview Index
HAPI Script Overview Index
Purpose
This index summarises the Dynamo scripts described in the HAPI User Manual and links each script to a dedicated reverse-engineering overview note.
These script notes are intended to help future agents understand the objective, user-facing inputs, expected outputs, and manual-defined workflow of each Dynamo script before inspecting .dyn graphs.
Important Boundary
These notes are manual-facing and workflow-facing. They intentionally avoid PythonNet3 implementation architecture such as SurveyRecord, FeatureSeed, or internal builder functions. Those belong to a later coding and migration layer.
Script Families
| Family | Role | Notes |
|---|---|---|
| Series A - Data Exchange | Import, export, traverse plotting, and legacy drawing migration | Series_A_Data_Exchange |
| Series B - Drafting Aids | Post-import drafting refinement and visual cleanup | Series_B_Drafting_Aids |
| Series C - Plan Production | Layout-level plan production helpers | Series_C_Plan_Production |
| Series E - ECM Modelling | Existing Conditions Modelling object generation | Series_E_ECM_Modelling |
Series A - Data Exchange
| Script | Summary |
|---|---|
| A1a_Plot_Survey_Data_From_Point_Data_File | Plots survey data from point data files as styled Civil 3D objects. |
| A1b_Plot_Survey_Data_From_Drawing_Selection | Converts existing drawing entities or previously plotted data into styled Civil 3D objects. |
| A2_Plot_Traverse_Diagram_From_File | Imports traverse data from a PT2 file and plots a traverse diagram. |
| A3_Export_Survey_Data_To_Point_Data_File | Exports survey data from the current drawing to point data files. |
| A4_Migrate_Survey_Data_From_Legacy_Drawing | Extracts survey data from a legacy DGN-derived DWG attached as an XREF. |
Series B - Drafting Aids
| Script | Summary |
|---|---|
| B1_Spot_Text_Display_Manager | Manages COGO Point annotation visibility and display style. |
| B2_LIC_Basemap | Downloads, processes, and attaches LIC basemap tiles. |
| B3_Topographic_Pattern | Generates slope patterns and stair tread patterns from reference geometry. |
Series C - Plan Production
| Script | Summary |
|---|---|
| C1_Grid_Reference | Generates coordinate grid references for selected viewports. |
| C2_Drawing_Legends | Places drawing legends in the title block. |
Series E - ECM Modelling
| Script | Summary |
|---|---|
| E1_Object_Catalogue | Opens the Style Code Dictionary / Object Catalogue. |
| E2_Generate_Standalone_ECM_Objects | Generates standalone ECM objects from 2D survey symbols and labels. |
| E3_Generate_Linear_ECM_Objects | Places linear ECM objects along Feature Lines or 3D Polylines. |
| E4_Generate_Stair_Treads_ECM_Objects | Generates concrete stairway ECM objects from stairway reference lines. |
Related Workflow Notes
- Typical_Plan_Drafting_Workflow
- Typical_ECM_Modelling_Workflow
- Point_Data_File_Formats
- ECM_Ready_CSV_File_Format
Feature Information Policy
Do not recreate the full Feature Code Reference Table from the manual in Markdown. The single source of truth for all feature-related information is FeatureCatalogue.json, documented through Feature_Catalogue.
