r3frbob

Class

real/raytr/r3frbob.h

Library

r3raytr

Description:

The base class of network rendering capable objects. Defines the tag handling methods that enable remote object creation.

See Also

oops/r3root.h oops/r3altmem.h

Super Class

r3Root

R3CLID_ROOT

JavaScript

r3Frbaseobject

Class Identifier

R3CLID_FRBASEOBJECT - 761

Methods

WRITETAG, READTAG, WRITESTRINGTAG, WRITESTRING, WRITESTRINGARRAYTAG, WRITESTRINGARRAY, WRITELONGTAG, WRITELONGARRAYTAG, WRITEFLOATTAG, WRITEFLOATARRAYTAG, WRITEVECTORTAG, WRITEVECTORARRAYTAG, WRITEVECTOR4TAG, WRITEVECTOR4ARRAYTA, WRITECOLORTAG, WRITECOLORARRAYTAG, READSTRINGTAG, READSTRING, READSTRINGARRAYTAG, READSTRINGARRAY, READLONGTAG, READLONGARRAYTAG, READFLOATTAG, READFLOATARRAYTAG, READVECTORTAG, READVECTORARRAYTAG, READVECTOR4TAG, READVECTOR4ARRAYTAG, READCOLORTAG, READCOLORARRAYTAG, CHANNELLINK, READBYTEARRAYTAG, WRITEBYTEARRAYTAG, WRITEBOOLEANTAG, READBOOLEANTAG, WRITEBYTETAG, READBYTETAG, WRITEFILENAMETAG, READFILENAMETAG,

Registration

int R3RegisterFrBaseObjectClass(R3APP *app);

R3FRBOCM_WRITETAG

Method

WRITETAG

Identifier

R3FRBOCM_WRITETAG

Param 1:

R3OBJ*, pointer to a file object

Param 2:

R3TAG*, the first tag of the list (needed if current tag value depends on another tag)

Param 3:

R3TAG*, pointer to a tag.

JavaScript

obj.WRITETAG(p1, p2, p3);

Description

Writes a tag to a file.

R3FRBOCM_READTAG

Method

READTAG

Identifier

R3FRBOCM_READTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag whose tag->ident has been already read.

JavaScript

obj.READTAG(p1, p3);

Description

Reads a tag value from a file

R3FRBOCM_WRITESTRINGTAG

Method

WRITESTRINGTAG

Identifier

R3FRBOCM_WRITESTRINGTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITESTRINGTAG(p1, p3);

Description

Writes a tag whose value points to a null terminated string

R3FRBOCM_WRITESTRING

Method

WRITESTRING

Identifier

R3FRBOCM_WRITESTRING

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a string

JavaScript

obj.WRITESTRING(p1, p3);

Description

Writes a null terminated string

R3FRBOCM_WRITESTRINGARRAYTAG

Method

WRITESTRINGARRAYTAG

Identifier

R3FRBOCM_WRITESTRINGARRAYTAG

Param 1:

R3OBJ*, pointer to a file object

Param 2:

R3INT, number of strings

Param 3:

R3TAG*, pointer to a tag. tag->value is of type char**, it points to an array * of string pointers (each string should be null terminated)

JavaScript

obj.WRITESTRINGARRAYTAG(p1, p2, p3);

Description

Writes a string array tag to a file

R3FRBOCM_WRITESTRINGARRAY

Method

WRITESTRINGARRAY

Identifier

R3FRBOCM_WRITESTRINGARRAY

Param 1:

R3OBJ*, pointer to a file object

Param 2:

R3INT, number of strings

Param 3:

char**, points to an array of string pointers (each string should be null terminated)

JavaScript

obj.WRITESTRINGARRAY(p1, p2, p3);

Description

Writes a string array to a file

R3FRBOCM_WRITELONGTAG

Method

WRITELONGTAG

Identifier

R3FRBOCM_WRITELONGTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITELONGTAG(p1, p3);

Description

Writes a tag whose value is a 32 bit integer to a file.

R3FRBOCM_WRITELONGARRAYTAG

Method

WRITELONGARRAYTAG

Identifier

R3FRBOCM_WRITELONGARRAYTAG

Param 1:

R3OBJ*, pointer to a file object

Param 2:

R3INT, array size

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITELONGARRAYTAG(p1, p2, p3);

Description

Writes an integer array tag to a file.

R3FRBOCM_WRITEFLOATTAG

Method

WRITEFLOATTAG

Identifier

R3FRBOCM_WRITEFLOATTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITEFLOATTAG(p1, p3);

Description

Writes a float tag to a file.

R3FRBOCM_WRITEFLOATARRAYTAG

Method

WRITEFLOATARRAYTAG

Identifier

R3FRBOCM_WRITEFLOATARRAYTAG

Param 1:

R3OBJ*, pointer to a file object

Param 2:

R3INT, array size

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITEFLOATARRAYTAG(p1, p2, p3);

Description

Writes a float array tag to a file.

R3FRBOCM_WRITEVECTORTAG

Method

WRITEVECTORTAG

Identifier

R3FRBOCM_WRITEVECTORTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITEVECTORTAG(p1, p3);

Description

Writes a vector tag to a file.

R3FRBOCM_WRITEVECTORARRAYTAG

Method

WRITEVECTORARRAYTAG

Identifier

R3FRBOCM_WRITEVECTORARRAYTAG

Param 1:

R3OBJ*, pointer to a file object

Param 2:

R3INT, array size

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITEVECTORARRAYTAG(p1, p2, p3);

Description

Writes a vector array tag to a file.

R3FRBOCM_WRITEVECTOR4TAG

Method

WRITEVECTOR4TAG

Identifier

R3FRBOCM_WRITEVECTOR4TAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITEVECTOR4TAG(p1, p3);

Description

Writes a vector4 tag to a file.

R3FRBOCM_WRITEVECTOR4ARRAYTA

Method

WRITEVECTOR4ARRAYTA

Identifier

R3FRBOCM_WRITEVECTOR4ARRAYTA

Param 1:

R3OBJ*, pointer to a file object

Param 2:

R3INT, array size

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITEVECTOR4ARRAYTA(p1, p2, p3);

Description

Writes a vector4 array tag to a file.

R3FRBOCM_WRITECOLORTAG

Method

WRITECOLORTAG

Identifier

R3FRBOCM_WRITECOLORTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITECOLORTAG(p1, p3);

Description

Writes a R3FLOATCOLOR3 tag to a file.

R3FRBOCM_WRITECOLORARRAYTAG

Method

WRITECOLORARRAYTAG

Identifier

R3FRBOCM_WRITECOLORARRAYTAG

Param 1:

R3OBJ*, pointer to a file object

Param 2:

R3INT, array size

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITECOLORARRAYTAG(p1, p2, p3);

Description

Writes a R3FLOATCOLOR3 array tag to a file.

R3FRBOCM_READSTRINGTAG

Method

READSTRINGTAG

Identifier

R3FRBOCM_READSTRINGTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.READSTRINGTAG(p1, p3);

Description

Reads a tag whose value is a null terminated string

R3FRBOCM_READSTRING

Method

READSTRING

Identifier

R3FRBOCM_READSTRING

Param 1:

R3OBJ*, pointer to a file object

Param 3:

char**, string ptr address

JavaScript

obj.READSTRING(p1, p3);

Description

Reads a null terminated string

R3FRBOCM_READSTRINGARRAYTAG

Method

READSTRINGARRAYTAG

Identifier

R3FRBOCM_READSTRINGARRAYTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.READSTRINGARRAYTAG(p1, p3);

Description

Reads a tag whose value is an array of null terminated strings * written by R3FRBOCM_WRITESTRINGARRAYTAG.

R3FRBOCM_READSTRINGARRAY

Method

READSTRINGARRAY

Identifier

R3FRBOCM_READSTRINGARRAY

Param 1:

R3OBJ*, pointer to a file object

JavaScript

obj.READSTRINGARRAY(p1, 0);

Description

Reads an array of null terminated strings (written by R3FRBOCM_WRITESTRINGARRAY).

R3FRBOCM_READLONGTAG

Method

READLONGTAG

Identifier

R3FRBOCM_READLONGTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag.

JavaScript

obj.READLONGTAG(p1, p3);

Description

Reads a tag whose value is a 32 bit integer from a file.

R3FRBOCM_READLONGARRAYTAG

Method

READLONGARRAYTAG

Identifier

R3FRBOCM_READLONGARRAYTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.READLONGARRAYTAG(p1, p3);

Description

Reads an integer array tag from a file.

R3FRBOCM_READFLOATTAG

Method

READFLOATTAG

Identifier

R3FRBOCM_READFLOATTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.READFLOATTAG(p1, p3);

Description

Reads a float tag from a file.

R3FRBOCM_READFLOATARRAYTAG

Method

READFLOATARRAYTAG

Identifier

R3FRBOCM_READFLOATARRAYTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.READFLOATARRAYTAG(p1, p3);

Description

Reads a float array tag from a file.

R3FRBOCM_READVECTORTAG

Method

READVECTORTAG

Identifier

R3FRBOCM_READVECTORTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.READVECTORTAG(p1, p3);

Description

Reads a vector tag from a file.

R3FRBOCM_READVECTORARRAYTAG

Method

READVECTORARRAYTAG

Identifier

R3FRBOCM_READVECTORARRAYTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.READVECTORARRAYTAG(p1, p3);

Description

Reads a vector array tag from a file.

R3FRBOCM_READVECTOR4TAG

Method

READVECTOR4TAG

Identifier

R3FRBOCM_READVECTOR4TAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.READVECTOR4TAG(p1, p3);

Description

Reads a vector4 tag from a file.

R3FRBOCM_READVECTOR4ARRAYTAG

Method

READVECTOR4ARRAYTAG

Identifier

R3FRBOCM_READVECTOR4ARRAYTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.READVECTOR4ARRAYTAG(p1, p3);

Description

Reads a vector4 array tag from a file.

R3FRBOCM_READCOLORTAG

Method

READCOLORTAG

Identifier

R3FRBOCM_READCOLORTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.READCOLORTAG(p1, p3);

Description

Reads a R3FLOATCOLOR3 tag from a file.

R3FRBOCM_READCOLORARRAYTAG

Method

READCOLORARRAYTAG

Identifier

R3FRBOCM_READCOLORARRAYTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.READCOLORARRAYTAG(p1, p3);

Description

Reads a R3FLOATCOLOR3 array tag from a file.

R3FRBOM_CHANNELLINK

Method

CHANNELLINK

Identifier

R3FRBOM_CHANNELLINK

Param 3:

R3OBJ*, raysample object that contains all channels.

JavaScript

obj.CHANNELLINK(p3);

Description

signals that dynamic channel configuration is ready. * Objects thst support dynamic channels may use the given raysample * object to convert name references to faster channel offsets.

R3FRBOCM_READBYTEARRAYTAG

Method

READBYTEARRAYTAG

Identifier

R3FRBOCM_READBYTEARRAYTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.READBYTEARRAYTAG(p1, p3);

Description

Reads R3BYTE (8 bit entity) array tag from a file.

R3FRBOCM_WRITEBYTEARRAYTAG

Method

WRITEBYTEARRAYTAG

Identifier

R3FRBOCM_WRITEBYTEARRAYTAG

Param 1:

R3OBJ*, pointer to a file object

Param 2:

R3INT, array size

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITEBYTEARRAYTAG(p1, p2, p3);

Description

Writes a byte array tag to a file.

R3FRBOCM_WRITEBOOLEANTAG

Method

WRITEBOOLEANTAG

Identifier

R3FRBOCM_WRITEBOOLEANTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITEBOOLEANTAG(p1, p3);

Description

Writes a boolean tag to a file as a single byte

R3FRBOCM_READBOOLEANTAG

Method

READBOOLEANTAG

Identifier

R3FRBOCM_READBOOLEANTAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag.

JavaScript

obj.READBOOLEANTAG(p1, p3);

Description

Reads a boolean tag

R3FRBOCM_WRITEBYTETAG

Method

WRITEBYTETAG

Identifier

R3FRBOCM_WRITEBYTETAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITEBYTETAG(p1, p3);

Description

Writes an 8 bit integer to a file

R3FRBOCM_READBYTETAG

Method

READBYTETAG

Identifier

R3FRBOCM_READBYTETAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag.

JavaScript

obj.READBYTETAG(p1, p3);

Description

Reads a 8 bit integer tag

R3FRBOCM_WRITEFILENAMETAG

Method

WRITEFILENAMETAG

Identifier

R3FRBOCM_WRITEFILENAMETAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag

JavaScript

obj.WRITEFILENAMETAG(p1, p3);

Description

Writes a tag whose value points to a null terminated file path

R3FRBOCM_READFILENAMETAG

Method

READFILENAMETAG

Identifier

R3FRBOCM_READFILENAMETAG

Param 1:

R3OBJ*, pointer to a file object

Param 3:

R3TAG*, pointer to a tag.

JavaScript

obj.READFILENAMETAG(p1, p3);

Description

Reads a value of a null terminated file path * rc: NULL if fails