CimSuiteAssy::Connect

Description

This function allows you to connect components to each other in an assembly document.

Syntax

Status = ConnectiEntity1, iEntity2iConnectMode, [iAlignMode], [iFlipMode], [iAngle], [iDist], [iDelta], [iRotation], [oGetCreatedEntity] );

Input: (IEntity/Object) iEntity1

Entity to which to connect.

Input: (IEntity/Object) iEntity2

Entity to be connected.

Input: (suConnectMode) iConnectMode

Connect mode.

Input: (suConnectAlignmentMode) [iAlignMode]

Optional. Align mode. By default suConnectNoAlignmentMode.

Input: (suConnectFlipMode) [iFlipMode]

Optional. Flip mode. By default suConnectNoFlipMode.

Input: (Double) [iAngle]

Optional. Angle. Used for some Assembly connection types. For more details see the Assembly Online Help.

Input: (Double) [iDist]

Optional. Distance. Used for some Assembly connection types. For more details see the Assembly Online Help.

Input: (Variant) [iDelta]

Optional. Delta defines  entity translation relative to each other. 3-element array: shift by X axis, shift by Y-axis, shift by Z-axis. Used for some Assembly connection types. For more details see the Assembly Online Help.

Input: (Variant) [iRotation]

Optional. Rotation defines the rotation of the entity's UCS axes relative to each other. 3-element array: rotation by X-axis, rotation by Y-axis, rotation by Z-axis. Used for some Assembly connection types. For more details see the Assembly Online Help.

Input: ( IEntity ) oGetCreatedEntity Optional. The procedure of created entity. May be used to make queries on entity that created by procedure.

Return: (Boolean) Status

TRUE if add procedure successful.

Note

All of above arguments that defines connection  exclude Entity1, Entity2, ConnectModeaffects on second connected entity Entity2.