Interface: SnapConnectionMeta
Advanced metadata for controlling connection point behavior.
The SnapConnectionMeta interface provides detailed rules and parameters that control how a connection point behaves, when it's visible or enabled, and how it interacts with other products and connection points.
These advanced settings enable sophisticated connection rules that create realistic and functional product relationships in modular configurations.
Properties
collideWithId?
optionalcollideWithId:string
ID of the collision mesh that interacts with this connection.
This property identifies which collision mesh on the product should be checked for overlap when products are connected at this snap point. This prevents invalid connections that would cause products to intersect.
Collision checking ensures physically realistic arrangements and prevents impossible product configurations.
enableByRuleId?
optionalenableByRuleId:string
ID of the rule that determines when this connection is enabled.
This property references a rule that controls whether this connection point is active and available for use. The connection will only be enabled when the referenced rule evaluates to true.
Conditional enabling allows connections to appear or disappear based on the product's current configuration or state.
enableByRuleTriggerSnaps?
optionalenableByRuleTriggerSnaps:string[]
List of snap codes that trigger the enable rule.
This property lists the snap codes that, when present on the product, trigger the evaluation of the enableByRuleId rule. This creates a dependency between snap points, where one connection affects others.
This creates cascading connection rules where one connection's presence can enable or disable other connection options.
hideByRuleId?
optionalhideByRuleId:string
ID of the rule that determines when this connection is hidden.
This property references a rule that controls whether this connection point is visible in the interface. The connection will be hidden when the referenced rule evaluates to true.
Conditional hiding allows for cleaner interfaces by showing only the most relevant connection options in each configuration state.
hideByRuleTriggerSnaps?
optionalhideByRuleTriggerSnaps:string[]
List of snap codes that trigger the hide rule.
This property lists the snap codes that, when present on the product, trigger the evaluation of the hideByRuleId rule. This creates visual dependencies between connection points.
This allows for intelligent hiding of connection options that would be redundant or invalid given the current connections.
weldedSnapCode?
optionalweldedSnapCode:string
Snap code to use for welding calculations.
This property specifies which snap code should be used for welding distance calculations when this connection is welded to another product. This allows for more precise control over product alignment.
A custom welding snap code can override the default behavior to handle special cases for particular product combinations.
weldingDistance?
optionalweldingDistance:number
Distance between products when welded at this connection.
This property specifies the precise distance (typically in scene units) between products connected at this snap point when welding is active. Proper welding distances ensure products align correctly without gaps or overlaps.
This is particularly important for products that must maintain exact spacing when connected, like modular furniture or building components.