Skip to content

hfVisualizer Remote Control Overview

hfVisualizer Commands

This section is the main reference for controlling hfVisualizer from scripts, terminals, or automation tools. If you are new to remote control, start with list, status, open, save, and the window-state commands (focus, maximize, minimize), then move to selection or preprocessing commands.

Command Groups

  • Remote-only helpers: list, target, status, ping, focus, maximize, minimize, script, script-save
  • View: view
  • Window and file: open, save, import, export, write-scene, write-program-shot, quit
  • Display and selection: select, visibility, representation, transparency, camera, view
  • Preprocessing definitions and model history: undo, redo, coordinatesystem, coordinatesystem-activate, coordinatesystem-rename, coordinatesystem-delete, construction, construction-rename, construction-delete, function, function-rename, function-delete, material, material-rename, material-delete, load, load-rename, load-delete, sensor, sensor-rename, sensor-delete, section, section-rename, section-delete, step, step-rename, step-delete, history, history-rename, history-delete, nset, nset-rename, nset-delete, elset, elset-rename, elset-delete, surface
  • Analysis and postprocessing: check-model, run-analysis, unlock-model, step-delete-from, post-*

Modeling Notes

  • Definition commands use the same canonical tail format stored by script-save.
  • The coordinatesystem, construction, function, material, load, sensor, section, step, history, nset, and elset families now cover create/update, rename, and delete flows that match the corresponding ModelTree actions. coordinatesystem-activate also mirrors the TreeMenu checked/unchecked path for User coordinate systems in a render view: use a name to activate it, or none to clear the active one.
  • Most definition commands still stay locked in postprocessing mode, but a small set of GUI-matched exception paths can still modify the current HDB there: environment-info set, nset, elset, step Post ..., step-delete-from ..., and history PostHistory ....
  • Rename and delete commands for step, history, nset, and elset remain preprocessing-only so remote execution stays non-interactive and avoids postprocessing confirmation flows.
  • undo and redo replay the current preprocessing model-history stack, so they depend on the active session state rather than declarative definition text.
  • All definition commands accept either --content <text> or --content-file <file>.

Result Output

  • Successful commands do not all print the same amount of result JSON.
  • Commands that always print result JSON include list, target, status, undo, redo, environment-*, grid-spacing, camera, and view.
  • Query-style postprocessing commands such as post-step get, post-frame get, post-scalar get, post-vector get, post-contour ... get, and post-scale ... get also print result JSON.
  • Most file actions, create/update/delete commands, and simple toggle commands return success or failure without extra JSON output.
  • Internal fields such as scriptTail are used for Remote Control History and script-save, and are hidden from normal result JSON output.