r3rensys

Class

real/raytr/r3rensys.h

Library

r3raytr

Description:

General Rendering System Class

See Also

oops/r3model.h

Super Class

r3Model

R3CLID_MODEL

JavaScript

r3Rensys

Class Identifier

R3CLID_RENSYS - 439

Methods

INSERT, WORLDTRANSFORMED, LIBRARYCHANGED, OBJECTSREADY, CAMERAREADY, TOTALOUTPUT, ENUMNEEDEDCHANNELS, CLEAROUTPUT, UNREGISTERFIRST, CLEANUP,

Attributes

ModelView, CameraSpace, RecursionTreshold, XExtend, YExtend, XExtendRel, YExtendRel, IsActive, VolumeSampling, IsChanged, InterpolateUnderSample, VolumeShadows, ChannelMapper, FocusingDistance, FStop, DepthOfField, HorizontalScaling, VerticalScaling, RenderInput, OutputList, RamUsePolicy, ErrorMsg,

Registration

int R3RegisterRenSysClass(R3APP *app);

R3REM_INSERT

Method

INSERT

Identifier

R3REM_INSERT

JavaScript

obj.INSERT();

Description

R3REM_WORLDTRANSFORMED

Method

WORLDTRANSFORMED

Identifier

R3REM_WORLDTRANSFORMED

JavaScript

obj.WORLDTRANSFORMED();

Description

R3REM_LIBRARYCHANGED

Method

LIBRARYCHANGED

Identifier

R3REM_LIBRARYCHANGED

JavaScript

obj.LIBRARYCHANGED();

Description

R3REM_OBJECTSREADY

Method

OBJECTSREADY

Identifier

R3REM_OBJECTSREADY

JavaScript

obj.OBJECTSREADY();

Description

R3REM_CAMERAREADY

Method

CAMERAREADY

Identifier

R3REM_CAMERAREADY

JavaScript

obj.CAMERAREADY();

Description

R3REM_TOTALOUTPUT

Method

TOTALOUTPUT

Identifier

R3REM_TOTALOUTPUT

JavaScript

obj.TOTALOUTPUT();

Description

R3REM_ENUMNEEDEDCHANNELS

Method

ENUMNEEDEDCHANNELS

Identifier

R3REM_ENUMNEEDEDCHANNELS

Param 1:

R3OBJ*, retobj

Param 3:

R3INT, retmth

JavaScript

obj.ENUMNEEDEDCHANNELS(p1, p3);

Description

enumerate all raysample channels that are needed * by sending R3SendMsgA(retobj, retmth, channelname) *

R3REM_CLEAROUTPUT

Method

CLEAROUTPUT

Identifier

R3REM_CLEAROUTPUT

JavaScript

obj.CLEAROUTPUT();

Description

unregisters all outputs

R3REM_UNREGISTERFIRST

Method

UNREGISTERFIRST

Identifier

R3REM_UNREGISTERFIRST

JavaScript

obj.UNREGISTERFIRST();

Description

unregisters first item of output list and return its address

R3REM_CLEANUP

Method

CLEANUP

Identifier

R3REM_CLEANUP

JavaScript

obj.CLEANUP();

Description

rendering pipeline is done, free buffers etc.

ModelView

Attribute

ModelView

Identifier

R3REA_ModelView

Type

r3Matrix

Description

projection matrix

Syntax

jsobj.SetModelView(value);

R3MATRIX value = ...;
R3SetAttrs(r3obj, R3REA_ModelView, &value, R3TAG_END);

CameraSpace

Attribute

CameraSpace

Identifier

R3REA_CameraSpace

Type

r3Matrix

Description

camera space matrix

Syntax

jsobj.SetCameraSpace(value);

R3MATRIX value = ...;
R3SetAttrs(r3obj, R3REA_CameraSpace, &value, R3TAG_END);

RecursionTreshold

Attribute

RecursionTreshold

Identifier

R3REA_RecursionTreshold

JavaScript type

Number

C type

R3FLOAT

Description

0..1, defines min signal that triggers recursions

Syntax

jsobj.SetRecursionTreshold(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3REA_RecursionTreshold, value, R3TAG_END);

XExtend

Attribute

XExtend

Identifier

R3REA_XExtend

JavaScript type

Integer

C type

R3INT

Description

number of pixels. Max area defined by XExtend and XExtendRel is rendered

Syntax

value = jsobj.GetXExtend();

R3INT value;
R3GetAttrs(r3obj, R3REA_XExtend, &value, R3TAG_END);

YExtend

Attribute

YExtend

Identifier

R3REA_YExtend

JavaScript type

Integer

C type

R3INT

Description

'R3REA_YExtend' not documented

Syntax

value = jsobj.GetYExtend();

R3INT value;
R3GetAttrs(r3obj, R3REA_YExtend, &value, R3TAG_END);

XExtendRel

Attribute

XExtendRel

Identifier

R3REA_XExtendRel

JavaScript type

Number

C type

R3FLOAT

Description

proportion extension width/image width

Syntax

value = jsobj.GetXExtendRel();

R3FLOAT value;
R3GetAttrs(r3obj, R3REA_XExtendRel, &value, R3TAG_END);

YExtendRel

Attribute

YExtendRel

Identifier

R3REA_YExtendRel

JavaScript type

Number

C type

R3FLOAT

Description

'R3REA_YExtendRel' not documented

Syntax

value = jsobj.GetYExtendRel();

R3FLOAT value;
R3GetAttrs(r3obj, R3REA_YExtendRel, &value, R3TAG_END);

IsActive

Attribute

IsActive

Identifier

R3REA_IsActive

JavaScript type

Integer

C type

R3INT

Description

TRUE if rendering system will render

Syntax

jsobj.SetIsActive(value);
value = jsobj.GetIsActive();

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

VolumeSampling

Attribute

VolumeSampling

Identifier

R3REA_VolumeSampling

JavaScript type

Boolean

C type

R3BOOL

Description

if TRUE then volume effects computed

Syntax

jsobj.SetVolumeSampling(value);

R3BOOL value = ...;
R3SetAttrs(r3obj, R3REA_VolumeSampling, value, R3TAG_END);

IsChanged

Attribute

IsChanged

Identifier

R3REA_IsChanged

JavaScript type

Boolean

C type

R3BOOL

Description

TRUE if any data that causes re-rendering is changed since last rendering (read only)

Syntax

value = jsobj.GetIsChanged();

R3BOOL value;
R3GetAttrs(r3obj, R3REA_IsChanged, &value, R3TAG_END);

InterpolateUnderSample

Attribute

InterpolateUnderSample

Identifier

R3REA_InterpolateUnderSample

JavaScript type

Boolean

C type

R3BOOL

Description

if true the under sample block interior interpolated

Syntax

jsobj.SetInterpolateUnderSample(value);

R3BOOL value = ...;
R3SetAttrs(r3obj, R3REA_InterpolateUnderSamples, value, R3TAG_END);

VolumeShadows

Attribute

VolumeShadows

Identifier

R3REA_VolumeShadows

JavaScript type

Boolean

C type

R3BOOL

Description

if true then compute shadows casted by fog

Syntax

jsobj.SetVolumeShadows(value);

R3BOOL value = ...;
R3SetAttrs(r3obj, R3REA_VolumeShadows, value, R3TAG_END);

ChannelMapper

Attribute

ChannelMapper

Identifier

R3REA_ChannelMapper

JavaScript type

Object

C type

R3OBJ*

Description

1 wide raysample prototype object. Render systems can get current channel configuration by studying/copying this object. The channel configuration changes are reported by R3REM_LIBRARYCHANGED message where p1 parameter is R3CLID_CHANNEL

Syntax

jsobj.SetChannelMapper(value);

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3REA_ChannelMapper, value, R3TAG_END);

FocusingDistance

Attribute

FocusingDistance

Identifier

R3REA_FocusingDistance

JavaScript type

Number

C type

R3FLOAT

Description

camera property

Syntax

jsobj.SetFocusingDistance(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3REA_FocusingDistance, value, R3TAG_END);

FStop

Attribute

FStop

Identifier

R3REA_FStop

JavaScript type

Number

C type

R3FLOAT

Description

camera property

Syntax

jsobj.SetFStop(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3REA_FStop, value, R3TAG_END);

DepthOfField

Attribute

DepthOfField

Identifier

R3REA_DepthOfField

JavaScript type

Boolean

C type

R3BOOL

Description

switches dof effect on

Syntax

jsobj.SetDepthOfField(value);

R3BOOL value = ...;
R3SetAttrs(r3obj, R3REA_DepthOfField, value, R3TAG_END);

HorizontalScaling

Attribute

HorizontalScaling

Identifier

R3REA_HorizontalScaling

JavaScript type

Number

C type

R3FLOAT

Description

read only - horiz. image resolution change ratio outw/inw

Syntax

value = jsobj.GetHorizontalScaling();

R3FLOAT value;
R3GetAttrs(r3obj, R3REA_HorizontalScaling, &value, R3TAG_END);

VerticalScaling

Attribute

VerticalScaling

Identifier

R3REA_VerticalScaling

JavaScript type

Number

C type

R3FLOAT

Description

read only - vert. image resolution change ratio outh/inh

Syntax

value = jsobj.GetVerticalScaling();

R3FLOAT value;
R3GetAttrs(r3obj, R3REA_VerticalScaling, &value, R3TAG_END);

RenderInput

Attribute

RenderInput

Identifier

R3REA_RenderInput

JavaScript type

Object

C type

R3OBJ*

Description

an output object that inputs data into the render system

Syntax

value = jsobj.GetRenderInput();

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

OutputList

Attribute

OutputList

Identifier

R3REA_OutputList

JavaScript type

r3List

C type

R3LIST*

Description

R3LIST * (read only), the list of currently registered outputs

Syntax

value = jsobj.GetOutputList();

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

RamUsePolicy

Attribute

RamUsePolicy

Identifier

R3REA_RamUsePolicy

JavaScript type

Integer

C type

R3INT

Description

memory use policy (0 = select best mode, 1=use carelessly, 2=spare some, 3=spare even more etc)

Syntax

jsobj.SetRamUsePolicy(value);
value = jsobj.GetRamUsePolicy();

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

ErrorMsg

Attribute

ErrorMsg

Identifier

R3REA_ErrorMsg

JavaScript type

String

C type

char*

Description

read only message, explains why rendering failed

Syntax

value = jsobj.GetErrorMsg();

char* value;
R3GetAttrs(r3obj, R3REA_ErrorMsg, &value, R3TAG_END);

R3RE_PERSPECTIVE

R3RE_ORTHOGRAPHIC

R3REAAMODE_GEOMETRIC

R3REAAMODE_STOCHASTIC

R3RR_FAILED

R3RR_OK

R3RR_CANCELED