ExtractFromComponents

ExtractFromComponents

Description

Creates new objects (eg: curves, meshes) from components (eg: subcurves, polygons)

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

ExtractFromComponents( PresetObj, [ConnectionSet], [Name], [DeleteInputComponents], [ImmediateMode], [GenOpInputsDisposal], [OutputObjs] )

Parameters

Parameter	Type	Description
PresetObj	String	Extraction (Generator and Converter Operators) operator Default Value: If nothing is specified, the user will be prompted to pick a preset from the browser Possible Values: • ExtractEdgeLoopOp: ExtractEdgeLoopOp operator preset • ExtractPolygonsOp: ExtractPolygonsOp operator preset • ExtractSubCrvOp: ExtractSubCrvOp operator preset
ConnectionSet [in/out]	ConnectionSet	Components to extract. See Operator Presets for details on the connection set required for this operator. Default Value: Currently selected components are used. Warning: An error occurs if the connection set is invalid. Please verify the connection set required for this operator to avoid breaking your scripts.
Name	String	name to use for new objects
DeleteInputComponents	Boolean	True to automatically delete the input components after the operation. Default Value: False
ImmediateMode [in/out]	siOperationMode	Specifies whether or not the operator should be immediately frozen. Default Value: siUnspecified Possible Values: • siPersistentOperation: The operator will NOT be frozen after the duplicate (extrude) • siImmediateperation: The operator will be frozen after the duplicate (extrude)
GenOpInputsDisposal [in/out]	siGeneratorInputsDisposalMode	Specifies what to do with the input objects after the operation is performed. Default Value: siKeepGenOpInputs Possible Values: • siKeepGenOpInputs: The inputs will be kept • siHideGenOpInputs: The inputs will be hidden • siDeleteGenOpInputs: The inputs will be deleted
OutputObjs [out]	XSICollection	Returns the created primitives.

SOFTIMAGE|XSI v6.01

Return to Softimage XSI Index