r3combef

Class

real/code/r3combef.h

Library

r3code

Description:

Combination post effect model

See Also

real/code/r3postim.h

Super Class

r3Postimageeffectmodel

R3CLID_POSTIMAGEEFFECTMODEL

JavaScript

r3Combinationeffect

Class Identifier

R3CLID_COMBINATIONEFFECT - 294

Methods

ADDNAME, REMOVENAMED, REMOVEINDEXED, SETCHANNELSTORAGET, GETCHANNELSTORAGET, MOVEUPINDEXED, MOVEDOWNINDEXED, CHECKCHILDREFERENC, ADDNAMEINDEXED, ADDINITCHANNEL, REMOVEINITCHANNEL, ADDOUTPUTCHANNEL, REMOVEOUTPUTCHANNE, SETCHANNELNORMVALU, GETCHANNELNORMVALU, SETCHANNELSIGN, GETCHANNELSIGN, DISABLEINDEXED,

Attributes

List, ChannelList, Open, InitAllChannels, OutputAllChannels, InitChannels, OutputChannels, InputHorizontalSca, InputVerticalScali, OutputHorizontalSc, OutputVerticalScal, RecommendedUse,

R3COMBEFM_ADDNAME

Method

ADDNAME

Identifier

R3COMBEFM_ADDNAME

Param 3:

char*, name of the effect to be added

JavaScript

obj.ADDNAME(p3);

Description

Adds an effect object.

R3COMBEFM_REMOVENAMED

Method

REMOVENAMED

Identifier

R3COMBEFM_REMOVENAMED

Param 3:

char*, name of the effect to be removed

JavaScript

obj.REMOVENAMED(p3);

Description

Remove the effect specified by p3.

R3COMBEFM_REMOVEINDEXED

Method

REMOVEINDEXED

Identifier

R3COMBEFM_REMOVEINDEXED

Param 3:

R3INT, ordnum of the effect to be removed

JavaScript

obj.REMOVEINDEXED(p3);

Description

remove an effect by ordnum.

R3COMBEFM_SETCHANNELSTORAGET

Method

SETCHANNELSTORAGET

Identifier

R3COMBEFM_SETCHANNELSTORAGET

Param 1:

R3CLID, class id of the channel

Param 2:

char*, name of the channel

Param 3:

R3INT, storage type.

JavaScript

obj.SETCHANNELSTORAGET(p1, p2, p3);

Description

Set channel storagetype.

R3COMBEFM_GETCHANNELSTORAGET

Method

GETCHANNELSTORAGET

Identifier

R3COMBEFM_GETCHANNELSTORAGET

Return

R3INT, storagetype

Param 1:

R3CLID, class id of the channel

Param 3:

char*, name of the channel

JavaScript

rc = obj.GETCHANNELSTORAGET(p1, p3);

Description

Get the storagetype of the given channel.

R3COMBEFM_MOVEUPINDEXED

Method

MOVEUPINDEXED

Identifier

R3COMBEFM_MOVEUPINDEXED

Param 3:

R3INT, ordnum of the effect to be moved

JavaScript

obj.MOVEUPINDEXED(p3);

Description

move an effect up in the execution order.

R3COMBEFM_MOVEDOWNINDEXED

Method

MOVEDOWNINDEXED

Identifier

R3COMBEFM_MOVEDOWNINDEXED

Param 3:

R3INT, ordnum of the effect to be moved

JavaScript

obj.MOVEDOWNINDEXED(p3);

Description

move an effect down in the execution order.

R3COMBEFM_CHECKCHILDREFERENC

Method

CHECKCHILDREFERENC

Identifier

R3COMBEFM_CHECKCHILDREFERENC

Param 3:

char*, name of the effect to be checked.

JavaScript

obj.CHECKCHILDREFERENC(p3);

Description

called internally to make sure no infinite recursion occurs.

R3COMBEFM_ADDNAMEINDEXED

Method

ADDNAMEINDEXED

Identifier

R3COMBEFM_ADDNAMEINDEXED

Param 1:

R3INT, specifies the insertion point, -1 inserts at the head.

Param 3:

char*, name

JavaScript

obj.ADDNAMEINDEXED(p1, p3);

Description

adds a name at a certain index

R3COMBEFM_ADDINITCHANNEL

Method

ADDINITCHANNEL

Identifier

R3COMBEFM_ADDINITCHANNEL

Param 3:

char*, name of the channel to be added

JavaScript

obj.ADDINITCHANNEL(p3);

Description

adds a channel

R3COMBEFM_REMOVEINITCHANNEL

Method

REMOVEINITCHANNEL

Identifier

R3COMBEFM_REMOVEINITCHANNEL

Param 3:

char*, name of the channel to be removed

JavaScript

obj.REMOVEINITCHANNEL(p3);

Description

adds a channel

R3COMBEFM_ADDOUTPUTCHANNEL

Method

ADDOUTPUTCHANNEL

Identifier

R3COMBEFM_ADDOUTPUTCHANNEL

Param 3:

char*, name of the output channel to be added

JavaScript

obj.ADDOUTPUTCHANNEL(p3);

Description

adds an output channel

R3COMBEFM_REMOVEOUTPUTCHANNE

Method

REMOVEOUTPUTCHANNE

Identifier

R3COMBEFM_REMOVEOUTPUTCHANNE

Param 3:

char*, name of the channel to be removed

JavaScript

obj.REMOVEOUTPUTCHANNE(p3);

Description

remove an output channel

R3COMBEFM_SETCHANNELNORMVALU

Method

SETCHANNELNORMVALU

Identifier

R3COMBEFM_SETCHANNELNORMVALU

Param 1:

R3CLID, class id of the channel

Param 2:

char*, name of the channel

Param 3:

R3INT, norm. value

JavaScript

obj.SETCHANNELNORMVALU(p1, p2, p3);

Description

Set channel norm value.

R3COMBEFM_GETCHANNELNORMVALU

Method

GETCHANNELNORMVALU

Identifier

R3COMBEFM_GETCHANNELNORMVALU

Return

R3INT, norm. value

Param 1:

R3CLID, class id of the channel

Param 3:

char*, name of the channel

JavaScript

rc = obj.GETCHANNELNORMVALU(p1, p3);

Description

Get the norm. value of the channel.

R3COMBEFM_SETCHANNELSIGN

Method

SETCHANNELSIGN

Identifier

R3COMBEFM_SETCHANNELSIGN

Param 1:

R3CLID, class id of the channel

Param 2:

char*, name of the channel

Param 3:

R3INT, sign.

JavaScript

obj.SETCHANNELSIGN(p1, p2, p3);

Description

Set channel sign.

R3COMBEFM_GETCHANNELSIGN

Method

GETCHANNELSIGN

Identifier

R3COMBEFM_GETCHANNELSIGN

Return

R3INT, sign

Param 1:

R3CLID, class id of the channel

Param 3:

char*, name of the channel

JavaScript

rc = obj.GETCHANNELSIGN(p1, p3);

Description

Get the sign of the channel.

R3COMBEFM_DISABLEINDEXED

Method

DISABLEINDEXED

Identifier

R3COMBEFM_DISABLEINDEXED

Param 1:

R3INT, index of child

Param 3:

R3BOOL, disables if true else enables

JavaScript

obj.DISABLEINDEXED(p1, p3);

Description

Enablse/disables child effect

List

Attribute

List

Identifier

R3COMBEFA_List

JavaScript type

r3List

C type

R3LIST*

Description

effec name list

Syntax

value = jsobj.GetList();

R3LIST* value;
R3GetAttrs(r3obj, R3COMBEFA_List, &value, R3TAG_END);

ChannelList

Attribute

ChannelList

Identifier

R3COMBEFA_ChannelList

JavaScript type

r3List

C type

R3LIST*

Description

channel list

Syntax

value = jsobj.GetChannelList();

R3LIST* value;
R3GetAttrs(r3obj, R3COMBEFA_ChannelList, &value, R3TAG_END);

Open

Attribute

Open

Identifier

R3COMBEFA_Open

JavaScript type

Boolean

C type

R3BOOL

Description

open or close

Syntax

jsobj.SetOpen(value);
value = jsobj.GetOpen();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3COMBEFA_Open, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3COMBEFA_Open, &value, R3TAG_END);

InitAllChannels

Attribute

InitAllChannels

Identifier

R3COMBEFA_InitAllChannels

JavaScript type

Boolean

C type

R3BOOL

Description

if set all channels are initialzed from parent ACTIVE,(if exists) before processing

Syntax

jsobj.SetInitAllChannels(value);
value = jsobj.GetInitAllChannels();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3COMBEFA_InitAllChannels, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3COMBEFA_InitAllChannels, &value, R3TAG_END);

OutputAllChannels

Attribute

OutputAllChannels

Identifier

R3COMBEFA_OutputAllChannels

JavaScript type

Boolean

C type

R3BOOL

Description

if set all channels are outputted to parent (if exists) after processing

Syntax

jsobj.SetOutputAllChannels(value);
value = jsobj.GetOutputAllChannels();

R3BOOL value = ...;
R3SetAttrs(r3obj, R3COMBEFA_OutputAllChannels, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3COMBEFA_OutputAllChannels, &value, R3TAG_END);

InitChannels

Attribute

InitChannels

Identifier

R3COMBEFA_InitChannels

JavaScript type

r3List

C type

R3LIST*

Description

names of nodes define custom init config if R3COMBEFA_InitAllChannels is FALSE

Syntax

value = jsobj.GetInitChannels();

R3LIST* value;
R3GetAttrs(r3obj, R3COMBEFA_InitChannels, &value, R3TAG_END);

OutputChannels

Attribute

OutputChannels

Identifier

R3COMBEFA_OutputChannels

JavaScript type

r3List

C type

R3LIST*

Description

names of nodes define custom output config if R3COMBEFA_OutputAllChannels is FALSE

Syntax

value = jsobj.GetOutputChannels();

R3LIST* value;
R3GetAttrs(r3obj, R3COMBEFA_OutputChannels, &value, R3TAG_END);

InputHorizontalSca

Attribute

InputHorizontalSca

Identifier

R3COMBEFA_InputHorizontalSca

JavaScript type

Number

C type

R3FLOAT

Description

for input scaling

Syntax

jsobj.SetInputHorizontalSca(value);
value = jsobj.GetInputHorizontalSca();

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3COMBEFA_InputHorizontalScaling, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3COMBEFA_InputHorizontalScaling, &value, R3TAG_END);

InputVerticalScali

Attribute

InputVerticalScali

Identifier

R3COMBEFA_InputVerticalScali

JavaScript type

Number

C type

R3FLOAT

Description

for input scaling

Syntax

jsobj.SetInputVerticalScali(value);
value = jsobj.GetInputVerticalScali();

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3COMBEFA_InputVerticalScaling, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3COMBEFA_InputVerticalScaling, &value, R3TAG_END);

OutputHorizontalSc

Attribute

OutputHorizontalSc

Identifier

R3COMBEFA_OutputHorizontalSc

JavaScript type

Number

C type

R3FLOAT

Description

output scaling

Syntax

jsobj.SetOutputHorizontalSc(value);
value = jsobj.GetOutputHorizontalSc();

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3COMBEFA_OutputHorizontalScaling, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3COMBEFA_OutputHorizontalScaling, &value, R3TAG_END);

OutputVerticalScal

Attribute

OutputVerticalScal

Identifier

R3COMBEFA_OutputVerticalScal

JavaScript type

Number

C type

R3FLOAT

Description

for output scaling

Syntax

jsobj.SetOutputVerticalScal(value);
value = jsobj.GetOutputVerticalScal();

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3COMBEFA_OutputVerticalScaling, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3COMBEFA_OutputVerticalScaling, &value, R3TAG_END);

RecommendedUse

Attribute

RecommendedUse

Identifier

R3COMBEFA_RecommendedUse

JavaScript type

Integer

C type

R3INT

Description

see enumeration below

Syntax

jsobj.SetRecommendedUse(value);
value = jsobj.GetRecommendedUse();

R3INT value = ...;
R3SetAttrs(r3obj, R3COMBEFA_RecommendedUse, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3COMBEFA_RecommendedUse, &value, R3TAG_END);