Skip to main content

Interface: SnapMeta

Information about a specific connection point on a product.

The SnapMeta interface provides detailed information about a connection point (snap point) on a modular product. It includes identification, state, and connection rules that determine how products can connect at this point.

Snap points are the foundation of modular product assembly, enabling precise and valid connections between components. They control which products can connect where, and how they align and position when connected.

Properties​

code​

code: string

Functional code that categorizes this connection type.

This code identifies what type of connection this snap point represents (e.g., "top", "bottom", "left", "right"). The code determines compatibility with other connection points and how connected products align.

Snap codes are used to enforce connection rules - only compatible codes can connect to each other (e.g., "top" can connect to "bottom").

connectionMeta?​

optional connectionMeta: SnapConnectionMeta

Additional metadata about this connection's behavior and rules.

This property contains debugging and technical information about how this connection behaves, including welding distances, rule IDs that affect enablement, and the snap points that trigger visibility or enablement changes.

This metadata provides insight into why a snap point is in its current state and what rules or conditions are affecting it.

id​

id: string

Unique identifier for this connection point.

This ID uniquely identifies this specific connection point within the product. Each snap point has a unique ID that is used to target operations and track connections to this specific point.

isEnabled​

isEnabled: boolean

Indicates whether this connection point is currently enabled by rules.

When true, this connection point is active based on the product's rules and can be used to connect products. This represents a logical enablement based on the product's configuration and connection rules.

For example, if two sofas are connected, a snap between them might be enabled to place accessories like pillows or connector pieces.

isMeshEnabled​

isMeshEnabled: boolean

Indicates whether the visual representation of this snap is visible.

When false, even if the snap is logically enabled, its visual indicator is hidden in the 3D scene due to rule-based visibility constraints. This controls whether users can see the snap point in the interface.

This separation between logical enablement and visual representation allows snaps to be functionally available but visually hidden when needed.

isWelding​

isWelding: boolean

Indicates whether this connection point uses welding.

When true, this connection point supports welding, which means it can create seamless connections with other products. A welded snap point is considered used and becomes unavailable for other products.

Welding is used to ensure products are properly aligned with each other without gaps or overlaps.

weldedWithId?​

optional weldedWithId: Nullable<string>

ID of the snap point this connection is welded with, if any.

If this connection point is currently welded to another product's snap point, this property contains the ID of that connected snap point. A null value indicates this connection point is not currently welded.

This tracks which specific product or component is using this snap point when it's involved in a welded connection.