AddImageOperator (FxTree)

Description

Adds a new unconnected image FxOperator to the FxTree object. The method uses the EffectID of an FxOperator, which is a unique string that identifies each kind of FxOperator, and can be obtained with FxOperator.EffectID. The EffectID can be the type of FxOperator you want to create, it can also be a path to a valid preset file. Look under the Fx Operator Selector in XSI if you want a list of supported types of FxOperator.

Scripting Syntax

FxTree.AddImageOperator( EffectID )

C# Syntax

FxOperator FxTree.AddImageOperator( Object in_varEffID );

Parameters

Parameter

Type

Description

EffectID

String or Preset

Either a preset or a string that identifies the fx operator to create (e.g. "HighPassFilter")

Return Value

FxOperator

Examples

VBScript Example

'VBScript example
set oRoot = ActiveProject.ActiveScene.Root
set oTree = oRoot.AddFxTree
set oOp = oTree.AddImageOperator("EdgeDetect")


SOFTIMAGE|XSI v6.01     

Return to Softimage XSI Index