Realsoft
r3frende
Prev  r3model  Next

r3frende

r3frende

Class

real/code/r3frende.h

Library

r3code

Description:

File render model

See Also

oops/r3model.h

Super Class

r3Model

R3CLID_MODEL

JavaScript

r3Filerendermodel

Class Identifier

R3CLID_FILERENDERMODEL - 245

Methods

ADDOUTPUT, REMOVEOUTPUT, REMOVEALLOUTPUTS, UPDATEOUTPUTFILENAME,

Attributes

Outputs, Width, Height, BoxX, BoxY, BoxW, BoxH, FileName, FileNumberingFormat, EffectName, RenderSettingName, BeginAnimationComman, EndAnimationCommand, BeginFrameCommand, EndFrameCommand, BeginAnimationClid, EndAnimationClid, BeginFrameClid, EndFrameClid, BaseIndex, RenderBoxActive, FormatType, State, AspectLocked, ImageEffectName, FieldEffectName, FrameEffectName, RenderAction,

R3FIREM_ADDOUTPUT

Method

ADDOUTPUT

Identifier

R3FIREM_ADDOUTPUT

Return

R3BOOL, true if succeeded

Param 1:

char*, output file name

Param 3:

char*, the name of the output object to be added.

JavaScript

rc = obj.ADDOUTPUT(p1, p3);

Description

Add new output. The parameter 'p3' should refer to name of an existing output object.

R3FIREM_REMOVEOUTPUT

Method

REMOVEOUTPUT

Identifier

R3FIREM_REMOVEOUTPUT

Return

R3BOOL, true if object object was found.

Param 1:

char*, output file name

Param 3:

char*, name of the output object to be removed.

JavaScript

rc = obj.REMOVEOUTPUT(p1, p3);

Description

Remove output from the project.

R3FIREM_REMOVEALLOUTPUTS

Method

REMOVEALLOUTPUTS

Identifier

R3FIREM_REMOVEALLOUTPUTS

JavaScript

obj.REMOVEALLOUTPUTS();

Description

Clear all outputs.

R3FIREM_UPDATEOUTPUTFILENAME

Method

UPDATEOUTPUTFILENAME

Identifier

R3FIREM_UPDATEOUTPUTFILENAME

Param 1:

char*, new filename

Param 2:

char*, if given touch only outputs with this name.

Param 3:

char*, if given, touch only outputs associated with this output object

JavaScript

obj.UPDATEOUTPUTFILENAME(p1, p2, p3);

Description

Update filenames for output objects

n.name contains nice symbolic name

Name of output file

Name of output object

Outputs

Attribute

Outputs

Identifier

R3FIREA_Outputs

JavaScript type

r3List

C type

R3LIST*

Description

current output list of R3OUTNODES

Syntax


value = jsobj.GetOutputs();


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

Width

Attribute

Width

Identifier

R3FIREA_Width

JavaScript type

Integer

C type

R3INT

Description

resolution

Syntax


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


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

Height

Attribute

Height

Identifier

R3FIREA_Height

JavaScript type

Integer

C type

int

Description

'R3FIREA_Height' not documented

Syntax


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


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

BoxX

Attribute

BoxX

Identifier

R3FIREA_BoxX

JavaScript type

Integer

C type

R3INT

Description

box coordinates for box ray tracing

Syntax


jsobj.SetBoxX(value);
value = jsobj.GetBoxX();


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

BoxY

Attribute

BoxY

Identifier

R3FIREA_BoxY

JavaScript type

Integer

C type

int

Description

'R3FIREA_BoxY' not documented

Syntax


jsobj.SetBoxY(value);
value = jsobj.GetBoxY();


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

BoxW

Attribute

BoxW

Identifier

R3FIREA_BoxW

JavaScript type

Integer

C type

int

Description

'R3FIREA_BoxW' not documented

Syntax


jsobj.SetBoxW(value);
value = jsobj.GetBoxW();


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

BoxH

Attribute

BoxH

Identifier

R3FIREA_BoxH

JavaScript type

Integer

C type

int

Description

'R3FIREA_BoxH' not documented

Syntax


jsobj.SetBoxH(value);
value = jsobj.GetBoxH();


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

FileName

Attribute

FileName

Identifier

R3FIREA_FileName

JavaScript type

String

C type

char*

Description

UNUSED!!

Syntax


jsobj.SetFileName(value);
value = jsobj.GetFileName();


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

FileNumberingFormat

Attribute

FileNumberingFormat

Identifier

R3FIREA_FileNumberingFormat

JavaScript type

String

C type

char*

Description

Syntax


jsobj.SetFileNumberingFormat(value);
value = jsobj.GetFileNumberingFormat();


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

EffectName

Attribute

EffectName

Identifier

R3FIREA_EffectName

JavaScript type

String

C type

char*

Description

Syntax


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


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

RenderSettingName

Attribute

RenderSettingName

Identifier

R3FIREA_RenderSettingName

JavaScript type

String

C type

char*

Description

Syntax


jsobj.SetRenderSettingName(value);
value = jsobj.GetRenderSettingName();


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

BeginAnimationComman

Attribute

BeginAnimationComman

Identifier

R3FIREA_BeginAnimationComman

JavaScript type

String

C type

char*

Description

Syntax


jsobj.SetBeginAnimationComman(value);
value = jsobj.GetBeginAnimationComman();


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

EndAnimationCommand

Attribute

EndAnimationCommand

Identifier

R3FIREA_EndAnimationCommand

JavaScript type

String

C type

char*

Description

Syntax


jsobj.SetEndAnimationCommand(value);
value = jsobj.GetEndAnimationCommand();


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

BeginFrameCommand

Attribute

BeginFrameCommand

Identifier

R3FIREA_BeginFrameCommand

JavaScript type

String

C type

char*

Description

Syntax


jsobj.SetBeginFrameCommand(value);
value = jsobj.GetBeginFrameCommand();


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

EndFrameCommand

Attribute

EndFrameCommand

Identifier

R3FIREA_EndFrameCommand

JavaScript type

String

C type

char*

Description

Syntax


jsobj.SetEndFrameCommand(value);
value = jsobj.GetEndFrameCommand();


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

BeginAnimationClid

Attribute

BeginAnimationClid

Identifier

R3FIREA_BeginAnimationClid

JavaScript type

Integer

C type

int

Description

Syntax


jsobj.SetBeginAnimationClid(value);
value = jsobj.GetBeginAnimationClid();


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

EndAnimationClid

Attribute

EndAnimationClid

Identifier

R3FIREA_EndAnimationClid

JavaScript type

Integer

C type

int

Description

'R3FIREA_EndAnimationClid' not documented

Syntax


jsobj.SetEndAnimationClid(value);
value = jsobj.GetEndAnimationClid();


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

BeginFrameClid

Attribute

BeginFrameClid

Identifier

R3FIREA_BeginFrameClid

JavaScript type

Integer

C type

int

Description

'R3FIREA_BeginFrameClid' not documented

Syntax


jsobj.SetBeginFrameClid(value);
value = jsobj.GetBeginFrameClid();


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

EndFrameClid

Attribute

EndFrameClid

Identifier

R3FIREA_EndFrameClid

JavaScript type

Integer

C type

int

Description

'R3FIREA_EndFrameClid' not documented

Syntax


jsobj.SetEndFrameClid(value);
value = jsobj.GetEndFrameClid();


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

BaseIndex

Attribute

BaseIndex

Identifier

R3FIREA_BaseIndex

JavaScript type

Integer

C type

R3INT

Description

Syntax


jsobj.SetBaseIndex(value);
value = jsobj.GetBaseIndex();


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

RenderBoxActive

Attribute

RenderBoxActive

Identifier

R3FIREA_RenderBoxActive

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetRenderBoxActive(value);
value = jsobj.GetRenderBoxActive();


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

FormatType

Attribute

FormatType

Identifier

R3FIREA_FormatType

JavaScript type

Integer

C type

R3INT

Description

see types below

Syntax


jsobj.SetFormatType(value);
value = jsobj.GetFormatType();


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

State

Attribute

State

Identifier

R3FIREA_State

JavaScript type

Integer

C type

int

Description

See state flags below

Syntax


jsobj.SetState(value);
value = jsobj.GetState();


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

AspectLocked

Attribute

AspectLocked

Identifier

R3FIREA_AspectLocked

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetAspectLocked(value);
value = jsobj.GetAspectLocked();


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

ImageEffectName

Attribute

ImageEffectName

Identifier

R3FIREA_ImageEffectName

JavaScript type

String

C type

char*

Description

post effect applied to full images (not to partial render boxes)

Syntax


jsobj.SetImageEffectName(value);
value = jsobj.GetImageEffectName();


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

FieldEffectName

Attribute

FieldEffectName

Identifier

R3FIREA_FieldEffectName

JavaScript type

String

C type

char*

Description

post effect applied to fields

Syntax


jsobj.SetFieldEffectName(value);
value = jsobj.GetFieldEffectName();


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

FrameEffectName

Attribute

FrameEffectName

Identifier

R3FIREA_FrameEffectName

JavaScript type

String

C type

char*

Description

post effect applied to frames

Syntax


jsobj.SetFrameEffectName(value);
value = jsobj.GetFrameEffectName();


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

RenderAction

Attribute

RenderAction

Identifier

R3FIREA_RenderAction

JavaScript type

Integer

C type

R3INT

Description

see enum below

Syntax


jsobj.SetRenderAction(value);
value = jsobj.GetRenderAction();


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

Format types

R3FRFORMATTYPE_DEFAULT
R3FRFORMATTYPE_CUSTOM

state flags

R3FRSF_IMAGE
R3FRSF_ANIMATION

R3FIREA_RenderAction types

R3FIRE_RENDER
R3FIRE_RENDERWITHBACKUP
R3FIRE_POSTPROCESS

Prev  Up  Next
r3iffmod  Home  r3gfxmod