r3rmanag

r3rmanag

Class

real/code2/r3rmanag.h

Library

r3code2

Description:

Rendering Manager. Takes care of motion blur, field rendering and box rendering.

See Also

oops/r3root.h

Super Class

r3Root

R3CLID_ROOT

JavaScript

r3Rmanager

Class Identifier

R3CLID_RMANAGER - 630

Methods

CANCEL, COLLECTUSEDMATERIAL, ADDPOSTCHANNEL, SHOWBACKUP, RENDERCAUSTICS, POSTPROCESS, PREPARERENDER, SETSTATHOOK,

Attributes

Renderer, DrawLayer, Materials, ImageEffects, ParticleEffects, ChannelLayer, Camera, RSpec, EffectName, Animator, ResolX, ResolY, DisableComposition, ReportWhenDoneObject, ReportWhenDoneMth, Resume, ProjectString, ReportWhenCanceledMt, IgnoreMissingTexture, CheckActiveMaterials, BackupName, PostProcFile, ImageEffect, FieldEffect, FrameEffect, CameraTreatment, BoxOrder, UniqueBackupName,

Registration

int R3RegisterRenderManagerClass(R3APP *app);

R3RMNGM_CANCEL

Method

CANCEL

Identifier

R3RMNGM_CANCEL

JavaScript

obj.CANCEL();

Description

R3RMNGCM_COLLECTUSEDMATERIAL

Method

COLLECTUSEDMATERIAL

Identifier

R3RMNGCM_COLLECTUSEDMATERIAL

Param 1:

R3LIST, address of an initialised list header. Names are added to this list using allocated R3NODE structures. Caller must free the nodes after use.

Param 2:

R3OBJ*, address of geometry object layer determining material use

Param 3:

R3OBJ*, address of material layer *

JavaScript

obj.COLLECTUSEDMATERIAL(p1, p2, p3);

Description

Class method which collects material names of active materials.

R3RMNG_ADDPOSTCHANNEL

Method

ADDPOSTCHANNEL

Identifier

R3RMNG_ADDPOSTCHANNEL

JavaScript

obj.ADDPOSTCHANNEL();

Description

R3RMNGM_SHOWBACKUP

Method

SHOWBACKUP

Identifier

R3RMNGM_SHOWBACKUP

JavaScript

obj.SHOWBACKUP();

Description

R3RMNGM_RENDERCAUSTICS

Method

RENDERCAUSTICS

Identifier

R3RMNGM_RENDERCAUSTICS

Param 1:

R3INT, combination of R3RMUF_ flags defined below

Param 2:

R3TAG*, additional tags for PRIMM_RENDER which is executed as a part of preparations

Param 3:

R3TAG*, future extension tags

JavaScript

obj.RENDERCAUSTICS(p1, p2, p3);

Description

Render caustics maps only

R3RMNGM_POSTPROCESS

Method

POSTPROCESS

Identifier

R3RMNGM_POSTPROCESS

Param 1:

R3INT, combination of R3RMUF_ flags defined below

Param 2:

R3TAG*, additional tags for PRIMM_RENDER which is executed as a part of preparations

Param 3:

R3TAG*, future extension tags

JavaScript

obj.POSTPROCESS(p1, p2, p3);

Description

Post process only

R3RMNGM_PREPARERENDER

Method

PREPARERENDER

Identifier

R3RMNGM_PREPARERENDER

Param 1:

R3INT, combination of R3RMUF_ flags defined below

Param 2:

R3TAG*, additional tags for PRIMM_RENDER which is executed as a part of preparations

Param 3:

R3TAG*, future extension tags

JavaScript

obj.PREPARERENDER(p1, p2, p3);

Description

Prepare everything for rendering but don't render yet.

R3RMNGM_SETSTATHOOK

Method

SETSTATHOOK

Identifier

R3RMNGM_SETSTATHOOK

Return

R3BOOL, true if found

Param 1:

R3OBJ*, callback object

Param 3:

R3INT, callback method

JavaScript

rc = obj.SETSTATHOOK(p1, p3);

Description

Set callback for reporting server statistics

Renderer

Attribute

Renderer

Identifier

R3RMNGA_Renderer

JavaScript type

Integer

C type

int

Description

renderer

Syntax


jsobj.SetRenderer(value);
value = jsobj.GetRenderer();


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

DrawLayer

Attribute

DrawLayer

Identifier

R3RMNGA_DrawLayer

JavaScript type

Integer

C type

int

Description

'R3RMNGA_DrawLayer' not documented

Syntax


jsobj.SetDrawLayer(value);
value = jsobj.GetDrawLayer();


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

Materials

Attribute

Materials

Identifier

R3RMNGA_Materials

JavaScript type

Integer

C type

int

Description

'R3RMNGA_Materials' not documented

Syntax


jsobj.SetMaterials(value);
value = jsobj.GetMaterials();


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

ImageEffects

Attribute

ImageEffects

Identifier

R3RMNGA_ImageEffects

JavaScript type

Integer

C type

int

Description

'R3RMNGA_ImageEffects' not documented

Syntax


jsobj.SetImageEffects(value);
value = jsobj.GetImageEffects();


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

ParticleEffects

Attribute

ParticleEffects

Identifier

R3RMNGA_ParticleEffects

JavaScript type

Integer

C type

int

Description

'R3RMNGA_ParticleEffects' not documented

Syntax


jsobj.SetParticleEffects(value);
value = jsobj.GetParticleEffects();


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

ChannelLayer

Attribute

ChannelLayer

Identifier

R3RMNGA_ChannelLayer

JavaScript type

Integer

C type

int

Description

'R3RMNGA_ChannelLayer' not documented

Syntax


jsobj.SetChannelLayer(value);
value = jsobj.GetChannelLayer();


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

Camera

Attribute

Camera

Identifier

R3RMNGA_Camera

JavaScript type

Integer

C type

int

Description

'R3RMNGA_Camera' not documented

Syntax


jsobj.SetCamera(value);
value = jsobj.GetCamera();


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

RSpec

Attribute

RSpec

Identifier

R3RMNGA_RSpec

JavaScript type

Integer

C type

int

Description

'R3RMNGA_RSpec' not documented

Syntax


jsobj.SetRSpec(value);
value = jsobj.GetRSpec();


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

EffectName

Attribute

EffectName

Identifier

R3RMNGA_EffectName

JavaScript type

Integer

C type

int

Description

name of render box post processing config

Syntax


jsobj.SetEffectName(value);
value = jsobj.GetEffectName();


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

Animator

Attribute

Animator

Identifier

R3RMNGA_Animator

JavaScript type

Integer

C type

int

Description

'R3RMNGA_Animator' not documented

Syntax


jsobj.SetAnimator(value);
value = jsobj.GetAnimator();


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

ResolX

Attribute

ResolX

Identifier

R3RMNGA_ResolX

JavaScript type

Integer

C type

int

Description

'R3RMNGA_ResolX' not documented

Syntax


jsobj.SetResolX(value);
value = jsobj.GetResolX();


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

ResolY

Attribute

ResolY

Identifier

R3RMNGA_ResolY

JavaScript type

Integer

C type

int

Description

'R3RMNGA_ResolY' not documented

Syntax


jsobj.SetResolY(value);
value = jsobj.GetResolY();


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

DisableComposition

Attribute

DisableComposition

Identifier

R3RMNGA_DisableComposition

JavaScript type

Integer

C type

int

Description

'R3RMNGA_DisableComposition' not documented

Syntax


jsobj.SetDisableComposition(value);
value = jsobj.GetDisableComposition();


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

ReportWhenDoneObject

Attribute

ReportWhenDoneObject

Identifier

R3RMNGA_ReportWhenDoneObject

JavaScript type

Integer

C type

int

Description

'R3RMNGA_ReportWhenDoneObject' not documented

Syntax


jsobj.SetReportWhenDoneObject(value);
value = jsobj.GetReportWhenDoneObject();


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

ReportWhenDoneMth

Attribute

ReportWhenDoneMth

Identifier

R3RMNGA_ReportWhenDoneMth

JavaScript type

Integer

C type

int

Description

'R3RMNGA_ReportWhenDoneMth' not documented

Syntax


jsobj.SetReportWhenDoneMth(value);
value = jsobj.GetReportWhenDoneMth();


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

Resume

Attribute

Resume

Identifier

R3RMNGA_Resume

JavaScript type

Boolean

C type

R3BOOL

Description

continue from current box

Syntax


jsobj.SetResume(value);


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

ProjectString

Attribute

ProjectString

Identifier

R3RMNGA_ProjectString

JavaScript type

String

C type

char*

Description

project specific name to make temp files unique

Syntax


jsobj.SetProjectString(value);
value = jsobj.GetProjectString();


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

ReportWhenCanceledMt

Attribute

ReportWhenCanceledMt

Identifier

R3RMNGA_ReportWhenCanceledMt

JavaScript type

Integer

C type

R3INT

Description

cancel method

Syntax


jsobj.SetReportWhenCanceledMt(value);


R3INT value = ...;
R3SetAttrs(r3obj, R3RMNGA_ReportWhenCanceledMth, value, R3TAG_END);

IgnoreMissingTexture

Attribute

IgnoreMissingTexture

Identifier

R3RMNGA_IgnoreMissingTexture

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetIgnoreMissingTexture(value);


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

CheckActiveMaterials

Attribute

CheckActiveMaterials

Identifier

R3RMNGA_CheckActiveMaterials

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetCheckActiveMaterials(value);


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

BackupName

Attribute

BackupName

Identifier

R3RMNGA_BackupName

JavaScript type

String

C type

char*

Description

name of the raytarce backup image - read only

Syntax


value = jsobj.GetBackupName();


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

PostProcFile

Attribute

PostProcFile

Identifier

R3RMNGA_PostProcFile

JavaScript type

String

C type

char*

Description

name of a file for post processing

Syntax


jsobj.SetPostProcFile(value);


char* value = ...;
R3SetAttrs(r3obj, R3RMNGA_PostProcFile, value, R3TAG_END);

ImageEffect

Attribute

ImageEffect

Identifier

R3RMNGA_ImageEffect

JavaScript type

String

C type

char*

Description

name of full image post processing config

Syntax


jsobj.SetImageEffect(value);


char* value = ...;
R3SetAttrs(r3obj, R3RMNGA_ImageEffect, value, R3TAG_END);

FieldEffect

Attribute

FieldEffect

Identifier

R3RMNGA_FieldEffect

JavaScript type

String

C type

char*

Description

name of post processing config for field processing

Syntax


jsobj.SetFieldEffect(value);


char* value = ...;
R3SetAttrs(r3obj, R3RMNGA_FieldEffect, value, R3TAG_END);

FrameEffect

Attribute

FrameEffect

Identifier

R3RMNGA_FrameEffect

JavaScript type

String

C type

char*

Description

name of post processing config for frame processing

Syntax


jsobj.SetFrameEffect(value);


char* value = ...;
R3SetAttrs(r3obj, R3RMNGA_FrameEffect, value, R3TAG_END);

CameraTreatment

Attribute

CameraTreatment

Identifier

R3RMNGA_CameraTreatment

JavaScript type

Integer

C type

R3INT

Description

Camera treatment, see defs below

Syntax


jsobj.SetCameraTreatment(value);
value = jsobj.GetCameraTreatment();


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

BoxOrder

Attribute

BoxOrder

Identifier

R3RMNGA_BoxOrder

JavaScript type

Integer

C type

R3INT

Description

box rendering order, as defined in r3fremp.h

Syntax


jsobj.SetBoxOrder(value);
value = jsobj.GetBoxOrder();


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

UniqueBackupName

Attribute

UniqueBackupName

Identifier

R3RMNGA_UniqueBackupName

JavaScript type

Boolean

C type

R3BOOL

Description

rename the rt backup buffer uniquely using project details.

Syntax


jsobj.SetUniqueBackupName(value);
value = jsobj.GetUniqueBackupName();


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

Flags specifying what to render - use 0xFFFF to render everything

/

R3RMUF_WORLD
R3RMUF_LIBS
R3RMUF_CAMERA

Codes for camera treatment. Use R3RMCAM_DONTDEFINE to avoid render space transfromations

R3RMCAM_UNDEFINED
R3RMAM_DEFINED
R3RMCAM_DONTDEFINE

Tags

Tags

R3RMNGA_BackupRT
R3RMNGA_KeepRenderData