r3rspec

Class

real/code/r3rspec.h

Library

r3code

Description:

Real 3D Rendering Options

See Also

oops/r3model.h

See Also

oops/r3slctbl.h

Super Class

r3Model

R3CLID_MODEL

JavaScript

r3Rspec

Class Identifier

R3CLID_RSPEC - 61

Methods

SETOPTION, CLEAROPTION, OPTIONISSET, ADDSERVER, REMOVESERVER, ADDTRACECHANNEL, REMOVETRACECHANNEL, SETCHANNELAA, SETCHANNELOPERATION, GETCHANNELAA, GETCHANNELOPERATION, REMOVEAACHANNEL, CLEARSERVERS, FETCHSERVERS, FREEAUTODETECT,

Attributes

AutoBox, Options, RecursionDepth, RecursionThreshold, AntialiasingLevel, AntialiasingThreshold, StepX, StepY, ScanLineDepth, ScanLineAccuracy, AntiAliasingMode, Concurrency, RenderServers, BoxCountX, BoxCountY, UnderSamplingTreshold, BoxRendering, TraceChannels, OutLineColor, OutLineFillColor, OutLineChannelName, DitherScale, AAChannels, RamUsePolicy, CausticsBrightness, CausticsSampling, AutoThread, Memory, GlobalGeometryQuality, AutoDetectServers,

Registration

int R3RegisterRspecClass(R3APP *app);

R3SPCM_SETOPTION

Method

SETOPTION

Identifier

R3SPCM_SETOPTION

Param 3:

R3INT, flags to be set

JavaScript

obj.SETOPTION(p3);

Description

Set option flags

R3SPCM_CLEAROPTION

Method

CLEAROPTION

Identifier

R3SPCM_CLEAROPTION

Param 3:

R3INT, flags to be reset

JavaScript

obj.CLEAROPTION(p3);

Description

Reset option flags

R3SPCM_OPTIONISSET

Method

OPTIONISSET

Identifier

R3SPCM_OPTIONISSET

Param 3:

R3INT, flag to be checked

JavaScript

obj.OPTIONISSET(p3);

Description

See if given option is set

R3SPCM_ADDSERVER

Method

ADDSERVER

Identifier

R3SPCM_ADDSERVER

Return

R3OBJ*, created server object

Param 1:

R3BOOL, don't call R3MM_CHANGED

Param 2:

R3BOOL, disabled

Param 3:

char*, name of server

JavaScript

rc = obj.ADDSERVER(p1, p2, p3);

Description

Add a server to use for rendering

R3SPCM_REMOVESERVER

Method

REMOVESERVER

Identifier

R3SPCM_REMOVESERVER

Param 3:

char*, name of server

JavaScript

obj.REMOVESERVER(p3);

Description

Remove a server

R3SPCM_ADDTRACECHANNEL

Method

ADDTRACECHANNEL

Identifier

R3SPCM_ADDTRACECHANNEL

Param 1:

char*, name of signal channel

Param 3:

char*, name of ray channel

JavaScript

obj.ADDTRACECHANNEL(p1, p3);

Description

Add a trace channel item.

R3SPCM_REMOVETRACECHANNEL

Method

REMOVETRACECHANNEL

Identifier

R3SPCM_REMOVETRACECHANNEL

Param 1:

char*, name of signal channel

Param 3:

char*, name of ray channel

JavaScript

obj.REMOVETRACECHANNEL(p1, p3);

Description

Remove a trace channel item. The item with matching channel names is removed.

R3SPCM_SETCHANNELAA

Method

SETCHANNELAA

Identifier

R3SPCM_SETCHANNELAA

Param 1:

R3BOOL, turns antialias check on/off

Param 3:

char*, name of channel

JavaScript

obj.SETCHANNELAA(p1, p3);

Description

Define channel's aa triggert state. Trigger channel values are examined in antialiasing & subsampling

R3SPCM_SETCHANNELOPERATION

Method

SETCHANNELOPERATION

Identifier

R3SPCM_SETCHANNELOPERATION

Param 3:

char*, name of channel

JavaScript

obj.SETCHANNELOPERATION(p3);

Description

Defines the antialias operation for a channel.

R3SPCM_GETCHANNELAA

Method

GETCHANNELAA

Identifier

R3SPCM_GETCHANNELAA

Return

R3BOOL, TRUE if triggering is on

Param 3:

char*, name of channel

JavaScript

rc = obj.GETCHANNELAA(p3);

Description

Returns aa trigger state of a channel.

R3SPCM_GETCHANNELOPERATION

Method

GETCHANNELOPERATION

Identifier

R3SPCM_GETCHANNELOPERATION

Return

int, see aa operations below

Param 3:

char*, name of channel

JavaScript

rc = obj.GETCHANNELOPERATION(p3);

Description

Reads the antialias operation of a channel.

R3SPCM_REMOVEAACHANNEL

Method

REMOVEAACHANNEL

Identifier

R3SPCM_REMOVEAACHANNEL

Param 3:

char*, name of channel

JavaScript

obj.REMOVEAACHANNEL(p3);

Description

Remove a antialias channel spec. The channel will use default settings.

R3SPCM_CLEARSERVERS

Method

CLEARSERVERS

Identifier

R3SPCM_CLEARSERVERS

JavaScript

obj.CLEARSERVERS();

Description

remove servers

R3SPCM_FETCHSERVERS

Method

FETCHSERVERS

Identifier

R3SPCM_FETCHSERVERS

JavaScript

obj.FETCHSERVERS();

Description

R3SPCCM_FREEAUTODETECT

Method

FREEAUTODETECT

Identifier

R3SPCCM_FREEAUTODETECT

JavaScript

obj.FREEAUTODETECT();

Description

AutoBox

Attribute

AutoBox

Identifier

R3SPCA_AutoBox

JavaScript type

Boolean

C type

R3BOOL

Description

automatic box count detection

Syntax

jsobj.SetAutoBox(value);
value = jsobj.GetAutoBox();

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

Options

Attribute

Options

Identifier

R3SPCA_Options

JavaScript type

Integer

C type

R3INT

Description

see option flags below

Syntax

jsobj.SetOptions(value);
value = jsobj.GetOptions();

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

RecursionDepth

Attribute

RecursionDepth

Identifier

R3SPCA_RecursionDepth

JavaScript type

Integer

C type

R3INT

Description

maximum recursion depth for ray tracing

Syntax

jsobj.SetRecursionDepth(value);
value = jsobj.GetRecursionDepth();

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

RecursionThreshold

Attribute

RecursionThreshold

Identifier

R3SPCA_RecursionThreshold

JavaScript type

Number

C type

R3FLOAT

Description

treshold for recursion, if secondary ray is weaker than this treshold, it is not traced

Syntax

jsobj.SetRecursionThreshold(value);
value = jsobj.GetRecursionThreshold();

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

AntialiasingLevel

Attribute

AntialiasingLevel

Identifier

R3SPCA_AntialiasingLevel

JavaScript type

Integer

C type

R3INT

Description

level of antialiasing

Syntax

jsobj.SetAntialiasingLevel(value);
value = jsobj.GetAntialiasingLevel();

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

AntialiasingThreshold

Attribute

AntialiasingThreshold

Identifier

R3SPCA_AntialiasingThreshold

JavaScript type

Number

C type

R3FLOAT

Description

if difference between subsequent samples is higher than this value, antialiasing is started

Syntax

jsobj.SetAntialiasingThreshold(value);
value = jsobj.GetAntialiasingThreshold();

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

StepX

Attribute

StepX

Identifier

R3SPCA_StepX

JavaScript type

Integer

C type

R3INT

Description

initial sampling resolution for primary ray

Syntax

jsobj.SetStepX(value);
value = jsobj.GetStepX();

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

StepY

Attribute

StepY

Identifier

R3SPCA_StepY

JavaScript type

Integer

C type

R3INT

Description

initial sampling resolution for primary ray

Syntax

jsobj.SetStepY(value);
value = jsobj.GetStepY();

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

ScanLineDepth

Attribute

ScanLineDepth

Identifier

R3SPCA_ScanLineDepth

JavaScript type

Integer

C type

R3INT

Description

R3TYPEID, R3TID_BYTE/WORD/INTEGER/FLOAT

Syntax

jsobj.SetScanLineDepth(value);
value = jsobj.GetScanLineDepth();

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

ScanLineAccuracy

Attribute

ScanLineAccuracy

Identifier

R3SPCA_ScanLineAccuracy

JavaScript type

Number

C type

R3FLOAT

Description

R3FLOAT, 0 ... 1.0, scales the scanline rendering resolution

Syntax

jsobj.SetScanLineAccuracy(value);
value = jsobj.GetScanLineAccuracy();

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

AntiAliasingMode

Attribute

AntiAliasingMode

Identifier

R3SPCA_AntiAliasingMode

JavaScript type

Integer

C type

R3INT

Description

see aa modes below

Syntax

jsobj.SetAntiAliasingMode(value);
value = jsobj.GetAntiAliasingMode();

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

Concurrency

Attribute

Concurrency

Identifier

R3SPCA_Concurrency

JavaScript type

Integer

C type

R3INT

Description

number of threads to use for rendering

Syntax

jsobj.SetConcurrency(value);
value = jsobj.GetConcurrency();

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

RenderServers

Attribute

RenderServers

Identifier

R3SPCA_RenderServers

JavaScript type

r3List

C type

R3LIST*

Description

GET, list of server objects

Syntax

value = jsobj.GetRenderServers();

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

BoxCountX

Attribute

BoxCountX

Identifier

R3SPCA_BoxCountX

JavaScript type

Integer

C type

R3INT

Description

number of rendering boxes in x direction

Syntax

jsobj.SetBoxCountX(value);
value = jsobj.GetBoxCountX();

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

BoxCountY

Attribute

BoxCountY

Identifier

R3SPCA_BoxCountY

JavaScript type

Integer

C type

R3INT

Description

number of boxes in y direction

Syntax

jsobj.SetBoxCountY(value);
value = jsobj.GetBoxCountY();

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

UnderSamplingTreshold

Attribute

UnderSamplingTreshold

Identifier

R3SPCA_UnderSamplingTreshold

JavaScript type

Number

C type

R3FLOAT

Description

if difference between subsequent samples is higher than this value, sampling refines

Syntax

jsobj.SetUnderSamplingTreshold(value);
value = jsobj.GetUnderSamplingTreshold();

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

BoxRendering

Attribute

BoxRendering

Identifier

R3SPCA_BoxRendering

JavaScript type

Boolean

C type

R3BOOL

Description

box rendering on/off

Syntax

jsobj.SetBoxRendering(value);
value = jsobj.GetBoxRendering();

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

TraceChannels

Attribute

TraceChannels

Identifier

R3SPCA_TraceChannels

JavaScript type

r3List

C type

R3LIST*

Description

list of R3TRACECHANNEL items defined below

Syntax

value = jsobj.GetTraceChannels();

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

OutLineColor

Attribute

OutLineColor

Identifier

R3SPCA_OutLineColor

Type

r3Vect

Description

color of outlines, used if R3SPCOP_OUTLINE set

Syntax

jsobj.SetOutLineColor(value);
value = jsobj.GetOutLineColor();

R3FLOATCOLOR3 value = ...;
R3SetAttrs(r3obj, R3SPCA_OutLineColor, value, R3TAG_END);
R3FLOATCOLOR3 value;
R3GetAttrs(r3obj, R3SPCA_OutLineColor, &value, R3TAG_END);

OutLineFillColor

Attribute

OutLineFillColor

Identifier

R3SPCA_OutLineFillColor

Type

r3Vect

Description

color of outline fills, used if R3SPCOP_OUTLINE &OUTLINEFILL set

Syntax

jsobj.SetOutLineFillColor(value);
value = jsobj.GetOutLineFillColor();

R3FLOATCOLOR3 value = ...;
R3SetAttrs(r3obj, R3SPCA_OutLineFillColor, value, R3TAG_END);
R3FLOATCOLOR3 value;
R3GetAttrs(r3obj, R3SPCA_OutLineFillColor, &value, R3TAG_END);

OutLineChannelName

Attribute

OutLineChannelName

Identifier

R3SPCA_OutLineChannelName

JavaScript type

String

C type

char*

Description

name of the channel to which outlines are drawn

Syntax

jsobj.SetOutLineChannelName(value);
value = jsobj.GetOutLineChannelName();

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

DitherScale

Attribute

DitherScale

Identifier

R3SPCA_DitherScale

JavaScript type

Number

C type

R3FLOAT

Description

Syntax

jsobj.SetDitherScale(value);
value = jsobj.GetDitherScale();

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

AAChannels

Attribute

AAChannels

Identifier

R3SPCA_AAChannels

JavaScript type

r3List

C type

R3LIST*

Description

each node defines non-default aa properties for a channel

Syntax

value = jsobj.GetAAChannels();

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

RamUsePolicy

Attribute

RamUsePolicy

Identifier

R3SPCA_RamUsePolicy

JavaScript type

Integer

C type

R3INT

Description

defines ram consumption guidelines. 0=automatic, 1 = do not save, 2, 3, ... save more

Syntax

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

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

CausticsBrightness

Attribute

CausticsBrightness

Identifier

R3SPCA_CausticsBrightness

JavaScript type

Number

C type

R3FLOAT

Description

R3FLOAT>0, scales caustics map brightness

Syntax

jsobj.SetCausticsBrightness(value);
value = jsobj.GetCausticsBrightness();

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

CausticsSampling

Attribute

CausticsSampling

Identifier

R3SPCA_CausticsSampling

JavaScript type

Integer

C type

R3INT

Description

accuracy/quality of caustics

Syntax

jsobj.SetCausticsSampling(value);
value = jsobj.GetCausticsSampling();

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

AutoThread

Attribute

AutoThread

Identifier

R3SPCA_AutoThread

JavaScript type

Boolean

C type

R3BOOL

Description

determine thread count automatically based on the number of processors available

Syntax

jsobj.SetAutoThread(value);
value = jsobj.GetAutoThread();

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

Memory

Attribute

Memory

Identifier

R3SPCA_Memory

JavaScript type

Integer

C type

R3INT

Description

minimum memory requirement for rendering servers

Syntax

jsobj.SetMemory(value);
value = jsobj.GetMemory();

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

GlobalGeometryQuality

Attribute

GlobalGeometryQuality

Identifier

R3SPCA_GlobalGeometryQuality

JavaScript type

Integer

C type

R3INT

Description

geometry specific render quality. 0=default, -1=draft quality

Syntax

jsobj.SetGlobalGeometryQuality(value);
value = jsobj.GetGlobalGeometryQuality();

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

AutoDetectServers

Attribute

AutoDetectServers

Identifier

R3SPCA_AutoDetectServers

JavaScript type

Boolean

C type

R3BOOL

Description

automatically detect rendering servers

Syntax

jsobj.SetAutoDetectServers(value);
value = jsobj.GetAutoDetectServers();

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

R3SPCOP_VOLUMESHADOWS

R3SPCOP_LIGHTSOURCES

R3SPCOP_SHADOWS

R3SPCOP_VOLUMETRICLIGHTING

R3SPCOP_VOLUMETRICSAMPLING

R3SPCOP_BACKUPIMAGE

R3SPCOP_INTERPOLATE

R3SPCOP_SCANLINESHADOWS

R3SPCOP_SCANLINEREFLECTIONS

R3SPCOP_FIELDSHIFTUP

R3SPCOP_FIELDLACEUP

R3SPCOP_SAFETYAREA

R3SPCOP_OUTLINE

R3SPCOP_OUTLINEFILL

R3SPCOP_CAUSTICS

R3SPCOP_CAUSTICSAUTOBRG

R3SPCAA_GEOMETRIC

R3SPCAA_STOCHASTIC