API and Customization

New Features

  • First release of HyperMesh Python API:
    • HyperMesh Python API allows you to automate your workflows via Python scripts.
    • Supports creation of custom GUI via the hwx.gui module.
    • Compatible with Extensions.
    • Known Limitations:
      • All HyperMesh functions are not yet supported. Missing functionalities will be gradually added in the coming releases.
      • Performance of creating collections in large models will be enhanced in the future.
      • The model instance methods do not return a Python error when failing. Currently, the success/failure is captured via the returned status object. This behavior will be changed in the future, so a failed function returns a Python error.
      • Nested entity data names are not yet accessible in Python.
      • When executing a Python script via File > Load > Python Script, Python errors are suppressed.
    • Known Issues:
      • Supplying entity name when creating a new entity via class constructor can result in an 'invalid value' error in case of a name conflict.
      • Iterating over a collection and printing each objects may lead to application error.
      • Invoking the interactive entity selection (CreateCollectionByInteractiveSelection) by supplying a model from a non-active window may lead to application error.
      • The values of enums CONTAINMENT_FULL and CONTAINMENT_PARTIAL are mapped the wrong way.
      • Incorrect size reported for collections of entities that use separate classes in Python to represent individual configurations.
    • More information can be found in the Python API Reference Guide section of the API, Reference Guides.
  • New Developer ribbon:
    • New ribbon has been added to host the tools planned for future releases related to automation and customization.
    • The ribbon is hidden by default and can be activated via View > Ribbons.
  • Task Manager:
    • New platform for process automation via Python API and XML defined GUI.
    • Allows you to package custom Python scripts into tasks and organize them into a process that can be easily followed.
    • Supports the HyperMesh client. Other clients will be supported in the future.
  • More information on API changes can be found in the latest API Programmer's Guide section of the HyperMesh Reference Guide.