r3laylis

Realsoft		r3laylis
	r3lislay

r3laylis

Class

real/r3layer/r3laylis.h

Library

r3r3lay

Description:

List of 'projects'.

See Also

real/layer/r3lislay.h

See Also

oops/r3iff.h

Super Class

r3Listlayer

R3CLID_LISTLAYER

JavaScript

r3Layerlist

Class Identifier

R3CLID_LAYERLIST - 65

Methods

WRITEOBJECTS, READOBJECTS, REGISTEREXTENSION, FINDEXTENSION, ADDMISSINGCHANNEL, FINDPRIMTAGCLOSE, PURGEUNRESOLVEDREFS, DOPURGEUNRESOLVEDREF, TRANSLATEIMAGE,

Attributes

CurrentLayer, Filer, UnitConverter, RenderSpecs, Outputs, InitializationState, CurrentCommandLangua, ProgressIndicator, Macro, MaterialPreviewLayer, CurrentType, Channels, Compass, FileRenderers, TexturePaths, AsyncExecutor, ViewModels, UndoDepth, ReadVersion, ReadRevision, ReadRelease,

Registration

int R3RegisterLayerlistClass(R3APP *app);

R3LAYLM_WRITEOBJECTS

Method: WRITEOBJECTS
Identifier: R3LAYLM_WRITEOBJECTS
Return: R3BOOL, TRUE if succeeded
Param 3:: R3TAG*, R3RA_FileObject
JavaScript: rc = obj.WRITEOBJECTS(p3);
Description: Writes geometric primitives to a file.

R3LAYLM_READOBJECTS

Method: READOBJECTS
Identifier: R3LAYLM_READOBJECTS
Return: R3BOOL, TRUE if succeeded
Param 1:: R3BOOL, if TRUE, the existing geometric primitives are deleted prior reading
JavaScript: rc = obj.READOBJECTS(p1, 0);
Description: Read geometric primitives from file

R3LAYLCM_REGISTEREXTENSION

Method: REGISTEREXTENSION
Identifier: R3LAYLCM_REGISTEREXTENSION
Return: R3BOOL, TRUE if succeeded
Param 1:: R3CLID, class id of the extension
Param 2:: R3INT, unique identifier
Param 3:: R3TAG*, tag list, currently unused.
JavaScript: rc = obj.REGISTEREXTENSION(p1, p2, p3);
Description: Register new extension class. The class is instanced * with the layerlist and can be found with FINDEXTENSION method.

R3LAYLM_FINDEXTENSION

Method: FINDEXTENSION
Identifier: R3LAYLM_FINDEXTENSION
Return: R3OBJ*, extension or NULL if not found.
Param 3:: R3INT, unique identifier specifying the extension to be searched
JavaScript: rc = obj.FINDEXTENSION(p3);
Description: Find extension object.

R3LAYLCM_ADDMISSINGCHANNEL

Method: ADDMISSINGCHANNEL
Identifier: R3LAYLCM_ADDMISSINGCHANNEL
JavaScript: obj.ADDMISSINGCHANNEL();
Description

R3LAYLM_FINDPRIMTAGCLOSE

Method: FINDPRIMTAGCLOSE
Identifier: R3LAYLM_FINDPRIMTAGCLOSE
JavaScript: obj.FINDPRIMTAGCLOSE();
Description

R3LAYLM_PURGEUNRESOLVEDREFS

Method: PURGEUNRESOLVEDREFS
Identifier: R3LAYLM_PURGEUNRESOLVEDREFS
Param 3:: R3BOOL, force
JavaScript: obj.PURGEUNRESOLVEDREFS(p3);
Description: Removes unresolved references from objects. This method is called internally * when a project is saved or loaded.

R3LAYLM_DOPURGEUNRESOLVEDREF

Method: DOPURGEUNRESOLVEDREF
Identifier: R3LAYLM_DOPURGEUNRESOLVEDREF
JavaScript: obj.DOPURGEUNRESOLVEDREF();
Description: Non-optimized purge.

R3LAYLM_TRANSLATEIMAGE

Method: TRANSLATEIMAGE
Identifier: R3LAYLM_TRANSLATEIMAGE
Return: R3BOOL, TRUE if image found
Param 1:: char*, name of searched image objecta
JavaScript: rc = obj.TRANSLATEIMAGE(p1, 0);
Description: Finds an image object froim current layer by its name and returns its key attributes

CurrentLayer

Attribute: CurrentLayer
Identifier: R3LAYLA_CurrentLayer
JavaScript type: Object
C type: R3OBJ*
Description: current project
Syntax: jsobj.SetCurrentLayer(value);
value = jsobj.GetCurrentLayer();
: R3OBJ* value = ...;
R3SetAttrs(r3obj, R3LAYLA_CurrentLayer, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3LAYLA_CurrentLayer, &value, R3TAG_END);

Filer

Attribute: Filer
Identifier: R3LAYLA_Filer
JavaScript type: Object
C type: R3OBJ*
Description: implements project saving/reading (importing/exporting)
Syntax: value = jsobj.GetFiler();
: R3OBJ* value;
R3GetAttrs(r3obj, R3LAYLA_Filer, &value, R3TAG_END);

UnitConverter

Attribute: UnitConverter
Identifier: R3LAYLA_UnitConverter
JavaScript type: Object
C type: R3OBJ*
Description: unit conversion object
Syntax: value = jsobj.GetUnitConverter();
: R3OBJ* value;
R3GetAttrs(r3obj, R3LAYLA_UnitConverter, &value, R3TAG_END);

RenderSpecs

Attribute: RenderSpecs
Identifier: R3LAYLA_RenderSpecs
JavaScript type: Object
C type: R3OBJ*
Description: rendering settings layer
Syntax: value = jsobj.GetRenderSpecs();
: R3OBJ* value;
R3GetAttrs(r3obj, R3LAYLA_RenderSpecs, &value, R3TAG_END);

Outputs

Attribute: Outputs
Identifier: R3LAYLA_Outputs
JavaScript type: Object
C type: R3OBJ*
Description: output setting layer
Syntax: value = jsobj.GetOutputs();
: R3OBJ* value;
R3GetAttrs(r3obj, R3LAYLA_Outputs, &value, R3TAG_END);

InitializationState

Attribute: InitializationState
Identifier: R3LAYLA_InitializationState
JavaScript type: Integer
C type: int
Description: 'R3LAYLA_InitializationState' not documented
Syntax: jsobj.SetInitializationState(value);
value = jsobj.GetInitializationState();
: int value = ...;
R3SetAttrs(r3obj, R3LAYLA_InitializationState, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3LAYLA_InitializationState, &value, R3TAG_END);

CurrentCommandLangua

Attribute: CurrentCommandLangua
Identifier: R3LAYLA_CurrentCommandLangua
JavaScript type: Integer
C type: int
Description: 'R3LAYLA_CurrentCommandLanguage' not documented
Syntax: jsobj.SetCurrentCommandLangua(value);
value = jsobj.GetCurrentCommandLangua();
: int value = ...;
R3SetAttrs(r3obj, R3LAYLA_CurrentCommandLanguage, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3LAYLA_CurrentCommandLanguage, &value, R3TAG_END);

ProgressIndicator

Attribute: ProgressIndicator
Identifier: R3LAYLA_ProgressIndicator
JavaScript type: Object
C type: R3OBJ*
Description: progress indicator object
Syntax: jsobj.SetProgressIndicator(value);
value = jsobj.GetProgressIndicator();
: R3OBJ* value = ...;
R3SetAttrs(r3obj, R3LAYLA_ProgressIndicator, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3LAYLA_ProgressIndicator, &value, R3TAG_END);

Macro

Attribute: Macro
Identifier: R3LAYLA_Macro
JavaScript type: Object
C type: R3OBJ*
Description: macro recording system
Syntax: jsobj.SetMacro(value);
value = jsobj.GetMacro();
: R3OBJ* value = ...;
R3SetAttrs(r3obj, R3LAYLA_Macro, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3LAYLA_Macro, &value, R3TAG_END);

MaterialPreviewLayer

Attribute: MaterialPreviewLayer
Identifier: R3LAYLA_MaterialPreviewLayer
JavaScript type: Object
C type: R3OBJ*
Description: special purpose project for previewing materials
Syntax: jsobj.SetMaterialPreviewLayer(value);
value = jsobj.GetMaterialPreviewLayer();
: R3OBJ* value = ...;
R3SetAttrs(r3obj, R3LAYLA_MaterialPreviewLayer, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3LAYLA_MaterialPreviewLayer, &value, R3TAG_END);

CurrentType

Attribute: CurrentType
Identifier: R3LAYLA_CurrentType
JavaScript type: Integer
C type: R3INT
Description: current layer code
Syntax: jsobj.SetCurrentType(value);
value = jsobj.GetCurrentType();
: R3INT value = ...;
R3SetAttrs(r3obj, R3LAYLA_CurrentType, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3LAYLA_CurrentType, &value, R3TAG_END);

Channels

Attribute: Channels
Identifier: R3LAYLA_Channels
JavaScript type: Object
C type: R3OBJ*
Description: R3OBJ, user defined channels
Syntax: value = jsobj.GetChannels();
: R3OBJ* value;
R3GetAttrs(r3obj, R3LAYLA_Channels, &value, R3TAG_END);

Compass

Attribute: Compass
Identifier: R3LAYLA_Compass
JavaScript type: Object
C type: R3OBJ*
Description: R3OBJ, compass model
Syntax: jsobj.SetCompass(value);
value = jsobj.GetCompass();
: R3OBJ* value = ...;
R3SetAttrs(r3obj, R3LAYLA_Compass, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3LAYLA_Compass, &value, R3TAG_END);

FileRenderers

Attribute: FileRenderers
Identifier: R3LAYLA_FileRenderers
JavaScript type: Object
C type: R3OBJ*
Description: R3OBJ, file render configurations
Syntax: value = jsobj.GetFileRenderers();
: R3OBJ* value;
R3GetAttrs(r3obj, R3LAYLA_FileRenderers, &value, R3TAG_END);

TexturePaths

Attribute: TexturePaths
Identifier: R3LAYLA_TexturePaths
JavaScript type: String
C type: char*
Description: texture paths separted by semi colon
Syntax: jsobj.SetTexturePaths(value);
value = jsobj.GetTexturePaths();
: char* value = ...;
R3SetAttrs(r3obj, R3LAYLA_TexturePaths, value, R3TAG_END);
char* value;
R3GetAttrs(r3obj, R3LAYLA_TexturePaths, &value, R3TAG_END);

AsyncExecutor

Attribute: AsyncExecutor
Identifier: R3LAYLA_AsyncExecutor
JavaScript type: Object
C type: R3OBJ*
Description: async. executor object
Syntax: value = jsobj.GetAsyncExecutor();
: R3OBJ* value;
R3GetAttrs(r3obj, R3LAYLA_AsyncExecutor, &value, R3TAG_END);

ViewModels

Attribute: ViewModels
Identifier: R3LAYLA_ViewModels
JavaScript type: Object
C type: R3OBJ*
Description: R3OBJ, view models layer
Syntax: value = jsobj.GetViewModels();
: R3OBJ* value;
R3GetAttrs(r3obj, R3LAYLA_ViewModels, &value, R3TAG_END);

UndoDepth

Attribute: UndoDepth
Identifier: R3LAYLA_UndoDepth
JavaScript type: Integer
C type: R3INT
Description: undo depth for all layers
Syntax: jsobj.SetUndoDepth(value);
value = jsobj.GetUndoDepth();
: R3INT value = ...;
R3SetAttrs(r3obj, R3LAYLA_UndoDepth, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3LAYLA_UndoDepth, &value, R3TAG_END);

ReadVersion

Attribute: ReadVersion
Identifier: R3LAYLA_ReadVersion
JavaScript type: Integer
C type: R3INT
Description: version of the current project (file version)
Syntax: value = jsobj.GetReadVersion();
: R3INT value;
R3GetAttrs(r3obj, R3LAYLA_ReadVersion, &value, R3TAG_END);

ReadRevision

Attribute: ReadRevision
Identifier: R3LAYLA_ReadRevision
JavaScript type: Integer
C type: R3INT
Description: revision of the current project (file revision)
Syntax: value = jsobj.GetReadRevision();
: R3INT value;
R3GetAttrs(r3obj, R3LAYLA_ReadRevision, &value, R3TAG_END);

ReadRelease

Attribute: ReadRelease
Identifier: R3LAYLA_ReadRelease
JavaScript type: Integer
C type: R3INT
Description: minor release code of the current project
Syntax: value = jsobj.GetReadRelease();
: R3INT value;
R3GetAttrs(r3obj, R3LAYLA_ReadRelease, &value, R3TAG_END);

R3LAYLINITSTATE_BEGIN
R3LAYLINITSTATE_1
R3LAYLINITSTATE_2
R3LAYLINITSTATE_3
R3LAYLINITSTATE_READY

indentifiers for filer etc.

R3LT_PRIMITIVES
R3LT_MATERIALS
R3LT_ENVELOPES
R3LT_RSPEC
R3LT_IMAGES
R3LT_OUTPUTS
R3LT_GRIDS
R3LT_IMAGEEFFECTS
R3LT_PARTICLEEFFECTS
R3LT_CHANNELS
R3LT_MACROS
R3LT_ANIMATION
R3LT_FILERENDERERS
R3LT_VIEWMODELS

IFF chunk ids for io

moved to r3layer.h #define R3IFFID_VERSION MakeID('R', 'V', 'R', 'S') #define R3IFFID_PRIMITIVE MakeID('R', 'O', 'B', 'J') #define R3IFFID_MATERIAL MakeID('R', 'M', 'A', 'T') #define R3IFFID_PARTICLEEFFECT MakeID('R', 'E', 'P', 'F') #define R3IFFID_IMAGE MakeID('R', 'I', 'M', 'G') #define R3IFFID_IMAGEEFFECT MakeID('R', 'E', 'I', 'F') #define R3IFFID_VIEWMODELS MakeID('R', 'V', 'I', 'E') #define R3IFFID_RSPEC MakeID('R', 'S', 'P', 'C') #define R3IFFID_GRID MakeID('R', 'G', 'R', 'D') #define R3IFFID_ANIMATION MakeID('R', 'A', 'N', 'I') #define R3IFFID_OUTPUT MakeID('R', 'O', 'U', 'T') #define R3IFFID_CHANNEL MakeID('R', 'C', 'H', 'N') #define R3IFFID_COMPASS MakeID('R', 'C', 'S', 'P') #define R3IFFID_FILERENDER MakeID('R', 'F', 'L', 'R') #define R3IFFID_THUMBNAIL MakeID('R', 'T', 'H', 'N')

error codes

R3LAYLERR_EXPIRED

P_OBJECTS
P_MATERIALS
P_RSPEC
P_IMAGES
P_OUTPUTS
P_GRIDS
P_IMAGEEFFECTS
P_PARTICLEEFFECTS
P_CHANNELS
P_FILERENDERERS
P_VIEWMODELS

Flags for R3LAYLA_Stripped, for disables layerlist features.

R3STRIPF_STRIPPED
R3STRIPF_UNITCONVERTER
R3STRIPF_CLIPBOARD
R3STRIPF_ASYNCEXEC
R3STRIPF_DEFAULTRSPECS
R3STRIPF_PROGRESSMODEL
R3STRIPF_WMATEV
R3STRIPF_ANIMATOR
R3STRIPF_PAINTERS
R3STRIPF_INTERACTORS
R3STRIPF_CHANNELMANAGEMENT


r3layer		r3matlay

r3laylis

Tags