FxOperator

Object Hierarchy

Inheritance

SIObject

ProjectItem

FxOperator

Introduced

v3.0

Description

The FxOperator object represents an operator located in a FxTree. The FxOperator generally contains several input connections and one output connection. There are exceptions: for example the "File Input" FxOperator does not have any input and the "File Output" FxOperator does not have any output. Each connection has an index, which is used to identify the connection in many of the FxOperator mehods. To find out how many connections an FXOperator has, use the FxOperator.ConnectionCount property. This property also indicates that valid indexes for connection identification are ranged between 0 and (FxOperator.ConnectionCount - 1).

Methods

AddCustomOp AddICEAttribute AddScriptedOp AddScriptedOpFromFile
AnimatedParameters2 BelongsTo operator Connect Disconnect
EvaluateAt GetConnectedOperator GetConnectionFlag GetConnectionName
GetICEAttributeFromName IsA IsAnimated2 IsClassOf operator
IsConnected IsConnectionFlagSupported IsEqualTo operator IsInputConnection
IsKindOf IsLocked operator IsMaskConnection IsSelected operator
LockOwners RemoveICEAttribute Render SetAsSelected operator
SetCapabilityFlag operator SetConnectionFlag SetLock TaggedParameters
UnSetLock      
       

Properties

Application BranchFlag operator Capabilities operator Categories
ConnectionCount EffectID EvaluationID Families operator
FullName operator Help HierarchicalEvaluationID ICEAttributes
LockLevel operator LockMasters operator LockType operator Model
Name operator NestedObjects ObjectID Origin
OriginPath Owners PPGLayout operator Parameters operator
Parent Parent3DObject PositionX PositionY
Selected operator Tree Type operator  
       

Examples

VBScript Example

'Create an FxTree with two FxOperator objects and list useful information
'about each FxOperator
set oRoot = ActiveProject.ActiveScene.Root
set oTree = oRoot.AddFxTree
set oSrc = oTree.AddImageOperator("Noise")
set oDest = oTree.AddImageOperator("EdgeDetect")
oSrc.Connect oDest, 0
LogMessage "====="
for each oFxOp in oTree.FxOperators
	LogMessage "Name : " & oFxOp.Name
	LogMessage "Type : " & oFxOp.Type
	LogMessage "Tree Name : " & oFxOp.Tree.Fullname
	LogMessage "Pos : " & oFxOp.PositionX & " , " & oFxOp.PositionY
	Count = oFxOp.ConnectionCount
	LogMessage "Cnx Count : " & Count
	LogMessage "----"
	for Cnx = 0 to Count - 1
		LogMessage "Cnx Name : " & oFxOp.GetConnectionName(Cnx)
		LogMessage "Cnx Connected? : " & oFxOp.IsConnected(Cnx)
		LogMessage "Cnx Mask? : " & oFxOp.IsMaskConnection(Cnx)
		LogMessage "Cnx Input? : " & oFxOp.IsInputConnection(Cnx)
		if oFxOp.IsConnected(Cnx) then
			LogMessage "Cnx Connection : " & oFxOp.GetConnectedOperator(Cnx).Name
		end if
		LogMessage "Cnx Select flag supported? : " & oFxOp.IsConnectionFlagSupported(Cnx, 1)
		if oFxOp.IsConnectionFlagSupported(Cnx, 1) then
			LogMessage "Cnx Select flag? : " & oFxOp.GetConnectionFlag(Cnx, 1)
		end if
		LogMessage "Cnx Invert flag supported? : " & oFxOp.IsConnectionFlagSupported(Cnx, 2)
		if oFxOp.IsConnectionFlagSupported(Cnx, 2) then
			LogMessage "Cnx Select flag? : " & oFxOp.GetConnectionFlag(Cnx, 2)
		end if
		LogMessage "----"
	next
	LogMessage "====="
next

See Also

FxTree