r3frserv

Class

real/raytr/r3frserv.h

Library

r3raytr

Description:

TCP/IP network rendering 'server'.

See Also

real/raytr/r3frbase.h

Super Class

r3Root

R3CLID_ROOT

JavaScript

r3Frserver

Class Identifier

R3CLID_FRSERVER - 760

Methods

RUN, SPECOUTPUT, SETTEXTUREPATHS, CLIENTNAME, CHANNELCALLBACK, REFRESHIMAGE, RESETSTATISTICS,

Attributes

RenderPort, RenderEngineType, RenderEngine, TextureImport, CurrentBoxId, TotalSecs, RenderSecs, IdleSecs, SceneSecs, TextureSecs, PostprocSecs, CausticsSecs, RenderReqs, CancelReqs, FailReqs,

R3FRSERVM_RUN

Method

RUN

Identifier

R3FRSERVM_RUN

JavaScript

obj.RUN();

Description

Start socket stream parsing

R3FRSERVM_SPECOUTPUT

Method

SPECOUTPUT

Identifier

R3FRSERVM_SPECOUTPUT

Param 3:

R3LIST, list of outputted channels. Each node is of type R3RAYNODE, see r3output.h.

JavaScript

obj.SPECOUTPUT(p3);

Description

Define the image output to the socket. This method can be sent to the server * directly or through socket interface. Previous output specifications are replaced with * the new one.

R3FRSERVM_SETTEXTUREPATHS

Method

SETTEXTUREPATHS

Identifier

R3FRSERVM_SETTEXTUREPATHS

JavaScript

obj.SETTEXTUREPATHS();

Description

R3FRSERVM_CLIENTNAME

Method

CLIENTNAME

Identifier

R3FRSERVM_CLIENTNAME

Param 3:

char*, name of the client

JavaScript

obj.CLIENTNAME(p3);

Description

Set client name

R3FRSERVM_CHANNELCALLBACK

Method

CHANNELCALLBACK

Identifier

R3FRSERVM_CHANNELCALLBACK

JavaScript

obj.CHANNELCALLBACK();

Description

R3FRSERVM_REFRESHIMAGE

Method

REFRESHIMAGE

Identifier

R3FRSERVM_REFRESHIMAGE

JavaScript

obj.REFRESHIMAGE();

Description

R3FRSERVM_RESETSTATISTICS

Method

RESETSTATISTICS

Identifier

R3FRSERVM_RESETSTATISTICS

JavaScript

obj.RESETSTATISTICS();

Description

RenderPort

Attribute

RenderPort

Identifier

R3FRSERVA_RenderPort

JavaScript type

Integer

C type

R3INT

Description

TCP/IP port number

Syntax

jsobj.SetRenderPort(value);

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

RenderEngineType

Attribute

RenderEngineType

Identifier

R3FRSERVA_RenderEngineType

JavaScript type

Integer

C type

R3CLID

Description

class id of the render engine to be used. Default is R3CLID_FRENGINE, but another class can be defined at RM_CREATE method.

Syntax

jsobj.SetRenderEngineType(value);

R3CLID value = ...;
R3SetAttrs(r3obj, R3FRSERVA_RenderEngineType, value, R3TAG_END);

RenderEngine

Attribute

RenderEngine

Identifier

R3FRSERVA_RenderEngine

JavaScript type

Object

C type

R3OBJ*

Description

R3OBJ, read only, address of the created actual render engine

Syntax

value = jsobj.GetRenderEngine();

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

TextureImport

Attribute

TextureImport

Identifier

R3FRSERVA_TextureImport

JavaScript type

Boolean

C type

R3BOOL

Description

creation attribute - if TRUE, textures are copied to local system

Syntax

jsobj.SetTextureImport(value);

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

CurrentBoxId

Attribute

CurrentBoxId

Identifier

R3FRSERVA_CurrentBoxId

JavaScript type

Integer

C type

R3INT

Description

the render box identifier in the current render job (read only)

Syntax

value = jsobj.GetCurrentBoxId();

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

TotalSecs

Attribute

TotalSecs

Identifier

R3FRSERVA_TotalSecs

JavaScript type

Integer

C type

R3INT

Description

statistics, total seconds spent doing something

Syntax

value = jsobj.GetTotalSecs();

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

RenderSecs

Attribute

RenderSecs

Identifier

R3FRSERVA_RenderSecs

JavaScript type

Integer

C type

R3INT

Description

seconds spent in rendering

Syntax

value = jsobj.GetRenderSecs();

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

IdleSecs

Attribute

IdleSecs

Identifier

R3FRSERVA_IdleSecs

JavaScript type

Integer

C type

R3INT

Description

waiting commands

Syntax

value = jsobj.GetIdleSecs();

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

SceneSecs

Attribute

SceneSecs

Identifier

R3FRSERVA_SceneSecs

JavaScript type

Integer

C type

R3INT

Description

scene transmission time

Syntax

value = jsobj.GetSceneSecs();

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

TextureSecs

Attribute

TextureSecs

Identifier

R3FRSERVA_TextureSecs

JavaScript type

Integer

C type

R3INT

Description

texture transmission time

Syntax

value = jsobj.GetTextureSecs();

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

PostprocSecs

Attribute

PostprocSecs

Identifier

R3FRSERVA_PostprocSecs

JavaScript type

Integer

C type

R3INT

Description

post processing time

Syntax

value = jsobj.GetPostprocSecs();

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

CausticsSecs

Attribute

CausticsSecs

Identifier

R3FRSERVA_CausticsSecs

JavaScript type

Integer

C type

R3INT

Description

caustics rendering time

Syntax

value = jsobj.GetCausticsSecs();

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

RenderReqs

Attribute

RenderReqs

Identifier

R3FRSERVA_RenderReqs

JavaScript type

Integer

C type

R3INT

Description

succeeded requests

Syntax

value = jsobj.GetRenderReqs();

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

CancelReqs

Attribute

CancelReqs

Identifier

R3FRSERVA_CancelReqs

JavaScript type

Integer

C type

R3INT

Description

canceled requests

Syntax

value = jsobj.GetCancelReqs();

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

FailReqs

Attribute

FailReqs

Identifier

R3FRSERVA_FailReqs

JavaScript type

Integer

C type

R3INT

Description

failed requests

Syntax

value = jsobj.GetFailReqs();

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