Scripting: SIApplyDeformByCage

SIApplyDeformByCage

Introduced

v2.0

Description

Applies a deformation by cage.

Scripting Syntax

oReturn = SIApplyDeformByCage( [ConnectionSet], [Interactive], [ConstructionMode] );

Return Value

Returns an XSICollection that contains the CageAutoAssignOp and CageDeformOp operators created.

Parameters

Parameter	Type	Description
ConnectionSet	ConnectionSet	Specifies the objects connected to an operator. The first group of the ConnectionSet contains vertex based objects. The second group of the ConnectionSet contains geometric objects. Default Value: Currently selected objects are used as the main group. Warning: An error occurs if the connection set is invalid. Please verify the connection set required for this operator to avoid breaking your scripts.
Interactive	Boolean	True to prompt user to pick objects. Default Value: False
ConstructionMode	siConstructionMode	Specifies in which construction mode to apply the operator. Default Value: Use the current construction mode

Examples

VBScript Example

'This example creates a cage deformer (cube) over a sphere and a torus.
'Then, the cube is deformed by a taper, and the deformation is reflected
'on the sphere and the torus because of the DeformByCage operator.
NewScene
dim obj, obj1, cage
set obj = CreatePrim( "Sphere", "MeshSurface" )
set obj1 = CreatePrim( "Torus", "MeshSurface" )
set cage = CreatePrim( "Cube", "MeshSurface" )
'Apply the DeformByCage, with no picking session
SIApplyDeformByCage obj & "," & obj1 & ";" & cage, False
'If we deform the cage, it will deform obj and obj1:
ApplyOp "Taper", cage, 3, siPersistentOperation