SIApplyFlexEnv

Introduced

v1.0

Categories

operator deformation

Description

Applies a flexible envelope.

Scripting Syntax

oReturn = SIApplyFlexEnv( [ConnectionSet], [Interactive], [AssignNewDeformers], [ConstructionMode] );

Return Value

Returns an XSICollection that contains the created Envelope operators (EnvelopeAutoAssignOp and EnvelopeOp).

Parameters

Parameter Type Description
ConnectionSet ConnectionSet Specifies the objects connected to an operator. See OpPreset for details on the connection set required for this operator.

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

AssignNewDeformers Boolean True to automatically assign deformer objects when they are added to existing Envelopes.

Default Value: False

ConstructionMode siConstructionMode Specifies in which construction mode to apply the envelope.

Default Value: Use the current construction mode

Examples

VBScript Example

' Build a simple Envelope with no picking required.
CreatePrim "Sphere", "MeshSurface"
Create2DSkeleton -0.019, 3.703, 0.000, -0.795, 0.000, 0.000, 0.000, 0.000, 1.000, 1
AppendBone , 0.000, -3.509, 0.000
SelectObj "sphere", , True
SIApplyFlexEnv "sphere;bone,bone1,eff", False, False

See Also

ApplyFlexEnv