UpdateConnectOnOp
 
 
 

UpdateConnectOnOp

Introduced

v1.0

Description

Updates the connections of an operator for a specific group given a list of objects. The group of ports to update is specified with GroupIndex and GroupInstanceIndex. The mapping of these objects on the operator group ports is governed by the flag AlreadyRefined. If this flag is true, the objects will be connected on the ports directly; since this is a one-to-one mapping, the number of objects should match the number of ports for this group. If the flag is false, the command will automatically refine the objects as required by the operator.

The list may contain empty objects: by default these empty objects are skipped during the update, therefore the current connections corresponding to the position of the object in the list are left untouched. This behavior can be changed by setting the flag ForceDisconnection to true. This flag instructs the command to disconnect the current connected object only if the corresponding port is set as optional.

Scripting Syntax

UpdateConnectOnOp( Operator, GroupIndex, GroupInstanceIndex, InputObjs, AlreadyRefined, ForceDisconnect );

Parameters

Parameter Type Description
Operator Object The operator
GroupIndex Integer Id of the type of the group

Default Value: 0

GroupInstanceIndex Integer The id of the group instance

Default Value: 0

InputObjs List List of objects to connect
AlreadyRefined Boolean Specifies whether the list of objects is already refined or not
ForceDisconnect Boolean Specifies the behavior of the command when it encounters an empty connection. If it's TRUE and the port corresponding to the empty elem ref is optional, that port will be disconnected, in all other cases it won't do anything.