SIMatchSubComponent
 
 
 

SIMatchSubComponent

Introduced

v1.0

Description

Returns True if a cluster and a component are of the same type and belong to the same object.

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

SIMatchSubComponent( InputObj, SubComp, Result );

Parameters

Parameter Type Description
InputObj String Object to test.
SubComp String Component definition.
Result Boolean Returns True if a cluster and a component are of the same type and belong to the same object.

Examples

VBScript Example

CreatePrim "Cube", "MeshSurface"
SetSelFilter "Point"
SelectGeometryComponents "cube.pnt[6,LAST]"
CreateCluster
' This returns true because the cluster is a cluster of points, and the component is also a point
SIMatchSubComponent "cube.polymsh.cls.Point", "cube.pnt[0]", match

See Also

SIFilter