SIAddToCluster

Description

Adds components (such as points, edges, or polygons) to a cluster.

Note: This command uses output arguments. C# and some scripting languages (such as JScript, PerlScript and Python) don't support arguments passed by reference so you need to use the best workaround for your situation:

For scripting languages this command returns an ISIVTCollection which you can use to get the output arguments.

For C# you can use the XSIApplication.ExecuteCommand method to call this command. ExecuteCommand packs the output arguments into a C# System.Object containing an Array of the output arguments (see Calling Commands from C#).

Scripting Syntax

SIAddToCluster( InputObj, SubComp, OutputObj );

Parameters

Parameter Type Description
InputObj String Cluster object
SubComp String Components to add to the cluster
OutputObj Cluster Returns the updated cluster

Examples

VBScript Example

'This example shows how to add elements to a cluster

newscene

CreatePrim "Grid", "MeshSurface"

CreateCluster "grid.pnt[4,13,22,31,36-44,49,58,67,76]"

Translate , 0, 5, 0, siAbsolute, siParent, siObj, siY

'Cluster name can be changed.

SetValue "grid.polymsh.cls.Point.Name", "PlusShape"

'Add point to cluster.

'Cluster is first and points to add come after.

SIAddToCluster "grid.polymsh.cls.PlusShape", "grid.pnt[30,32,48,50]"

See Also

AddToCluster SIRemoveFromCluster