Developer Docs
Developer Docs
Breadcrumbs

Modifiers | Modules

image-20260318-160524.png

Modules

Modules are reusable building blocks that represent configurable products or components within an assembly. They allow complex setups to be structured into smaller, manageable parts that can be defined, configured, positioned, and connected.

A module is first defined (via descriptors and configuration), then added to an assembly, where it can be controlled through parameters and connected to other modules using snap points.

This system enables:

  • Parametric assemblies with multiple interchangeable components

  • Structured product logic through reusable modules

  • Flexible positioning and connections via snap points

  • Separation between visualization and export logic

Modules are typically used to build scalable configurator setups where multiple components interact within a single coordinated assembly.

Modifier

Description

Input

Module Assembly

Master assembly node used to group and manage modules. It acts as the central node to which modules are linked via the Module Assembly Parameter.
image-20260318-160702.png

Inputs

  • Module Assembly: Module instance to assemble.

  • Snap Color: Visual color of snap points.

  • Snap Opacity: Opacity of snap point visualization.

  • Snap Size: Size of snap point indicators and snapping threshold

  • Visualize: Enables visualization of the module in the scene.

  • Export: Includes the module in export outputs.

Outputs

  • Module Assembly: Assembled module instance.

Module Assembly Parameter

Links a module to an assembly and outputs a parameter containing all modules within that assembly.
image-20260318-160721.png

Inputs

  • Module: Module to be added to the assembly.

Outputs

  • Module Assembly: Resulting module assembly reference.

Module Configuration

Defines parameter values and positioning for a module instance within the startup scene.
image-20260318-160736.png

Inputs

  • X / Y / Z: Position or transformation values.

  • Param ID: Identifier of the startup parameter to configure.

  • Value: Value assigned to the parameter.

Outputs

  • Config: Configuration data for the module.

Module Definition

Treats an existing product as a module within an assembly, based on product descriptors.
image-20260318-160750.png

Inputs

  • View Descriptor: Descriptor used for visualization.

  • Export Descriptor: Descriptor used for export.

  • Preview Image: Visual preview of the module.

  • Allow Drag: Enables drag interaction in the UI.

  • Startup Config: Module configuration applied at initialization.

Outputs

  • Module: Defined module ready for use in assemblies.

Module Snap Points

Defines connection points used to attach modules together.
image-20260318-160804.png

Inputs

  • Orientation: Direction of the snap point (e.g. front, back).

  • Enabled: Enables or disables the snap point.

  • X / Y / Z: Position of the snap point.