Interface: ProductElement
Represents a product instance placed on the modular scene.
The ProductElement interface defines the core information about a product that has been added to a modular configuration. It includes identification, positioning, connections, and placement type details that determine how the product behaves in the scene.
Each product element is a unique instance of a product, with its own position, connections, and configuration. Multiple instances of the same product type can exist on the scene with different arrangements.
Properties
configurationCode?
optionalconfigurationCode:string
Configuration code for this specific product instance.
This code encapsulates all the option selections and customizations applied to this specific product instance. It's a serialized representation of the product's current configuration state.
Configuration codes are used to restore saved states, generate SKUs, and track specific product variants.
connections?
optionalconnections:SnapConnection[]
List of connections to other products in the scene.
This property defines how this product connects to other products in the modular scene, specifying connection points, relationship types (parent/child/sibling), and connected product IDs.
Connections determine how products relate to each other spatially and functionally, and how they behave when moved or modified.
freeMove?
optionalfreeMove:boolean
Indicates whether this product can move freely in the scene.
When true, this product is not constrained by connection points
and can be positioned anywhere in the scene. Free-moving products
don't snap to other products and maintain their exact position.
Free-moving products are useful for accessories, decorative items, or standalone pieces that don't need structural connections.
insertedAt?
optionalinsertedAt:number
Timestamp when this product was added to the scene.
This property stores the time (as a numeric timestamp) when this product was placed on the scene. This can be used for ordering, undoing recent changes, or tracking the assembly sequence.
The insertion order can be important for understanding the construction logic of complex modular arrangements.
placementType?
optionalplacementType:ModularPlacementType
Defines how this product was placed in the scene.
This property indicates the method used to add this product to the scene, such as direct placement, snapping, or insertion between existing products. The placement type affects how the product behaves when scene changes occur.
Different placement types may have different visual indicators or interaction behaviors in the configurator interface.
position?
3D position of the product in the scene.
This property defines where the product is located in 3D space, specified as X, Y, and Z coordinates. For free-moving products, this position can be directly set. For connected products, the position may be determined by their connections.
A null value indicates the product uses automatic positioning based on its connections to other products.
productId
productId:
string
Unique identifier for the product type.
This ID identifies the type of product this element represents (e.g., "desk", "chair", "storage-unit"). Multiple elements on the scene can share the same productId if they are instances of the same product type.
The productId is used to fetch product metadata, 3D assets, and available configuration options.
rotation?
3D rotation of the product in the scene.
This property defines how the product is rotated in 3D space, specified as rotation angles around the X, Y, and Z axes. Proper rotation ensures products face the right direction and align correctly with other components.
A null value indicates the product uses automatic rotation based on its connections to other products.