r3fileinst

Class

plugins/objects/fileinst/r3fileinst.h

Library

r3fileinst

Description:

File instance - an object whose geometry resides on a file.

See Also

real/objects/r3level.h

Super Class

r3Level

R3CLID_LEVEL

JavaScript

r3Fileinstance

Class Identifier

R3CLID_FILEINSTANCE - 1999

Methods

INITBOX, GETGEOMETRY, REPLACEWITHTARGET, DETECTINDEXRANGE,

Attributes

FileName, Geometrics, Materials, Effects, FullGeometry, P0, P1, P2, P3, Width, Height, Depth, RenderInstance, AnimationType, NumFrames, FormatType, FormatDigits, BaseIndex, Frame, TileAnimation, FlipAnimation, ReverseAnimation, Format, CurrentName,

R3FINSTM_INITBOX

Method

INITBOX

Identifier

R3FINSTM_INITBOX

JavaScript

obj.INITBOX();

Description

Sets the control box to match the geometry of the target disk file

R3FINSTM_GETGEOMETRY

Method

GETGEOMETRY

Identifier

R3FINSTM_GETGEOMETRY

Return

R3OBJ*, the loaded prim layer or root object. Unref it after use

Param 3:

R3BOOL, if true pastehandlers are executed

JavaScript

rc = obj.GETGEOMETRY(p3);

Description

Loads the target geometry. If geometry is preloaded (R3FINSTA_FullGeometry==TRUE) * returns a pointer to the already existing object which is linked to geom. hierarchy tree.

R3FINSTM_REPLACEWITHTARGET

Method

REPLACEWITHTARGET

Identifier

R3FINSTM_REPLACEWITHTARGET

Return

R3OBJ*, the loaded geom. root

Param 1:

R3OBJ*, library for loaded effects

Param 3:

R3OBJ*, library for loaded materials

JavaScript

rc = obj.REPLACEWITHTARGET(p1, p3);

Description

Loads the target and deletes the file instance

R3FINSTM_DETECTINDEXRANGE

Method

DETECTINDEXRANGE

Identifier

R3FINSTM_DETECTINDEXRANGE

JavaScript

obj.DETECTINDEXRANGE();

Description

Detect the index range of the current file

FileName

Attribute

FileName

Identifier

R3FINSTA_FileName

JavaScript type

String

C type

char*

Description

file name

Syntax

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

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

Geometrics

Attribute

Geometrics

Identifier

R3FINSTA_Geometrics

JavaScript type

Boolean

C type

R3BOOL

Description

load geometric objects

Syntax

jsobj.SetGeometrics(value);
value = jsobj.GetGeometrics();

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

Materials

Attribute

Materials

Identifier

R3FINSTA_Materials

JavaScript type

Boolean

C type

R3BOOL

Description

load materials

Syntax

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

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

Effects

Attribute

Effects

Identifier

R3FINSTA_Effects

JavaScript type

Boolean

C type

R3BOOL

Description

load particle effects

Syntax

jsobj.SetEffects(value);
value = jsobj.GetEffects();

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

FullGeometry

Attribute

FullGeometry

Identifier

R3FINSTA_FullGeometry

JavaScript type

Boolean

C type

R3BOOL

Description

loads geometry to memory

Syntax

jsobj.SetFullGeometry(value);
value = jsobj.GetFullGeometry();

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

P0

Attribute

P0

Identifier

R3FINSTA_P0

Type

r3Vect

Description

geom point

Syntax

jsobj.SetP0(value);
value = jsobj.GetP0();

R3VECTOR* value = ...;
R3SetAttrs(r3obj, R3FINSTA_P0, value, R3TAG_END);
R3VECTOR* value;
R3GetAttrs(r3obj, R3FINSTA_P0, &value, R3TAG_END);

P1

Attribute

P1

Identifier

R3FINSTA_P1

Type

r3Vect

Description

geom point

Syntax

jsobj.SetP1(value);
value = jsobj.GetP1();

R3VECTOR* value = ...;
R3SetAttrs(r3obj, R3FINSTA_P1, value, R3TAG_END);
R3VECTOR* value;
R3GetAttrs(r3obj, R3FINSTA_P1, &value, R3TAG_END);

P2

Attribute

P2

Identifier

R3FINSTA_P2

Type

r3Vect

Description

geom point

Syntax

jsobj.SetP2(value);
value = jsobj.GetP2();

R3VECTOR* value = ...;
R3SetAttrs(r3obj, R3FINSTA_P2, value, R3TAG_END);
R3VECTOR* value;
R3GetAttrs(r3obj, R3FINSTA_P2, &value, R3TAG_END);

P3

Attribute

P3

Identifier

R3FINSTA_P3

Type

r3Vect

Description

geom point

Syntax

jsobj.SetP3(value);
value = jsobj.GetP3();

R3VECTOR* value = ...;
R3SetAttrs(r3obj, R3FINSTA_P3, value, R3TAG_END);
R3VECTOR* value;
R3GetAttrs(r3obj, R3FINSTA_P3, &value, R3TAG_END);

Width

Attribute

Width

Identifier

R3FINSTA_Width

JavaScript type

Number

C type

R3FLOAT

Description

width

Syntax

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

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3FINSTA_Width, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3FINSTA_Width, &value, R3TAG_END);

Height

Attribute

Height

Identifier

R3FINSTA_Height

JavaScript type

Number

C type

R3FLOAT

Description

height

Syntax

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

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3FINSTA_Height, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3FINSTA_Height, &value, R3TAG_END);

Depth

Attribute

Depth

Identifier

R3FINSTA_Depth

JavaScript type

Number

C type

R3FLOAT

Description

depth

Syntax

jsobj.SetDepth(value);
value = jsobj.GetDepth();

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3FINSTA_Depth, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3FINSTA_Depth, &value, R3TAG_END);

RenderInstance

Attribute

RenderInstance

Identifier

R3FINSTA_RenderInstance

JavaScript type

Boolean

C type

R3BOOL

Description

try to render as ray traced instance

Syntax

jsobj.SetRenderInstance(value);
value = jsobj.GetRenderInstance();

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

AnimationType

Attribute

AnimationType

Identifier

R3FINSTA_AnimationType

JavaScript type

Integer

C type

R3INT

Description

see animation types below

Syntax

jsobj.SetAnimationType(value);
value = jsobj.GetAnimationType();

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

NumFrames

Attribute

NumFrames

Identifier

R3FINSTA_NumFrames

JavaScript type

Integer

C type

R3INT

Description

total number of files in the image sequence

Syntax

jsobj.SetNumFrames(value);
value = jsobj.GetNumFrames();

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

FormatType

Attribute

FormatType

Identifier

R3FINSTA_FormatType

JavaScript type

Integer

C type

R3INT

Description

see formatting methods below

Syntax

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

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

FormatDigits

Attribute

FormatDigits

Identifier

R3FINSTA_FormatDigits

JavaScript type

Integer

C type

R3INT

Description

number of digits in the format

Syntax

jsobj.SetFormatDigits(value);
value = jsobj.GetFormatDigits();

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

BaseIndex

Attribute

BaseIndex

Identifier

R3FINSTA_BaseIndex

JavaScript type

Integer

C type

R3INT

Description

the first index

Syntax

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

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

Frame

Attribute

Frame

Identifier

R3FINSTA_Frame

JavaScript type

Integer

C type

R3INT

Description

current frame

Syntax

jsobj.SetFrame(value);
value = jsobj.GetFrame();

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

TileAnimation

Attribute

TileAnimation

Identifier

R3FINSTA_TileAnimation

JavaScript type

Boolean

C type

R3BOOL

Description

tile animation

Syntax

jsobj.SetTileAnimation(value);
value = jsobj.GetTileAnimation();

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

FlipAnimation

Attribute

FlipAnimation

Identifier

R3FINSTA_FlipAnimation

JavaScript type

Boolean

C type

R3BOOL

Description

filp animation

Syntax

jsobj.SetFlipAnimation(value);
value = jsobj.GetFlipAnimation();

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

ReverseAnimation

Attribute

ReverseAnimation

Identifier

R3FINSTA_ReverseAnimation

JavaScript type

Boolean

C type

R3BOOL

Description

reverse animation

Syntax

jsobj.SetReverseAnimation(value);
value = jsobj.GetReverseAnimation();

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

Format

Attribute

Format

Identifier

R3FINSTA_Format

JavaScript type

String

C type

char*

Description

format string

Syntax

jsobj.SetFormat(value);
value = jsobj.GetFormat();

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

CurrentName

Attribute

CurrentName

Identifier

R3FINSTA_CurrentName

JavaScript type

String

C type

char*

Description

R3RM_GET only, current indexed name

Syntax

value = jsobj.GetCurrentName();

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

R3FIAT_NONE

R3FIAT_AUTOMATIC

R3FIAT_KEYFRAME

R3FIFORMAT_AUTO

R3FIFORMAT_CUSTOM

R3FILF_GEOMETRICS

R3FILF_MATERIALS

R3FILF_EFFECTS