r3objlay

r3lislay
r3imglay
r3layer
r3laylis
r3matlay
r3real
r3efflay
r3vmodlayer
r3prilay

r3objlay

Class

real/layer/r3objlay.h

Library

r3layer

Description:

Real 3D Object Layer Class. This is a container class for any kind of objects. Classes derived from this class take care of the actual data structures for storing the objects. This class defines the basic methods and supports some general operations like selection, cut/copy/paste, locking and undo.

See Also

oops/r3model.h

See Also

oops/r3slctbl.h

See Also

real/code/r3ttag.h

Super Class

r3Model

R3CLID_MODEL

JavaScript

r3Objectlayer

Class Identifier

R3CLID_OBJECTLAYER - 75

Methods

SELECTOBJ, SELECTOBJMUTEX, SELECTOBJTOGGLE, UNSELECTOBJ, INSERT, REMOVE, NEWOBJECT, COPYOBJECT, DELETEOBJECT, DELETESELECTION, CUTSELECTION, COPYSELECTION, CLEARSELECTION, PASTE, PASTE2, CANPASTE, SETONSELECTED, PERFORMONSELECTED, LOCKEXCLUSIVE, LOCKSHARED, RELEASE, LOCKSHAREDYIELDS, GETFIRSTSELECTED, UNDO, UNDOCOPY, DOUNDOCOPY, SETUNDOCOPY, REMOVEUNDOCOPY, BEGINATOMARYUNDO, ENDATOMARYUNDO, FINDBYNAME, PERFORMONSELECTEDA2, SETONSELECTEDA, WRITESELECTION, SELECTBYNAME, SELECTBYCLASS, ENUMOBJECTS, SETDYNATTRS, GETDYNATTRS, KINDOF, REDO, SELECTEDOFKIND, GETCURRENTIME, FINDTAGCLOSE, FINDTAGFROMCHILDREN, ENUMSELECTLIST, DUPLICATESELECTION, EXECIDLES, ADDIDLEMSG, SELECTBYORDNUM, GETENDTIME, EXPORT, DELETEALL, REGISTERPASTEHANDLE, ENUMPASTEOBJ, ADD, STRIPIDLESTOOBJ, SETSUBFLOATONSELECTE, SETRELATIVESUBFLOATO, UNSELECTCHILDANDANC, SELECTOBJRANGE, EXECSELECTEDIDLES, REGISTERCHANGETOIGN, SETCURRENTTIME, REGISTERCHANGECALLBA, FREECHANGECALLBACKS, CHORNOTIFICATION, SHOWMSG, REMOVEREFERENCES, RELEASESHAREDYIELDS, PURGEUNRESOLVED, OPTRESOLV, SETCURRENTFRAME, GETCURRENTFRAME, SELECTAFTERUNDO, BEGINSELECTION, ENDSELECTION, SUSPENDYIELDS, RESUMEYIELDS, REGISTEREXTENSION, STARTOBJECT, STOPOBJECT, FINDEXTENSION,

Attributes

SelectList, UndoDepth, CurrentUndos, ClipBoard, ClipClass, ProgressIndicator, CurrentRedos, AddKeyResol, FindTagObj, FindTagMth, CurrentTime, Modified, EndTime, RemoveReferencesMth, Open, AsyncExecutor, NoLocking, ChangeCount, NoChangeCounting, ChangeCallbacks, NumObjects, AnimRecord, DeleteReferencesMth, UnitConverter, OptResolvMth, OptResolvInvMth,

multi inheritance

R3OLAYM_SELECTOBJ

Method

SELECTOBJ

Identifier

R3OLAYM_SELECTOBJ

Param 3:

R3OBJ*, object to select

JavaScript

obj.SELECTOBJ(p3);

Description

Select an object

R3OLAYM_SELECTOBJMUTEX

Method

SELECTOBJMUTEX

Identifier

R3OLAYM_SELECTOBJMUTEX

Param 3:

R3OBJ*, object to select

JavaScript

obj.SELECTOBJMUTEX(p3);

Description

Select an object and deselect all other objects

R3OLAYM_SELECTOBJTOGGLE

Method

SELECTOBJTOGGLE

Identifier

R3OLAYM_SELECTOBJTOGGLE

Param 3:

R3OBJ*, object to toggle

JavaScript

obj.SELECTOBJTOGGLE(p3);

Description

Select an object if it is selected, otherwise unselect it.

R3OLAYM_UNSELECTOBJ

Method

UNSELECTOBJ

Identifier

R3OLAYM_UNSELECTOBJ

Param 3:

R3OBJ*, object to unselect

JavaScript

obj.UNSELECTOBJ(p3);

Description

Unselect an object.

R3OLAYM_INSERT

Method

INSERT

Identifier

R3OLAYM_INSERT

Param 1:

R3BOOL, if thue does not send R3OLAYM_DOUNDOCOPY method

Param 2:

R3OBJ*, insert after this object, if NULL insert at the end, if same as the parent level, then insert as the first child.

Param 3:

R3OBJ*, object to insert.

JavaScript

obj.INSERT(p1, p2, p3);

Description

Insert an object to the layer.

R3OLAYM_REMOVE

Method

REMOVE

Identifier

R3OLAYM_REMOVE

Return

R3OBJ*, obj

Param 1:

R3BOOL, if true, object is not mapped to abs space

Param 3:

R3OBJ*, object to remove.

JavaScript

rc = obj.REMOVE(p1, p3);

Description

Remove an object from the layer.

R3OLAYM_NEWOBJECT

Method

NEWOBJECT

Identifier

R3OLAYM_NEWOBJECT

Return

R3OBJ*, obj

Param 3:

R3INT, class id of the object to be created or NULL for default.

JavaScript

rc = obj.NEWOBJECT(p3);

Description

Make a new object of the layers default type and insert it.

R3OLAYM_COPYOBJECT

Method

COPYOBJECT

Identifier

R3OLAYM_COPYOBJECT

Return

R3OBJ*, copy of p3 if succeeded, else NULL.

Param 1:

R3INT, method to use for copying.

Param 3:

R3OBJ*, object to copy.

JavaScript

rc = obj.COPYOBJECT(p1, p3);

Description

Make a copy of an object in the layer.

R3OLAYM_DELETEOBJECT

Method

DELETEOBJECT

Identifier

R3OLAYM_DELETEOBJECT

Param 3:

R3OBJ*, object to delete.

JavaScript

obj.DELETEOBJECT(p3);

Description

Delete an object in the layer.

R3OLAYM_DELETESELECTION

Method

DELETESELECTION

Identifier

R3OLAYM_DELETESELECTION

JavaScript

obj.DELETESELECTION();

Description

Delete all selected objects

R3OLAYM_CUTSELECTION

Method

CUTSELECTION

Identifier

R3OLAYM_CUTSELECTION

JavaScript

obj.CUTSELECTION();

Description

Move all selected objects to clipboard

R3OLAYM_COPYSELECTION

Method

COPYSELECTION

Identifier

R3OLAYM_COPYSELECTION

JavaScript

obj.COPYSELECTION();

Description

Copy all selected objects to clipboard

R3OLAYM_CLEARSELECTION

Method

CLEARSELECTION

Identifier

R3OLAYM_CLEARSELECTION

Param 3:

R3BOOL, recursive

JavaScript

obj.CLEARSELECTION(p3);

Description

Unselect all seleced objects.

R3OLAYM_PASTE

Method

PASTE

Identifier

R3OLAYM_PASTE

JavaScript

obj.PASTE();

Description

Copy all objects in clipboard and add to layer.

R3OLAYM_PASTE2

Method

PASTE2

Identifier

R3OLAYM_PASTE2

Param 3:

R3OBJ*, insert after this object, if NULL insert at the end, if same as the parent level, then insert as the first child.

JavaScript

obj.PASTE2(p3);

Description

move objects from clipboard, don't copy.

R3OLAYM_CANPASTE

Method

CANPASTE

Identifier

R3OLAYM_CANPASTE

Return

R3BOOL, TRUE/FALSE

JavaScript

rc = obj.CANPASTE();

Description

Return TRUE if there are any objects of the layers type in the clipboard.

R3OLAYM_SETONSELECTED

Method

SETONSELECTED

Identifier

R3OLAYM_SETONSELECTED

Param 3:

R3TAG*, tags to pass to R3SetAttrsA().

JavaScript

obj.SETONSELECTED(p3);

Description

Perform R3SetAttrsA(sel->obj, tags) on all selected objects

R3OLAYM_PERFORMONSELECTED

Method

PERFORMONSELECTED

Identifier

R3OLAYM_PERFORMONSELECTED

Param 1:

R3BOOL, disable undo

Param 2:

R3BOOL, disable R3MM_CHANGED

Param 3:

R3TAG*, R3OLAYA_PMethod, R3INT *, method to send. R3OLAYA_PMsg, void *, first parameter. R3OLAYA_PMsg2, void *, second parameter.

JavaScript

obj.PERFORMONSELECTED(p1, p2, p3);

Description

Send a method to all selected objects.

R3OLAYM_LOCKEXCLUSIVE

Method

LOCKEXCLUSIVE

Identifier

R3OLAYM_LOCKEXCLUSIVE

JavaScript

obj.LOCKEXCLUSIVE();

Description

Lock layer with exclusive lock

R3OLAYM_LOCKSHARED

Method

LOCKSHARED

Identifier

R3OLAYM_LOCKSHARED

JavaScript

obj.LOCKSHARED();

Description

Lock layer with shared lock

R3OLAYM_RELEASE

Method

RELEASE

Identifier

R3OLAYM_RELEASE

JavaScript

obj.RELEASE();

Description

Release the lock obtained via R3OLAYM_LOCKSHARED or R3OLAYM_LOCKEXCLUSIVE

R3OLAYM_LOCKSHAREDYIELDS

Method

LOCKSHAREDYIELDS

Identifier

R3OLAYM_LOCKSHAREDYIELDS

Param 3:

R3TAG*, R3OLAYA_YieldingObject, R3OBJ *, R3OLAYA_YieldMethod, R3INT, R3OLAYA_YieldDoneMethod, R3INT,

JavaScript

obj.LOCKSHAREDYIELDS(p3);

Description

Locking for objects willing to give up the lock if another thread wants an exclusive lock.

R3OLAYM_GETFIRSTSELECTED

Method

GETFIRSTSELECTED

Identifier

R3OLAYM_GETFIRSTSELECTED

Return

R3OBJ*, the object

JavaScript

rc = obj.GETFIRSTSELECTED();

Description

Return first selected object.

R3OLAYM_UNDO

Method

UNDO

Identifier

R3OLAYM_UNDO

JavaScript

obj.UNDO();

Description

Normal undo

R3OLAYM_UNDOCOPY

Method

UNDOCOPY

Identifier

R3OLAYM_UNDOCOPY

Return

R3OBJ*, the data

JavaScript

rc = obj.UNDOCOPY();

Description

Return data representing all objects for inserting into undo list.

R3OLAYM_DOUNDOCOPY

Method

DOUNDOCOPY

Identifier

R3OLAYM_DOUNDOCOPY

JavaScript

obj.DOUNDOCOPY();

Description

Copy the current state into the undo list.

R3OLAYM_SETUNDOCOPY

Method

SETUNDOCOPY

Identifier

R3OLAYM_SETUNDOCOPY

JavaScript

obj.SETUNDOCOPY();

Description

Reset the state of the layer to on returned by UNDOCOPY

R3OLAYM_REMOVEUNDOCOPY

Method

REMOVEUNDOCOPY

Identifier

R3OLAYM_REMOVEUNDOCOPY

JavaScript

obj.REMOVEUNDOCOPY();

Description

Delete the data returned by UNDOCOPY

R3OLAYM_BEGINATOMARYUNDO

Method

BEGINATOMARYUNDO

Identifier

R3OLAYM_BEGINATOMARYUNDO

JavaScript

obj.BEGINATOMARYUNDO();

Description

Do one undo copy but no further undo copies until ENDATOMARYUNDO is called

R3OLAYM_ENDATOMARYUNDO

Method

ENDATOMARYUNDO

Identifier

R3OLAYM_ENDATOMARYUNDO

JavaScript

obj.ENDATOMARYUNDO();

Description

See BEGINATOMARYUNDO

R3OLAYM_FINDBYNAME

Method

FINDBYNAME

Identifier

R3OLAYM_FINDBYNAME

Return

R3OBJ*, object if found, else NULL,

Param 3:

char*, name of object

JavaScript

rc = obj.FINDBYNAME(p3);

Description

Find an object by its name.

R3OLAYM_PERFORMONSELECTEDA2

Method

PERFORMONSELECTEDA2

Identifier

R3OLAYM_PERFORMONSELECTEDA2

Return

R3OBJ*, obj

Param 1:

R3INT, a method to be sent

Param 2:

void*, p1 parameter for the selected object

Param 3:

void*, p3 parameter for the selected objects

JavaScript

rc = obj.PERFORMONSELECTEDA2(p1, p2, p3);

Description

Send a method to all selected objects using R3SendMsgA2().

R3OLAYM_SETONSELECTEDA

Method

SETONSELECTEDA

Identifier

R3OLAYM_SETONSELECTEDA

Param 1:

R3INT, attribute

Param 2:

R3BOOL, disable undocopy

Param 3:

void*, value

JavaScript

obj.SETONSELECTEDA(p1, p2, p3);

Description

Perform R3SetAttrs(sel->obj, p1, msg, R3TAG_END) on all selected objects

R3OLAYM_WRITESELECTION

Method

WRITESELECTION

Identifier

R3OLAYM_WRITESELECTION

Return

R3BOOL, TRUE if succeed, FALSE otherwise

JavaScript

rc = obj.WRITESELECTION();

Description

Send write method to all selected objects

R3OLAYM_SELECTBYNAME

Method

SELECTBYNAME

Identifier

R3OLAYM_SELECTBYNAME

Return

R3INT, number of objects selected

Param 1:

R3BOOL, if true selects, otherwise unselects

Param 3:

char*, regular expression

JavaScript

rc = obj.SELECTBYNAME(p1, p3);

Description

Select objects by name

R3OLAYM_SELECTBYCLASS

Method

SELECTBYCLASS

Identifier

R3OLAYM_SELECTBYCLASS

Return

R3INT, number of objects selected

Param 1:

R3BOOL, if true selects, otherwise unselects

Param 3:

R3CLID, class id

JavaScript

rc = obj.SELECTBYCLASS(p1, p3);

Description

Select objects by class

R3OLAYM_ENUMOBJECTS

Method

ENUMOBJECTS

Identifier

R3OLAYM_ENUMOBJECTS

Return

R3INT, return value from the hook function.

Param 3:

R3TAG*, tag list specifying R3RA_Hook and R3RA_HookData.

JavaScript

rc = obj.ENUMOBJECTS(p3);

Description

Enumerate the contents of the layer. The given callback must define * two parameters: object and context data. If the callback returns TRUE, enumeration continues. If the return values is not TRUE, the enumeration is canceled and the return code from the hook is returned.

R3OLAYM_SETDYNATTRS

Method

SETDYNATTRS

Identifier

R3OLAYM_SETDYNATTRS

Return

R3BOOL, true if succeeded.

Param 3:

R3TAG*, dynamic tags to be added.

JavaScript

rc = obj.SETDYNATTRS(p3);

Description

Add dynamic attributes to the layer object.

R3OLAYM_GETDYNATTRS

Method

GETDYNATTRS

Identifier

R3OLAYM_GETDYNATTRS

Return

R3TAG*, NULL if all tags were found, otherwise address to the last not found tag

Param 3:

R3TAG*, attributes to be fetched

JavaScript

rc = obj.GETDYNATTRS(p3);

Description

Get dynamic attributes from the layer

R3OLAYM_KINDOF

Method

KINDOF

Identifier

R3OLAYM_KINDOF

Return

R3BOOL, FALSE if class id cannot be detected (no objects selected)

Param 1:

R3BOOL, recursive

JavaScript

rc = obj.KINDOF(p1, 0);

Description

Find common class id for the selected objects. Note: initialize the result value to -1 zero before caling this function. If there is no selected objects, this method doesn't touch 'p3'

R3OLAYM_REDO

Method

REDO

Identifier

R3OLAYM_REDO

JavaScript

obj.REDO();

Description

Redo

R3OLAYM_SELECTEDOFKIND

Method

SELECTEDOFKIND

Identifier

R3OLAYM_SELECTEDOFKIND

Return

R3BOOL, TRUE/FALSE

Param 3:

R3CLID, class id to be checked

JavaScript

rc = obj.SELECTEDOFKIND(p3);

Description

Check if the selected objects include objects with the given class id.

R3OLAYM_GETCURRENTIME

Method

GETCURRENTIME

Identifier

R3OLAYM_GETCURRENTIME

Param 3:

R3FLOAT, buffer

JavaScript

obj.GETCURRENTIME(p3);

Description

Fetch the current time of the layer.

R3OLAYM_FINDTAGCLOSE

Method

FINDTAGCLOSE

Identifier

R3OLAYM_FINDTAGCLOSE

Return

R3OBJ*, object which defines given attribute - value.

Param 2:

R3INT, unique identifier

JavaScript

rc = obj.FINDTAGCLOSE(0, p2, 0);

Description

Find object identified by given dynamic tag.

R3OLAYM_FINDTAGFROMCHILDREN

Method

FINDTAGFROMCHILDREN

Identifier

R3OLAYM_FINDTAGFROMCHILDREN

Param 1:

R3INT, tag id of identifier,

Param 2:

R3INT, value of the identifier

Param 3:

R3OBJ*, object excluded in the search

JavaScript

obj.FINDTAGFROMCHILDREN(p1, p2, p3);

Description

find object with give unique identifier

R3OLAYM_ENUMSELECTLIST

Method

ENUMSELECTLIST

Identifier

R3OLAYM_ENUMSELECTLIST

Return

R3INT, return value from the hook function.

Param 3:

R3TAG*, tag list specifying R3RA_Hook and R3RA_HookData.

JavaScript

rc = obj.ENUMSELECTLIST(p3);

Description

Enumerate the contents of the select list. The given callback gets the enumerated * object as the first parameter and the given context data second. If the callback returns TRUE, enumeration continues. If the return values is not TRUE, the enumeration is canceled and the return code from the hook is returned.

R3OLAYM_DUPLICATESELECTION

Method

DUPLICATESELECTION

Identifier

R3OLAYM_DUPLICATESELECTION

JavaScript

obj.DUPLICATESELECTION();

Description

Duplicates all selected objects and optionally renames them.

R3OLAYM_EXECIDLES

Method

EXECIDLES

Identifier

R3OLAYM_EXECIDLES

JavaScript

obj.EXECIDLES();

Description

Execute all idle messages to a target or to all targets

R3OLAYM_ADDIDLEMSG

Method

ADDIDLEMSG

Identifier

R3OLAYM_ADDIDLEMSG

Return

R3BOOL, true if succeeded

Param 1:

R3OBJ*, object to be called

Param 2:

R3INT, method

Param 3:

void*, p3 parameter for the object to be called.

JavaScript

rc = obj.ADDIDLEMSG(p1, p2, p3);

Description

Add idle message to the layers idle list

R3OLAYM_SELECTBYORDNUM

Method

SELECTBYORDNUM

Identifier

R3OLAYM_SELECTBYORDNUM

Return

R3BOOL, true if selected

Param 3:

R3INT, ordnum

JavaScript

rc = obj.SELECTBYORDNUM(p3);

Description

Select an object by ordnum.

R3OLAYM_GETENDTIME

Method

GETENDTIME

Identifier

R3OLAYM_GETENDTIME

Param 3:

R3FLOAT, buffer

JavaScript

obj.GETENDTIME(p3);

Description

Fetch the end time of the layer.

R3OLAYM_EXPORT

Method

EXPORT

Identifier

R3OLAYM_EXPORT

JavaScript

obj.EXPORT();

Description

Export objects in the layer

R3OLAYM_DELETEALL

Method

DELETEALL

Identifier

R3OLAYM_DELETEALL

JavaScript

obj.DELETEALL();

Description

Delete all objects in the layer.

R3OLAYCM_REGISTERPASTEHANDLE

Method

REGISTERPASTEHANDLE

Identifier

R3OLAYCM_REGISTERPASTEHANDLE

Return

R3BOOL, true if succeeded.

JavaScript

rc = obj.REGISTERPASTEHANDLE();

Description

Register paste handler for a class. Paste handler is called for objects in the clipboard before each paste operation. Paste handler consists of three functions: begin is called once per paste operation: userdata = (*begin)(layer); 'handler' is called once per each object in the clip board and the return value o fthe 'begin' function is passed as a parameter for the function. Memory allocated in the 'begin' function can then be freed in the 'end' function.

R3OLAYM_ENUMPASTEOBJ

Method

ENUMPASTEOBJ

Identifier

R3OLAYM_ENUMPASTEOBJ

JavaScript

obj.ENUMPASTEOBJ();

Description

Called internally by cut/copy/paste/duplcate etc. operations.

R3OLAYM_ADD

Method

ADD

Identifier

R3OLAYM_ADD

Param 3:

R3OBJ*, object to be inserted

JavaScript

obj.ADD(p3);

Description

Lock the layer, insert the object using the default options and release the layer.

R3OLAYM_STRIPIDLESTOOBJ

Method

STRIPIDLESTOOBJ

Identifier

R3OLAYM_STRIPIDLESTOOBJ

Param 1:

R3BOOL, true to execute, false just removes the message from the queue.

Param 3:

R3OBJ*, target object

JavaScript

obj.STRIPIDLESTOOBJ(p1, p3);

Description

Remove or execute all idle messages to given object.

R3OLAYM_SETSUBFLOATONSELECTE

Method

SETSUBFLOATONSELECTE

Identifier

R3OLAYM_SETSUBFLOATONSELECTE

Param 1:

R3INT, attribute to be set

Param 2:

R3INT, ordnum of the sub field (0 = x, 1 = y etc.)

Param 3:

R3FLOAT, new value

JavaScript

obj.SETSUBFLOATONSELECTE(p1, p2, p3);

Description

Set given sub component of vector attribute.

R3OLAYM_SETRELATIVESUBFLOATO

Method

SETRELATIVESUBFLOATO

Identifier

R3OLAYM_SETRELATIVESUBFLOATO

Param 1:

R3INT, attribute to be set

Param 2:

R3INT, ordnum of the sub field (0 = x, 1 = y etc.)

Param 3:

R3FLOAT, new value

JavaScript

obj.SETRELATIVESUBFLOATO(p1, p2, p3);

Description

Set given sub component of a vector attribute in 'relative' way (the value is added to the current value, not assigned).

R3OLAYM_UNSELECTCHILDANDANC

Method

UNSELECTCHILDANDANC

Identifier

R3OLAYM_UNSELECTCHILDANDANC

JavaScript

obj.UNSELECTCHILDANDANC();

Description

Unselect children and anchestors.

R3OLAYM_SELECTOBJRANGE

Method

SELECTOBJRANGE

Identifier

R3OLAYM_SELECTOBJRANGE

Param 3:

R3OBJ*, end of selection range

JavaScript

obj.SELECTOBJRANGE(p3);

Description

Select range of objects, from the first previosly selected to the given object p3

R3OLAYM_EXECSELECTEDIDLES

Method

EXECSELECTEDIDLES

Identifier

R3OLAYM_EXECSELECTEDIDLES

Param 1:

R3INT, method, if != 0 only these methods are removed/executed

Param 2:

R3BOOL, dont_execute, if TRUE selected idle messages are removed but not executed

JavaScript

obj.EXECSELECTEDIDLES(p1, p2, 0);

Description

Execute selected idle messages

R3OLAYCM_REGISTERCHANGETOIGN

Method

REGISTERCHANGETOIGN

Identifier

R3OLAYCM_REGISTERCHANGETOIGN

Param 3:

R3INT, tag to ignore

JavaScript

obj.REGISTERCHANGETOIGN(p3);

Description

Register R3MM_CHANGED tags that do not cause layer to be dirty.

R3OLAYM_SETCURRENTTIME

Method

SETCURRENTTIME

Identifier

R3OLAYM_SETCURRENTTIME

Param 1:

R3BOOL, if true, don't send R3MM_CHANGED

Param 3:

R3FLOAT, new time

JavaScript

obj.SETCURRENTTIME(p1, p3);

Description

Set current time.

R3OLAYM_REGISTERCHANGECALLBA

Method

REGISTERCHANGECALLBA

Identifier

R3OLAYM_REGISTERCHANGECALLBA

Param 1:

R3OBJ*, callback target

Param 2:

R3INT, callback method

Param 3:

void*, additional context

JavaScript

obj.REGISTERCHANGECALLBA(p1, p2, p3);

Description

Register a simple callback hook that is called when layer is changed: * R3DoA2(cbobj, cbthm, context, changetaglist);

R3OLAYM_FREECHANGECALLBACKS

Method

FREECHANGECALLBACKS

Identifier

R3OLAYM_FREECHANGECALLBACKS

JavaScript

obj.FREECHANGECALLBACKS();

Description

Frees the callback list

R3OLAYM_CHORNOTIFICATION

Method

CHORNOTIFICATION

Identifier

R3OLAYM_CHORNOTIFICATION

JavaScript

obj.CHORNOTIFICATION();

Description

Notification for choreography creation/deletion

R3OLAYM_SHOWMSG

Method

SHOWMSG

Identifier

R3OLAYM_SHOWMSG

Return

R3BOOL, true if there was a progress model associated with the layer

Param 3:

char*, message to be shown

JavaScript

rc = obj.SHOWMSG(p3);

Description

Show message to the user. This sets the given string to * the progress indicator model and logs the message to the * app.log via R3AppInfo().

R3OLAYM_REMOVEREFERENCES

Method

REMOVEREFERENCES

Identifier

R3OLAYM_REMOVEREFERENCES

Param 1:

R3BOOL, permanently

Param 3:

R3OBJ*, target object

JavaScript

obj.REMOVEREFERENCES(p1, p3);

Description

Invalidate or remove inter object references. If 'target' is NULL, all references are invalidated/removed. If not, refrences to the given target only is removed. If 'p1' is TRUE, references are removed permanently. If 'p1' is FALSE, references are only invalidated. This method is called internally when an object is removed from the layer, or deleted.

R3OLAYM_RELEASESHAREDYIELDS

Method

RELEASESHAREDYIELDS

Identifier

R3OLAYM_RELEASESHAREDYIELDS

Param 3:

R3OBJ*, object that called the R3OLAYM_LOCKSHAREDYIELDS

JavaScript

obj.RELEASESHAREDYIELDS(p3);

Description

Release the lock called via R3OLAYM_LOCKSHAREDYIELDS wants an exclusive lock.

R3OLAYM_PURGEUNRESOLVED

Method

PURGEUNRESOLVED

Identifier

R3OLAYM_PURGEUNRESOLVED

JavaScript

obj.PURGEUNRESOLVED();

Description

Remove unresolved references.

R3OLAYM_OPTRESOLV

Method

OPTRESOLV

Identifier

R3OLAYM_OPTRESOLV

Return

R3OBJ*, resolved object

Param 1:

R3INT, identifier for R3TTM_FINDTAGCLOSE

Param 3:

void*, unique identifier value for R3TTM_FINDTAGCLOSE

JavaScript

rc = obj.OPTRESOLV(p1, p3);

Description

Do optimized R3TTM_FINDTAGCLOSE. This calls * R3OLAYM_OPTRESOLVEBEGIN method, if not already called, * and runs optimized r3ttm_findtagclose. The optimization * data is released in R3OLAYM_RELEASE.

R3OLAYM_SETCURRENTFRAME

Method

SETCURRENTFRAME

Identifier

R3OLAYM_SETCURRENTFRAME

Param 3:

R3INT, current frame

JavaScript

obj.SETCURRENTFRAME(p3);

Description

Set current frame.

R3OLAYM_GETCURRENTFRAME

Method

GETCURRENTFRAME

Identifier

R3OLAYM_GETCURRENTFRAME

Param 3:

R3INT*, current frame

JavaScript

obj.GETCURRENTFRAME(p3);

Description

Set current frame.

R3OLAYM_SELECTAFTERUNDO

Method

SELECTAFTERUNDO

Identifier

R3OLAYM_SELECTAFTERUNDO

Param 3:

void*, private

JavaScript

obj.SELECTAFTERUNDO(p3);

Description

Update selected list after undo and redo. Private.

R3OLAYM_BEGINSELECTION

Method

BEGINSELECTION

Identifier

R3OLAYM_BEGINSELECTION

JavaScript

obj.BEGINSELECTION();

Description

Starts optimized selection. Should be followed by * R3OLAYM_ENDSELECTION which updates object selection specific sub systems

R3OLAYM_ENDSELECTION

Method

ENDSELECTION

Identifier

R3OLAYM_ENDSELECTION

JavaScript

obj.ENDSELECTION();

Description

Finishes optimized selection.

R3OLAYM_SUSPENDYIELDS

Method

SUSPENDYIELDS

Identifier

R3OLAYM_SUSPENDYIELDS

Param 3:

R3OBJ*, object that called the R3OLAYM_LOCKSHAREDYIELDS

JavaScript

obj.SUSPENDYIELDS(p3);

Description

Unlock but keep the yield node so that layer can report back yield_done method

R3OLAYM_RESUMEYIELDS

Method

RESUMEYIELDS

Identifier

R3OLAYM_RESUMEYIELDS

Param 3:

R3OBJ*, object that called the R3OLAYM_LOCKSHAREDYIELDS

JavaScript

obj.RESUMEYIELDS(p3);

Description

Unlock but keep the yield node so that layer can report back yield_done method

R3OLAYCM_REGISTEREXTENSION

Method

REGISTEREXTENSION

Identifier

R3OLAYCM_REGISTEREXTENSION

Return

R3BOOL, true if succeeded.

Param 1:

R3CLID, class id of the extension object

Param 3:

R3INT, unique identifier

JavaScript

rc = obj.REGISTEREXTENSION(p1, p3);

Description

Register extension object that gets created and * deleted with the object.

R3OLAYM_STARTOBJECT

Method

STARTOBJECT

Identifier

R3OLAYM_STARTOBJECT

Param 3:

R3OBJ*, object which is just inserted to layer from the undo buffer

JavaScript

obj.STARTOBJECT(p3);

Description

This method is called, for example, when an object is inserted to layer from undo buffer. * Object should be prepared for use in the current project

R3OLAYM_STOPOBJECT

Method

STOPOBJECT

Identifier

R3OLAYM_STOPOBJECT

Param 3:

R3OBJ*, object which should be stopped

JavaScript

obj.STOPOBJECT(p3);

Description

This method is called, for example, when an object is copied to undo layer * Object should be prepared for passive state

R3OLAYM_FINDEXTENSION

Method

FINDEXTENSION

Identifier

R3OLAYM_FINDEXTENSION

Return

R3OBJ*, extension object

Param 3:

R3INT, extension identifier

JavaScript

rc = obj.FINDEXTENSION(p3);

Description

Find extension object associated with the layer

SelectList

Attribute

SelectList

Identifier

R3OLAYA_SelectList

JavaScript type

Object

C type

R3OBJ*

Description

R3RM_GET, layers select list

Syntax


value = jsobj.GetSelectList();


R3OBJ* value;
R3GetAttrs(r3obj, R3OLAYA_SelectList, &value, R3TAG_END);

UndoDepth

Attribute

UndoDepth

Identifier

R3OLAYA_UndoDepth

JavaScript type

Integer

C type

R3INT

Description

R3RM_SET, max size of undo list

Syntax


jsobj.SetUndoDepth(value);
value = jsobj.GetUndoDepth();


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

CurrentUndos

Attribute

CurrentUndos

Identifier

R3OLAYA_CurrentUndos

JavaScript type

Integer

C type

R3INT

Description

R3RM_GET, current size of undo list

Syntax


value = jsobj.GetCurrentUndos();


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

ClipBoard

Attribute

ClipBoard

Identifier

R3OLAYA_ClipBoard

JavaScript type

Object

C type

R3OBJ*

Description

R3RM_CREATE, clipboard to use

Syntax


jsobj.SetClipBoard(value);


R3OBJ* value = ...;
R3SetAttrs(r3obj, R3OLAYA_ClipBoard, value, R3TAG_END);

ClipClass

Attribute

ClipClass

Identifier

R3OLAYA_ClipClass

JavaScript type

Integer

C type

R3INT

Description

R3RM_SET/GET, for subclasses only, type of objects in clipboard

Syntax


jsobj.SetClipClass(value);
value = jsobj.GetClipClass();


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

ProgressIndicator

Attribute

ProgressIndicator

Identifier

R3OLAYA_ProgressIndicator

JavaScript type

Object

C type

R3OBJ*

Description

R3RM_SET, progress indicator to use

Syntax


jsobj.SetProgressIndicator(value);
value = jsobj.GetProgressIndicator();


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

CurrentRedos

Attribute

CurrentRedos

Identifier

R3OLAYA_CurrentRedos

JavaScript type

Integer

C type

R3INT

Description

R3RM_GET, current size of redo list

Syntax


value = jsobj.GetCurrentRedos();


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

AddKeyResol

Attribute

AddKeyResol

Identifier

R3OLAYA_AddKeyResol

JavaScript type

Number

C type

R3FLOAT

Description

for animations

Syntax


jsobj.SetAddKeyResol(value);
value = jsobj.GetAddKeyResol();


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

FindTagObj

Attribute

FindTagObj

Identifier

R3OLAYA_FindTagObj

JavaScript type

Object

C type

R3OBJ*

Description

object to be called if object can't be found in this layer

Syntax


jsobj.SetFindTagObj(value);
value = jsobj.GetFindTagObj();


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

FindTagMth

Attribute

FindTagMth

Identifier

R3OLAYA_FindTagMth

JavaScript type

Integer

C type

R3INT

Description

tag find methdod for FindTagObj

Syntax


jsobj.SetFindTagMth(value);
value = jsobj.GetFindTagMth();


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

CurrentTime

Attribute

CurrentTime

Identifier

R3OLAYA_CurrentTime

JavaScript type

Number

C type

R3FLOAT

Description

current time

Syntax


jsobj.SetCurrentTime(value);
value = jsobj.GetCurrentTime();


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

Modified

Attribute

Modified

Identifier

R3OLAYA_Modified

JavaScript type

Boolean

C type

R3BOOL

Description

set when modified, cleared by save

Syntax


jsobj.SetModified(value);
value = jsobj.GetModified();


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

EndTime

Attribute

EndTime

Identifier

R3OLAYA_EndTime

JavaScript type

Number

C type

R3FLOAT

Description

length of the time space

Syntax


jsobj.SetEndTime(value);
value = jsobj.GetEndTime();


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

RemoveReferencesMth

Attribute

RemoveReferencesMth

Identifier

R3OLAYA_RemoveReferencesMth

JavaScript type

Integer

C type

R3INT

Description

callback method for invalidating references to deleted objects

Syntax


jsobj.SetRemoveReferencesMth(value);


R3INT value = ...;
R3SetAttrs(r3obj, R3OLAYA_RemoveReferencesMth, value, R3TAG_END);

Open

Attribute

Open

Identifier

R3OLAYA_Open

JavaScript type

Boolean

C type

R3BOOL

Description

open/close the level

Syntax


jsobj.SetOpen(value);
value = jsobj.GetOpen();


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

AsyncExecutor

Attribute

AsyncExecutor

Identifier

R3OLAYA_AsyncExecutor

JavaScript type

Object

C type

R3OBJ*

Description

async. executor thread

Syntax


jsobj.SetAsyncExecutor(value);
value = jsobj.GetAsyncExecutor();


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

NoLocking

Attribute

NoLocking

Identifier

R3OLAYA_NoLocking

JavaScript type

Boolean

C type

R3BOOL

Description

set to true if locking is not needed for this layer

Syntax


jsobj.SetNoLocking(value);
value = jsobj.GetNoLocking();


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

ChangeCount

Attribute

ChangeCount

Identifier

R3OLAYA_ChangeCount

JavaScript type

Integer

C type

R3INT

Description

running counter of received MM_CHANGED events. Read only.

Syntax


value = jsobj.GetChangeCount();


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

NoChangeCounting

Attribute

NoChangeCounting

Identifier

R3OLAYA_NoChangeCounting

JavaScript type

Boolean

C type

R3BOOL

Description

use this to filter temporarily undesired change counting changes

Syntax


jsobj.SetNoChangeCounting(value);
value = jsobj.GetNoChangeCounting();


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

ChangeCallbacks

Attribute

ChangeCallbacks

Identifier

R3OLAYA_ChangeCallbacks

JavaScript type

Boolean

C type

R3BOOL

Description

enables/disables (e.g. during loading) change callbacks. Default off.

Syntax


jsobj.SetChangeCallbacks(value);
value = jsobj.GetChangeCallbacks();


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

NumObjects

Attribute

NumObjects

Identifier

R3OLAYA_NumObjects

JavaScript type

Integer

C type

R3INT

Description

R3RM_GET only, number of objects in the layer

Syntax


value = jsobj.GetNumObjects();


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

AnimRecord

Attribute

AnimRecord

Identifier

R3OLAYA_AnimRecord

JavaScript type

Boolean

C type

R3BOOL

Description

anim record on/off

Syntax


jsobj.SetAnimRecord(value);
value = jsobj.GetAnimRecord();


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

DeleteReferencesMth

Attribute

DeleteReferencesMth

Identifier

R3OLAYA_DeleteReferencesMth

JavaScript type

Integer

C type

R3INT

Description

callback method for deleting references to deleted objects

Syntax


jsobj.SetDeleteReferencesMth(value);


R3INT value = ...;
R3SetAttrs(r3obj, R3OLAYA_DeleteReferencesMth, value, R3TAG_END);

UnitConverter

Attribute

UnitConverter

Identifier

R3OLAYA_UnitConverter

JavaScript type

Object

C type

R3OBJ*

Description

unit converter: note, r3layer gives this for us, read only

Syntax


jsobj.SetUnitConverter(value);
value = jsobj.GetUnitConverter();


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

OptResolvMth

Attribute

OptResolvMth

Identifier

R3OLAYA_OptResolvMth

JavaScript type

Integer

C type

R3INT

Description

callback method id for optimized resolv.

Syntax


jsobj.SetOptResolvMth(value);


R3INT value = ...;
R3SetAttrs(r3obj, R3OLAYA_OptResolvMth, value, R3TAG_END);

OptResolvInvMth

Attribute

OptResolvInvMth

Identifier

R3OLAYA_OptResolvInvMth

JavaScript type

Integer

C type

R3INT

Description

callback for invalidating opt data

Syntax


jsobj.SetOptResolvInvMth(value);


R3INT value = ...;
R3SetAttrs(r3obj, R3OLAYA_OptResolvInvMth, value, R3TAG_END);