ZComp

Description

Z Composite

 

See also the matching preset reference entry.

Source and Implementation

Type: Fx operators

Source File: spdl\ZComp_IllFx.spdl

Parameters

Scriptname

Parameter Name
(UI Label)

Data
Type

Description

Range

UI Range

Name

Name

String

[Input Parameter]

Name

EffectName

EffectName

String

[Input Parameter]

EffectName

Active

Active

Bool

[Input Parameter]

Active

OutputSel

OutputSel

Integer

[Input Parameter]

OutputSel

Cnx1Select

Cnx1Select

Bool

[Input Parameter]

Cnx1Select

Cnx2Select

Cnx2Select

Bool

[Input Parameter]

Cnx2Select

Cnx3Select

Cnx3Select

Bool

[Input Parameter]

Cnx3Select

Cnx4Select

Cnx4Select

Bool

[Input Parameter]

Cnx4Select

Cnx5Select

Cnx5Select

Bool

[Input Parameter]

Cnx5Select

Cnx6Select

Cnx6Select

Bool

[Input Parameter]

Cnx6Select

Cnx7Select

Cnx7Select

Bool

[Input Parameter]

Cnx7Select

Cnx8Select

Cnx8Select

Bool

[Input Parameter]

Cnx8Select

Cnx1Invert

Cnx1Invert

Bool

[Input Parameter]

Cnx1Invert

Cnx2Invert

Cnx2Invert

Bool

[Input Parameter]

Cnx2Invert

Cnx3Invert

Cnx3Invert

Bool

[Input Parameter]

Cnx3Invert

Cnx4Invert

Cnx4Invert

Bool

[Input Parameter]

Cnx4Invert

Cnx5Invert

Cnx5Invert

Bool

[Input Parameter]

Cnx5Invert

Cnx6Invert

Cnx6Invert

Bool

[Input Parameter]

Cnx6Invert

Cnx7Invert

Cnx7Invert

Bool

[Input Parameter]

Cnx7Invert

Cnx8Invert

Cnx8Invert

Bool

[Input Parameter]

Cnx8Invert

ClipStart

Start

Integer

[Input Parameter]

Start

ClipEnd

End

Integer

[Input Parameter]

End

OutputDepth

Output Depth

Integer

[Input Parameter]

Output Depth

Valid Values:

Default

8 bit

16 bit

float

HDR

0 - 4

OutputChannels

Output Channels

Integer

[Input Parameter]

Output Channels

Valid Values:

Default

RGBA

RGB

Alpha

0 - 3

SizeMode

Size Mode

Integer

[Input Parameter]

Size Mode

Valid Values:

Background

Foreground

Input 3

OutputSizeMode

Output Size Mode

Integer

[Input Parameter]

Output Size Mode

Valid Values:

Use Effect Region

Use Default Image Size

sl

Shape Lists

Empty

[Input Parameter]

Shape Lists

FGType

Foreground Type

Integer

[Input Parameter]

Foreground Type

Valid Values:

Not Pre-multiplied

Pre-multiplied

0 - 1

Output

Output

Integer

[Input Parameter]

Output

Valid Values:

Composite

Depth

Edge Matte

0 - 2

InvertInputs

Invert Inputs

Bool

[Input Parameter]

Invert Inputs

false - true

Tolerance

Tolerance

Double

[Input Parameter]

Tolerance

-0.1 - 0.1

maxz

Z Values Range

Double

[Input Parameter]

Z Values Range

1.0 - Max

1.0 - 100000.0

GarbageShapes_Param

Garbage Shapes_param

Empty

[Input Parameter]

Garbage Shapes_param

GarbageShapesApply

Apply Garbage Matte

Bool

[Input Parameter]

Apply Garbage Matte

GarbageShapesBlur

Shape Blur

Integer

[Input Parameter]

Shape Blur

0 - 2000

0 - 50

GarbageObeyMask

Connections

Empty

[Input Parameter]

Connections

GarbageActive

Process Active

Bool

[Input Parameter]

Process Active

GarbageComponentFlags

Channel Mask

Integer

[Input Parameter]

Channel Mask

Valid Values:

R

G

B

A

0 - 31

Example

ApplyFxOp("ZComp", "");
function ApplyFxOp( in_sOpPreset, in_sCnxSet )
{
	NewScene(null, false);
	var oTree = CreateFxTree();
	
	// AddFxOp returns an FxOperator 
	var oFxOp = AddFxOp(oTree, in_sOpPreset);
	return (typeof(oFxOp) == "object" && oFxOp.IsClassOf(siFxOperatorID)) ? oFxOp : null;
}

Autodesk Softimage 2011