AddImageClipFxOp

Introduced

v3.0

Categories

rendering

Description

Adds a new unconnected image clip FxOperator to the FxTree object.

Scripting Syntax

oReturn = AddImageClipFxOp( [FxTree], [ImageClip] );

Return Value

FxOperator

Parameters

Parameter Type Description
FxTree String or FxTree Object pointer or Object name for FxTree.

Default Value: Current selection.

Note: If the current selection is not a valid FxTree, an error occurs.

ImageClip String or ImageClip Object pointer or Object name for image clip associated with the new operator.

Default Value: Current selection.

Note: If the current selection is not a valid image clip, an error occurs.

Examples

VBScript Example

' This example creates an FxTree, and sets an image clip as the new operator.
set oTree = CreateFxTree()
' Get the projects path for the current system
sPath = InstallationPath( siProjectPath )
set oClip = CreateImageClip( sPath & "\Pictures\noIcon.pic", "NewClip" )
' Add the new image clip operator and print out some info
set oOperator = AddImageClipFxOp( oTree, oClip )
Application.LogMessage "New operator is called '" _
                                & oOperator.Name & "' operator." 
' Output of above script is:
'INFO : "New operator is called 'FromClip_NewClip' operator."