GetPrimVolumeDeform

Description

Creates a volume deformer and applies it to the given objects.

Note: This command uses output arguments. C# and some scripting languages (such as JScript, PerlScript and Python) don't support arguments passed by reference. Normally you can get the output arguments via either XSIApplication.ExecuteCommand method (C#) or the ISIVTCollection (scripting languages), but this command already returns a value.

The only available workaround in this case is to create a VBScript custom command which returns both the output arguments and the return value in one array. For details, see What Happens when the Function Already Returns a Value?.

Scripting Syntax

GetPrimVolumeDeform( PresetObj, [InputObjs], [Name], [Parent], PrimObj )

Parameters

Parameter

Type

Description

PresetObj

String or a preset object (see SIGetPreset)

The SphereVolume preset (one of the Control Object Primitives)

Default Value: "SphereVolume"

Possible Values:

SphereVolume: Sphere Volume preset

InputObjs

String

List of objects to which the deformer is applied.

Name

String

Name of the deformer.

Parent

String

Parent object for the deformer.

PrimObj [out]

Primitive

Returns the volume deform primitive.

Return Value

Returns the volume deform X3DObject

Examples

VBScript Example

dim list, prim
set list = GetValue( "SelectionList" )
GetPrimVolumeDeform "SphereVolume", list, "Name", , prim

See Also

GetPrim



Autodesk Softimage v7.5