Skip to main content

Interface: SnapConnection

Represents a connection between two products in a modular scene.

The SnapConnection interface defines a connection between two products through their respective snap points. It establishes the relationship type, identifies the connection points, and provides additional context about the connection's nature and constraints.

Connections are the foundation of modular product assembly, determining how products relate to each other spatially and functionally. They control product positioning, hierarchical relationships, and interaction behaviors.

Extends​

Indexable​

[key: string]: unknown

Additional custom properties for connection extensions.

This index signature allows for custom properties to be added to connection objects for specific product needs or extension functionality. This enables the connection system to be extended with additional metadata without changing the core interface.

Custom properties might include connection strength values, specialized alignment parameters, or application-specific flags.

Properties​

hasAutoInserted?​

optional hasAutoInserted: string | boolean

Indicates this connection includes an auto-inserted product.

When true or set to an instance ID string, this connection involves an automatically inserted product. This helps track connections that were made through automatic insertion rules.

This property helps maintain the integrity of auto-inserted product relationships during scene modifications.

Inherited from​

SnapConnectionPartial.hasAutoInserted

isAutoInserted?​

optional isAutoInserted: string | boolean

Indicates this product was automatically inserted.

When true or set to an instance ID string, this product was automatically inserted by a rule rather than explicitly placed by the user. This typically happens when system rules determine that an adapter or connector is needed between products.

Auto-inserted products may have different UI treatment or special behavior when the scene is modified.

Inherited from​

SnapConnectionPartial.isAutoInserted

isChild?​

optional isChild: boolean

Indicates a parent-child relationship where the source is the parent.

When true, the current product is considered the parent of the connected product. This creates a hierarchical relationship where the child product is dependent on this product. When this product is moved, its children move with it.

This is the inverse of the isParent property, viewing the same relationship from the opposite direction.

Inherited from​

SnapConnectionPartial.isChild

isConnector?​

optional isConnector: boolean

Indicates this product serves as a connector.

When true, the current product acts as a connector between the target product and some other product. Connectors join two or more products that would not otherwise be directly compatible.

Connector products have special behavior in the modular system, such as maintaining connections on both sides when moved.

Inherited from​

SnapConnectionPartial.isConnector

isParent?​

optional isParent: boolean

Indicates a parent-child relationship where the target is the parent.

When true, the connected product is considered the parent of the current product. This creates a hierarchical relationship where the child product is dependent on the parent. When a parent is moved, its children move with it.

Parent-child relationships are fundamental to building complex structures with proper dependency chains.

Inherited from​

SnapConnectionPartial.isParent

isSibling?​

optional isSibling: boolean

Indicates a sibling relationship between products.

When true, the connected products are considered siblings at the same level of the hierarchy. Siblings have no dependency relationship and can be moved independently of each other.

Sibling relationships are used for products that connect laterally or adjacently without a structural dependency.

Inherited from​

SnapConnectionPartial.isSibling

productUId​

productUId: string

Instance ID of the target product.

This property identifies which specific product instance is on the target end of this connection. This unique ID ensures the connection links to the correct product instance when multiple instances of the same product might exist on the scene.

Combined with the snap IDs, this creates a fully specified connection between two specific points on two specific products.

Overrides​

SnapConnectionPartial.productUId

snapIdFrom​

snapIdFrom: string

ID of the snap point on the source product.

This property identifies which snap point on the current product is used in this connection. This is the "from" side of the connection, typically on the product being connected from.

When combined with snapIdTo, this creates a complete connection path between two specific points on different products.

Overrides​

SnapConnectionPartial.snapIdFrom

snapIdTo​

snapIdTo: string

ID of the snap point on the target product.

This property identifies which snap point on the target product is used in this connection. This is the "to" side of the connection, typically on the product being connected to.

Each snap point can typically participate in only one connection, ensuring products assemble in physically realistic ways.

Overrides​

SnapConnectionPartial.snapIdTo

withConnector?​

optional withConnector: boolean

Indicates the target product serves as a connector.

When true, the target product acts as a connector between the current product and some other product. This flag helps track connector relationships from the perspective of products connected through a connector.

This property helps maintain proper relationships when products are connected indirectly through intermediate connector products.

Inherited from​

SnapConnectionPartial.withConnector