r3mpvar

Class

real/code/r3mpvar.h

Library

r3code

Description:

Variable material property shader.

See Also

real/code/r3matprp.h

Super Class

r3Matprop

R3CLID_MATPROP

JavaScript

r3Mpvariable

Class Identifier

R3CLID_MPVARIABLE - 1224

Methods

Attributes

Clid, Name, Initialize, InitialValue, RenderInitAsConstan, Float, Vector,

Clid

Attribute

Clid

Identifier

R3MPVARA_Clid

JavaScript type

Integer

C type

R3CLID

Description

R3CLID_FLOATCHANNEL/VECTORCHANNEL/COLORCHANNEL

Syntax

jsobj.SetClid(value);
value = jsobj.GetClid();

R3CLID value = ...;
R3SetAttrs(r3obj, R3MPVARA_Clid, value, R3TAG_END);
R3CLID value;
R3GetAttrs(r3obj, R3MPVARA_Clid, &value, R3TAG_END);

Name

Attribute

Name

Identifier

R3MPVARA_Name

JavaScript type

String

C type

char*

Description

name of the variable

Syntax

jsobj.SetName(value);
value = jsobj.GetName();

char* value = ...;
R3SetAttrs(r3obj, R3MPVARA_Name, value, R3TAG_END);
char* value;
R3GetAttrs(r3obj, R3MPVARA_Name, &value, R3TAG_END);

Initialize

Attribute

Initialize

Identifier

R3MPVARA_Initialize

JavaScript type

Integer

C type

R3INT

Description

initialize the variable when created

Syntax

jsobj.SetInitialize(value);
value = jsobj.GetInitialize();

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

InitialValue

Attribute

InitialValue

Identifier

R3MPVARA_InitialValue

JavaScript type

Number

C type

R3FLOAT

Description

union {R3FLOAT, R3VECTOR}, initial value

Syntax

jsobj.SetInitialValue(value);
value = jsobj.GetInitialValue();

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

RenderInitAsConstan

Attribute

RenderInitAsConstan

Identifier

R3MPVARA_RenderInitAsConstan

JavaScript type

Boolean

C type

R3BOOL

Description

if true object will render varable initialize as constant operator

Syntax

jsobj.SetRenderInitAsConstan(value);
value = jsobj.GetRenderInitAsConstan();

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

Float

Attribute

Float

Identifier

R3MPVARA_Float

JavaScript type

Number

C type

R3FLOAT

Description

value for the float type, relevant if Initialize is true

Syntax

jsobj.SetFloat(value);
value = jsobj.GetFloat();

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

Vector

Attribute

Vector

Identifier

R3MPVARA_Vector

Type

r3Vect

Description

value for the vector and color types, relevant if Initialize is true

Syntax

jsobj.SetVector(value);
value = jsobj.GetVector();

R3VECTOR value = ...;
R3SetAttrs(r3obj, R3MPVARA_Vector, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3MPVARA_Vector, &value, R3TAG_END);