AddProp

Introduced

1.0

Description

Adds properties to objects.

Notice that UV cluster properties and vertex color properties can only be added to clusters which are always complete, see Geometry.AddCluster method.

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

AddProp( PresetObj, [InputObjs], [Propagation], [PropertyName], [Value] )

Parameters

Parameter

Type

Description

PresetObj

String or a preset object (see SIGetPreset)

One of the Property Presets

InputObjs

String

List of objects.

Default Value: Currently selected objects

Propagation

siPropagationType

Propagation type for property

Default Value: siDefaultPropagation (node)

PropertyName [in/out]

String

Name of property

Value [out]

XSICollection

Returns the new properties in an XSICollection.

Note: For backwards compatibility, ClassName returns "Object" when you test this collection, but if you test it with XSICollection.Type, it returns "XSICollection".

Tip: Each member of the returned collection is a Property object.

See Also

SIAddProp

SceneItem.AddProperty

Property

XSICollection

Examples

• See AddProp.1.vbs

• See AddProp.2.js



Autodesk Softimage 2011