GetPrimLattice

Description

Creates a lattice 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

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

Parameters

Parameter

Type

Description

PresetObj

String

The attice preset (one of the Miscellaneous Primitives).

Default Value: "Lattice"

Possible Values:

• Lattice: The lattice primitive preset

InputObjs

String

List of objects to which the lattice is applied.

Name

String

Name of the lattice.

Parent

String

Parent object for the lattice.

PrimObj [out]

Primitive

Returns the lattice primitive.

Return Value

Returns the lattice (an X3DObject object).

Examples

VBScript Example

dim list
set list = GetValue( "SelectionList" )
GetPrimLattice , list

See Also

GetPrim

Autodesk Softimage v7.5