r3output

Class

real/frio/r3output.h

Library

r3frio

Description:

Output Class. A output object connects a (image) datatype and the channel system.

See Also

oops/r3model.h

Super Class

r3Model

R3CLID_MODEL

JavaScript

r3Output

Class Identifier

R3CLID_OUTPUT - 548

Methods

SELECTCHANNEL, SELECTCHANNELBYNAME, ENUMCHANNELS, BEGIN, END, EXPANDCOMMAND, ADDRAYCHANNEL, ADDIMAGECHANNEL, ADDBINDING, REMOVEBINDING, BINDRAYCHANNEL, BINDRAYSUBCHANNEL, CLEARBINDINGS, MAKEDEFAULTBINDINGS, UPDATEBINDINGS, BUFFERFULL, COPYLINE, QUERYCHANNEL, CREATERAWIMAGE, COPYTORAWIMAGE, REGISTERIMAGEFORMAT, CHANNELIDENTITYBINDI, CHANNELLISTIDENTITYB, FREERAYNODELIST, READLINE, FINDSETTINGCLASS, UPDATEBINDINGSBYIMAG, FINDBINDING, EXECCOMMAND, SELECTRAYCHANNEL, READCHANNEL, WRITECHANNEL,

Attributes

Path, Width, Height, BoxSupport, TotalWidth, TotalHeight, OffsetX, OffsetY, OutputObject, Extension, Command, LanguageId, IsFinal, ClipX, ClipY, SubNames, SubCount, ChannelId, StorageType, RayChannelList, ImgChannelList, BindingList, Direction, DontCopy, IOReady, KeepOutputObject, BaseX, BaseY, NormValue, Signed, DisableCommand, IOPerChannel,

Registration

int R3RegisterOutputClass(R3APP *app);

R3OUTPM_SELECTCHANNEL

Method

SELECTCHANNEL

Identifier

R3OUTPM_SELECTCHANNEL

Param 3:

R3INT, format specific channel identifier

JavaScript

obj.SELECTCHANNEL(p3);

Description

Selects a channel (used by objects that support multiple channels). * The selected channel is used by read/write operations. Channel is defined by * an integer.

R3OUTPM_SELECTCHANNELBYNAME

Method

SELECTCHANNELBYNAME

Identifier

R3OUTPM_SELECTCHANNELBYNAME

Param 3:

char*, name of channel

JavaScript

obj.SELECTCHANNELBYNAME(p3);

Description

Selects a given image channel by its name in the attached datatype object. * Datatype IO methods require channel selection and this method provides fast channel name based * solution. Channel names are mapped to quicker identifiers in R3OUTPM_BEGIN method.

R3OUTPM_ENUMCHANNELS

Method

ENUMCHANNELS

Identifier

R3OUTPM_ENUMCHANNELS

Param 1:

R3OBJ*, object to be called

Param 2:

void*, optional context defined by caller and passed back as R3OUTPA_EnumContext tag

Param 3:

R3INT, method to be called

JavaScript

obj.ENUMCHANNELS(p1, p2, p3);

Description

Enumerates the channels included in the object by sending * R3SendMsg3(p1=callobj, p3=callbackmth, storagetype, name, * R3OUTPA_SubNames, sub_names, * R3OUTPA_SubCount, sub_count, * R3OUTPA_NormValue, normvalue, * R3OUTPA_Signed, signed, R3OUTPA_EnumContext, callback_context, * R3TAG_END);

R3OUTPM_BEGIN

Method

BEGIN

Identifier

R3OUTPM_BEGIN

Param 3:

R3OBJ*, raysample object that defines dynamic channel configuration (raysamples that are * used for IO operations such as R3OUTPM_BUFFERFULL must have same channel cofingurations as this). * If NULL then bindings to dynamic channels will be unoperational.

JavaScript

obj.BEGIN(p3);

Description

Begins IO operations. Resources are allocated and the object gets ready * for image data read/write usage.

R3OUTPM_END

Method

END

Identifier

R3OUTPM_END

Return

R3BOOL, TRUE

JavaScript

rc = obj.END();

Description

Ends IO operations. Depending on the object type, object may not be * readable/writeable after this.

R3OUTPM_EXPANDCOMMAND

Method

EXPANDCOMMAND

Identifier

R3OUTPM_EXPANDCOMMAND

Param 1:

char*, template (such as showimg -file [file])

Param 3:

char*, the actual expanded command (such as showimg -file myanim.bmp)

JavaScript

obj.EXPANDCOMMAND(p1, p3);

Description

Expand the frame command macros [file], [path], [base] and [ext].

R3OUTPM_ADDRAYCHANNEL

Method

ADDRAYCHANNEL

Identifier

R3OUTPM_ADDRAYCHANNEL

JavaScript

obj.ADDRAYCHANNEL();

Description

Used internally to build up the system channel list

R3OUTPM_ADDIMAGECHANNEL

Method

ADDIMAGECHANNEL

Identifier

R3OUTPM_ADDIMAGECHANNEL

JavaScript

obj.ADDIMAGECHANNEL();

Description

Used internally to build up the image channel list

R3OUTPM_ADDBINDING

Method

ADDBINDING

Identifier

R3OUTPM_ADDBINDING

Param 1:

char*, ray channel name

Param 2:

char*, image channel name

JavaScript

obj.ADDBINDING(p1, p2, 0);

Description

Adds a channel binding. Bindings define how data is moved between ray and image channels * and their sub channels.

R3OUTPM_REMOVEBINDING

Method

REMOVEBINDING

Identifier

R3OUTPM_REMOVEBINDING

Param 1:

char*, ray channel name

Param 2:

char*, image channel name

JavaScript

obj.REMOVEBINDING(p1, p2, 0);

Description

Removes one binding definition

R3OUTPM_BINDRAYCHANNEL

Method

BINDRAYCHANNEL

Identifier

R3OUTPM_BINDRAYCHANNEL

Param 1:

R3INT, channel clid

JavaScript

obj.BINDRAYCHANNEL(p1, 0);

Description

Binds a ray channel (all sub channels) to the closest matching image channel. Note: Output object must have the image datatype associated when using this method.

R3OUTPM_BINDRAYSUBCHANNEL

Method

BINDRAYSUBCHANNEL

Identifier

R3OUTPM_BINDRAYSUBCHANNEL

Param 1:

R3INT, ray channel clid

Param 2:

char*, sub channel name

JavaScript

obj.BINDRAYSUBCHANNEL(p1, p2, 0);

Description

Binds one ray sub channel to the closest matching image channel.

R3OUTPM_CLEARBINDINGS

Method

CLEARBINDINGS

Identifier

R3OUTPM_CLEARBINDINGS

JavaScript

obj.CLEARBINDINGS();

Description

R3OUTPM_MAKEDEFAULTBINDINGS

Method

MAKEDEFAULTBINDINGS

Identifier

R3OUTPM_MAKEDEFAULTBINDINGS

JavaScript

obj.MAKEDEFAULTBINDINGS();

Description

R3OUTPM_UPDATEBINDINGS

Method

UPDATEBINDINGS

Identifier

R3OUTPM_UPDATEBINDINGS

JavaScript

obj.UPDATEBINDINGS();

Description

R3OUTPM_BUFFERFULL

Method

BUFFERFULL

Identifier

R3OUTPM_BUFFERFULL

Param 1:

R3INT, 'y' index of the destination line

JavaScript

obj.BUFFERFULL(p1, 0);

Description

Copies a line of image data to the image from a R3CLID_RAYSAMPLE object.

R3OUTPM_COPYLINE

Method

COPYLINE

Identifier

R3OUTPM_COPYLINE

Param 1:

R3INT, 'y' index of the source line

Param 2:

R3INT, 'y' index of the destination line

JavaScript

obj.COPYLINE(p1, p2, 0);

Description

Copies a line of image data to the output image from a given source raw image.

R3OUTPM_QUERYCHANNEL

Method

QUERYCHANNEL

Identifier

R3OUTPM_QUERYCHANNEL

Param 3:

char*, name of channel

JavaScript

obj.QUERYCHANNEL(p3);

Description

Checks if the given channel is included in the image channels

R3OUTPCM_CREATERAWIMAGE

Method

CREATERAWIMAGE

Identifier

R3OUTPCM_CREATERAWIMAGE

JavaScript

obj.CREATERAWIMAGE();

Description

R3OUTPCM_COPYTORAWIMAGE

Method

COPYTORAWIMAGE

Identifier

R3OUTPCM_COPYTORAWIMAGE

Return

R3OBJ*, NULL if fails.

Param 2:

void*, data for the progress callback

Param 3:

R3OBJ*, image to be converted

JavaScript

rc = obj.COPYTORAWIMAGE(0, p2, p3);

Description

Class method. Create a ram based (r3rawim) image from the given image.

R3OUTPCM_REGISTERIMAGEFORMAT

Method

REGISTERIMAGEFORMAT

Identifier

R3OUTPCM_REGISTERIMAGEFORMAT

JavaScript

obj.REGISTERIMAGEFORMAT();

Description

R3OUTPM_CHANNELIDENTITYBINDI

Method

CHANNELIDENTITYBINDI

Identifier

R3OUTPM_CHANNELIDENTITYBINDI

Param 1:

R3INT, channel clid

JavaScript

obj.CHANNELIDENTITYBINDI(p1, 0);

Description

Adds identity bindings for all sub channels of one channel. The existence of the image channel is not checked. For example, Color->Red is always bind to Color->Red.

R3OUTPM_CHANNELLISTIDENTITYB

Method

CHANNELLISTIDENTITYB

Identifier

R3OUTPM_CHANNELLISTIDENTITYB

Param 1:

R3INT, channel clid

JavaScript

obj.CHANNELLISTIDENTITYB(p1, 0);

Description

Like the previous method, but processes a list of R3RAYNODEs. Already existing bindings are not removed.

R3OUTPCM_FREERAYNODELIST

Method

FREERAYNODELIST

Identifier

R3OUTPCM_FREERAYNODELIST

Param 3:

R3LIST, a list of R3RAYNODEs (see definition below)

JavaScript

obj.FREERAYNODELIST(p3);

Description

Deallocates the list allocated by R3OUTPCM_COLLECTOUTPUTTEDRAYCHANNELSFROMLIST

R3OUTPM_READLINE

Method

READLINE

Identifier

R3OUTPM_READLINE

Param 1:

R3INT, 'y' index of the source line

Param 2:

R3INT, 'y' index of the destination line

JavaScript

obj.READLINE(p1, p2, 0);

Description

Copies a line of image data to a given raw image from the output source

R3OUTPCM_FINDSETTINGCLASS

Method

FINDSETTINGCLASS

Identifier

R3OUTPCM_FINDSETTINGCLASS

JavaScript

obj.FINDSETTINGCLASS();

Description

R3OUTPM_UPDATEBINDINGSBYIMAG

Method

UPDATEBINDINGSBYIMAG

Identifier

R3OUTPM_UPDATEBINDINGSBYIMAG

JavaScript

obj.UPDATEBINDINGSBYIMAG();

Description

R3OUTPM_FINDBINDING

Method

FINDBINDING

Identifier

R3OUTPM_FINDBINDING

Param 1:

char*, ray channel name or NULL if it does not matter

Param 2:

char*, image channel name or NULL if it does not matter

Param 3:

R3TAG*, a tag list where R3OUTPA_RaySubChannelName and R3OUTPA_RaySubChannelName either define * a particular sub channel or are NULL. *

JavaScript

obj.FINDBINDING(p1, p2, p3);

Description

Tries finding a specified channel binding.

R3OUTPM_EXECCOMMAND

Method

EXECCOMMAND

Identifier

R3OUTPM_EXECCOMMAND

JavaScript

obj.EXECCOMMAND();

Description

Execute the frame command

R3OUTPM_SELECTRAYCHANNEL

Method

SELECTRAYCHANNEL

Identifier

R3OUTPM_SELECTRAYCHANNEL

Param 3:

char*, name of the channel (using Realsoft3D side of chanel binding, not image type specific)

JavaScript

obj.SELECTRAYCHANNEL(p3);

Description

Selects a channel for channelwise IO (see R3OUTPM_READ/WRITECHANNEL below)

R3OUTPM_READCHANNEL

Method

READCHANNEL

Identifier

R3OUTPM_READCHANNEL

Param 1:

R3INT, 'y' index of the source line

Param 2:

void*, buffer to which data is read

Param 3:

R3TAG*, R3OUTPA_Width, R3OUTPA_SubCount, R3OUTPA_Signed, R3OUTPA_NormValue, R3OUTPA_StorageType for the data

JavaScript

obj.READCHANNEL(p1, p2, p3);

Description

Reads a line of channel data to a given buffer

R3OUTPM_WRITECHANNEL

Method

WRITECHANNEL

Identifier

R3OUTPM_WRITECHANNEL

Param 1:

R3INT, 'y' index of the source line

Param 2:

char*, buffer of write data

Param 3:

R3TAG*, R3OUTPA_Width, R3OUTPA_SubCount, R3OUTPA_Signed, R3OUTPA_NormValue, R3OUTPA_StorageType for the data

JavaScript

obj.WRITECHANNEL(p1, p2, p3);

Description

Copies a line of image data to the output object from a given source buffer

Path

Attribute

Path

Identifier

R3OUTPA_Path

JavaScript type

String

C type

char*

Description

file name

Syntax

jsobj.SetPath(value);
value = jsobj.GetPath();

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

Width

Attribute

Width

Identifier

R3OUTPA_Width

JavaScript type

Integer

C type

R3INT

Description

width of the image

Syntax

jsobj.SetWidth(value);
value = jsobj.GetWidth();

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

Height

Attribute

Height

Identifier

R3OUTPA_Height

JavaScript type

Integer

C type

R3INT

Description

height

Syntax

jsobj.SetHeight(value);
value = jsobj.GetHeight();

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

BoxSupport

Attribute

BoxSupport

Identifier

R3OUTPA_BoxSupport

JavaScript type

Boolean

C type

R3BOOL

Description

TRUE if supports boxes

Syntax

jsobj.SetBoxSupport(value);
value = jsobj.GetBoxSupport();

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

TotalWidth

Attribute

TotalWidth

Identifier

R3OUTPA_TotalWidth

JavaScript type

Integer

C type

R3INT

Description

width of a larger 'host' image. R3OUTPA_Width&Height define sub box in this

Syntax

jsobj.SetTotalWidth(value);
value = jsobj.GetTotalWidth();

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

TotalHeight

Attribute

TotalHeight

Identifier

R3OUTPA_TotalHeight

JavaScript type

Integer

C type

R3INT

Description

height of host image

Syntax

jsobj.SetTotalHeight(value);
value = jsobj.GetTotalHeight();

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

OffsetX

Attribute

OffsetX

Identifier

R3OUTPA_OffsetX

JavaScript type

Integer

C type

R3INT

Description

horiz. offset for box output, used by line read&write ops

Syntax

jsobj.SetOffsetX(value);
value = jsobj.GetOffsetX();

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

OffsetY

Attribute

OffsetY

Identifier

R3OUTPA_OffsetY

JavaScript type

Integer

C type

R3INT

Description

vert. offset for box output, used by line read&write ops

Syntax

jsobj.SetOffsetY(value);
value = jsobj.GetOffsetY();

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

OutputObject

Attribute

OutputObject

Identifier

R3OUTPA_OutputObject

JavaScript type

Object

C type

R3OBJ*

Description

actual output object, such as file format,window etc. Refcount managed!

Syntax

jsobj.SetOutputObject(value);
value = jsobj.GetOutputObject();

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3OUTPA_OutputObject, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3OUTPA_OutputObject, &value, R3TAG_END);

Extension

Attribute

Extension

Identifier

R3OUTPA_Extension

JavaScript type

String

C type

char*

Description

file extension, such as .avi, .jpg, .tga etc.

Syntax

jsobj.SetExtension(value);
value = jsobj.GetExtension();

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

Command

Attribute

Command

Identifier

R3OUTPA_Command

JavaScript type

String

C type

char*

Description

frame command

Syntax

jsobj.SetCommand(value);
value = jsobj.GetCommand();

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

LanguageId

Attribute

LanguageId

Identifier

R3OUTPA_LanguageId

JavaScript type

Integer

C type

int

Description

class of the frame command

Syntax

jsobj.SetLanguageId(value);
value = jsobj.GetLanguageId();

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

IsFinal

Attribute

IsFinal

Identifier

R3OUTPA_IsFinal

JavaScript type

Boolean

C type

R3BOOL

Description

TRUE if associated with final image

Syntax

jsobj.SetIsFinal(value);
value = jsobj.GetIsFinal();

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

ClipX

Attribute

ClipX

Identifier

R3OUTPA_ClipX

JavaScript type

Integer

C type

int

Description

All data outside (ClipX,ClipY)..(ClipX+Width-1, ClipY+Height-1) written

Syntax

jsobj.SetClipX(value);
value = jsobj.GetClipX();

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

ClipY

Attribute

ClipY

Identifier

R3OUTPA_ClipY

JavaScript type

Integer

C type

int

Description

using BUFFERFULL or COPYLINE methods is clipped

Syntax

jsobj.SetClipY(value);
value = jsobj.GetClipY();

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

SubNames

Attribute

SubNames

Identifier

R3OUTPA_SubNames

JavaScript type

String

C type

char**

Description

sub channel names of currently selected channel (NULL if subcnt==1)

Syntax

value = jsobj.GetSubNames();

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

SubCount

Attribute

SubCount

Identifier

R3OUTPA_SubCount

JavaScript type

Integer

C type

R3INT

Description

sub channel count of currently selected channel

Syntax

value = jsobj.GetSubCount();

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

ChannelId

Attribute

ChannelId

Identifier

R3OUTPA_ChannelId

JavaScript type

Integer

C type

R3INT

Description

unique identifier of the currently selected channel name

Syntax

value = jsobj.GetChannelId();

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

StorageType

Attribute

StorageType

Identifier

R3OUTPA_StorageType

JavaScript type

Integer

C type

R3INT

Description

type of the sub item of currently selected channel (R3TID_BYTE..R3TID_FLOAT)

Syntax

value = jsobj.GetStorageType();

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

RayChannelList

Attribute

RayChannelList

Identifier

R3OUTPA_RayChannelList

JavaScript type

r3List

C type

R3LIST*

Description

'R3OUTPA_RayChannelList' not documented

Syntax

value = jsobj.GetRayChannelList();

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

ImgChannelList

Attribute

ImgChannelList

Identifier

R3OUTPA_ImgChannelList

JavaScript type

r3List

C type

R3LIST*

Description

'R3OUTPA_ImgChannelList' not documented

Syntax

value = jsobj.GetImgChannelList();

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

BindingList

Attribute

BindingList

Identifier

R3OUTPA_BindingList

JavaScript type

r3List

C type

R3LIST*

Description

list of R3OUTBINDING nodes

Syntax

value = jsobj.GetBindingList();

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

Direction

Attribute

Direction

Identifier

R3OUTPA_Direction

JavaScript type

Integer

C type

int

Description

'R3OUTPA_Direction' not documented

Syntax

jsobj.SetDirection(value);
value = jsobj.GetDirection();

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

DontCopy

Attribute

DontCopy

Identifier

R3OUTPA_DontCopy

JavaScript type

Boolean

C type

R3BOOL

Description

if TRUE, use this output object only to hold binding lists, not for copying data

Syntax

jsobj.SetDontCopy(value);
value = jsobj.GetDontCopy();

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

IOReady

Attribute

IOReady

Identifier

R3OUTPA_IOReady

JavaScript type

Boolean

C type

R3BOOL

Description

use this to test if OUTPM_BEGIN has been executed

Syntax

value = jsobj.GetIOReady();

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

KeepOutputObject

Attribute

KeepOutputObject

Identifier

R3OUTPA_KeepOutputObject

JavaScript type

Boolean

C type

R3BOOL

Description

if true R3OUTPA_OutputObject is not lost in OUTPM_END

Syntax

jsobj.SetKeepOutputObject(value);
value = jsobj.GetKeepOutputObject();

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

BaseX

Attribute

BaseX

Identifier

R3OUTPA_BaseX

JavaScript type

Integer

C type

R3INT

Description

additional 'base level' offset. Total offset is R3OUTPA_BaseX+R3OUTPA_OffsetX

Syntax

jsobj.SetBaseX(value);
value = jsobj.GetBaseX();

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

BaseY

Attribute

BaseY

Identifier

R3OUTPA_BaseY

JavaScript type

Integer

C type

R3INT

Description

Syntax

jsobj.SetBaseY(value);
value = jsobj.GetBaseY();

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

NormValue

Attribute

NormValue

Identifier

R3OUTPA_NormValue

JavaScript type

Integer

C type

int

Description

float-integer conversion factor: ival = normvalue*fval, see also r3dtype.h

Syntax

value = jsobj.GetNormValue();

int value;
R3GetAttrs(r3obj, R3OUTPA_NormValue, &value, R3TAG_END);

Signed

Attribute

Signed

Identifier

R3OUTPA_Signed

JavaScript type

Boolean

C type

R3BOOL

Description

TRUE if channel is signed

Syntax

value = jsobj.GetSigned();

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

DisableCommand

Attribute

DisableCommand

Identifier

R3OUTPA_DisableCommand

JavaScript type

Boolean

C type

R3BOOL

Description

disable frame command

Syntax

jsobj.SetDisableCommand(value);
value = jsobj.GetDisableCommand();

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

IOPerChannel

Attribute

IOPerChannel

Identifier

R3OUTPA_IOPerChannel

JavaScript type

Boolean

C type

R3BOOL

Description

read only. TRUE if channelwise operations are possible (no channel cross bindings). Check after R3OUTPM_BEGIN

Syntax

value = jsobj.GetIOPerChannel();

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

Tags

R3OUTPA_RaySubChannelName

R3OUTPA_ImgSubChannelName

R3OUTPA_RayChannelClass