r3envelo

Class

real/code/r3envelo.h

Library

r3code

Description:

Envelope Class

See Also

oops/r3model.h

See Also

real/code/r3ttag.h

Super Class

r3Model

R3CLID_MODEL

JavaScript

r3Envelope

Class Identifier

R3CLID_ENVELOPE - 48

Attributes

Input, Output, Curve, InputTag, OutputTag, InputObjectId, OutputObjectId, InputObjectLayer, OutputObjectLayer, InputType, OutputType, InputTagIndex, OutputTagIndex,

Registration

int R3RegisterEnvelopeClass(R3APP *app);

Input

Attribute

Input

Identifier

R3ENVA_Input

JavaScript type

Object

C type

R3OBJ*

Description

input object

Syntax

jsobj.SetInput(value);
value = jsobj.GetInput();

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3ENVA_Input, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3ENVA_Input, &value, R3TAG_END);

Output

Attribute

Output

Identifier

R3ENVA_Output

JavaScript type

Object

C type

R3OBJ*

Description

output object

Syntax

jsobj.SetOutput(value);
value = jsobj.GetOutput();

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3ENVA_Output, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3ENVA_Output, &value, R3TAG_END);

Curve

Attribute

Curve

Identifier

R3ENVA_Curve

JavaScript type

Object

C type

R3OBJ*

Description

curve defining transformation

Syntax

value = jsobj.GetCurve();

R3OBJ* value;
R3GetAttrs(r3obj, R3ENVA_Curve, &value, R3TAG_END);

InputTag

Attribute

InputTag

Identifier

R3ENVA_InputTag

JavaScript type

Integer

C type

R3INT

Description

attribute to be read from input object

Syntax

jsobj.SetInputTag(value);
value = jsobj.GetInputTag();

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

OutputTag

Attribute

OutputTag

Identifier

R3ENVA_OutputTag

JavaScript type

Integer

C type

R3INT

Description

attribute of output object to be transformed

Syntax

jsobj.SetOutputTag(value);
value = jsobj.GetOutputTag();

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

InputObjectId

Attribute

InputObjectId

Identifier

R3ENVA_InputObjectId

JavaScript type

Integer

C type

R3INT

Description

unique indentifier used for binding

Syntax

jsobj.SetInputObjectId(value);
value = jsobj.GetInputObjectId();

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

OutputObjectId

Attribute

OutputObjectId

Identifier

R3ENVA_OutputObjectId

JavaScript type

Integer

C type

R3INT

Description

Syntax

jsobj.SetOutputObjectId(value);
value = jsobj.GetOutputObjectId();

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

InputObjectLayer

Attribute

InputObjectLayer

Identifier

R3ENVA_InputObjectLayer

JavaScript type

Integer

C type

int

Description

Syntax

jsobj.SetInputObjectLayer(value);
value = jsobj.GetInputObjectLayer();

int value = ...;
R3SetAttrs(r3obj, R3ENVA_InputObjectLayer, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3ENVA_InputObjectLayer, &value, R3TAG_END);

OutputObjectLayer

Attribute

OutputObjectLayer

Identifier

R3ENVA_OutputObjectLayer

JavaScript type

Integer

C type

int

Description

Syntax

jsobj.SetOutputObjectLayer(value);
value = jsobj.GetOutputObjectLayer();

int value = ...;
R3SetAttrs(r3obj, R3ENVA_OutputObjectLayer, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3ENVA_OutputObjectLayer, &value, R3TAG_END);

InputType

Attribute

InputType

Identifier

R3ENVA_InputType

JavaScript type

Integer

C type

int

Description

'R3ENVA_InputType' not documented

Syntax

jsobj.SetInputType(value);
value = jsobj.GetInputType();

int value = ...;
R3SetAttrs(r3obj, R3ENVA_InputType, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3ENVA_InputType, &value, R3TAG_END);

OutputType

Attribute

OutputType

Identifier

R3ENVA_OutputType

JavaScript type

Integer

C type

int

Description

'R3ENVA_OutputType' not documented

Syntax

jsobj.SetOutputType(value);
value = jsobj.GetOutputType();

int value = ...;
R3SetAttrs(r3obj, R3ENVA_OutputType, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3ENVA_OutputType, &value, R3TAG_END);

InputTagIndex

Attribute

InputTagIndex

Identifier

R3ENVA_InputTagIndex

JavaScript type

Integer

C type

R3INT

Description

index of tag if indexed, otherwise -1

Syntax

jsobj.SetInputTagIndex(value);
value = jsobj.GetInputTagIndex();

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

OutputTagIndex

Attribute

OutputTagIndex

Identifier

R3ENVA_OutputTagIndex

JavaScript type

Integer

C type

R3INT

Description

index of tag if indexed, otherwise -1

Syntax

jsobj.SetOutputTagIndex(value);
value = jsobj.GetOutputTagIndex();

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