r3view

Class

real/widget/r3view.h

Library

r3wid

Description:

View Window Class

See Also

oops/r3window.h

See Also

oops/r36dof.h

Super Class

r3Window

R3CLID_WINDOW

JavaScript

r3View

Class Identifier

R3CLID_VIEW - 15

Methods

MOVEDISPATCH, DOREFRESH, REGISTERPRIMMENU, REGISTERDROPHANDLER, DROP, ATTACHMAPPING, REGISTERDROPMAPHANDLER, MENUSETHOTPOINT, DEFINEHOTPOINT, WORLDORIGIN, DEFINEWORLDORIGIN, FITCLIPPING, SAVEWINDOWIMAGE, BROWSEANDSAVEIMAGE, SAVEIMAGE, SETHOTPOINT, ENTERINTERACTION, REFRESHRTANDBACKUP, SHOWRTBACKUP2, SHOWRTBACKUP, DRIVE, REGISTERFILEDROPGEOMET, REGISTERFILEDROPHANDLE, REGISTERINPUTDEVICE, INITCHANNELMENU, CLEARCHANNELMENU, ADDCHANNEL, DOBROWSEANDSAVEIMAGE,

Attributes

ViewModel, ViewList, ForceLayer, MainDraw, ModifyDraw, CurrentInteractor, DoubleClickCallbackObj, DoubleClickCallbackMth, DoubleClickCallbackPara, CompassName, ViewListEnumMth, RSpecs, Channels, Layer, ViewAutoSelectTag, ViewModelName, Primitives, ActiveCallbackMth,

Registration

int R3RegisterViewClass(R3APP *app);

R3VM_MOVEDISPATCH

Method

MOVEDISPATCH

Identifier

R3VM_MOVEDISPATCH

JavaScript

obj.MOVEDISPATCH();

Description

R3VM_DOREFRESH

Method

DOREFRESH

Identifier

R3VM_DOREFRESH

JavaScript

obj.DOREFRESH();

Description

R3VCM_REGISTERPRIMMENU

Method

REGISTERPRIMMENU

Identifier

R3VCM_REGISTERPRIMMENU

Return

R3BOOL, true if succeeded

Param 1:

R3CLID, class id for context sensitivity. Pass NULL for non-context sensitive menus

Param 3:

R3TAG*, R3VA_ModelClass, R3VA_MenuStrip

JavaScript

rc = obj.REGISTERPRIMMENU(p1, p3);

Description

Install new context sensitive menu. The menu is shown when the user selects objects specified by given class id. When the menu is selected, the specified callback is called as: callback(R3OBJ *view, R3OBJ *model). 'model' is an object instanced from the given class id.

R3VCM_REGISTERDROPHANDLER

Method

REGISTERDROPHANDLER

Identifier

R3VCM_REGISTERDROPHANDLER

Return

R3BOOL, true if handler registration succeeded

Param 1:

R3CLID, class id of drop object to be handled

Param 2:

R3INT, callback class

Param 3:

R3INT, callback method.

JavaScript

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

Description

Register new drop handler to a view window. When an object * is dropped to a view window, the handler corresponding to the class id of the dropped object will be called as follows: 'R3SendClassMsgA3(handler_class, handler_method, view, NULL, dropped_obj);'

R3VCM_DROP

Method

DROP

Identifier

R3VCM_DROP

Return

R3BOOL, true if dropped object handled and freed by the caller

Param 1:

R3OBJ*, view

Param 3:

R3OBJ*, dropped object (color, defaultmap etc.)

JavaScript

rc = obj.DROP(p1, p3);

Description

View's callback method for registerdrophandler method.

R3VM_ATTACHMAPPING

Method

ATTACHMAPPING

Identifier

R3VM_ATTACHMAPPING

JavaScript

obj.ATTACHMAPPING();

Description

R3VCM_REGISTERDROPMAPHANDLER

Method

REGISTERDROPMAPHANDLER

Identifier

R3VCM_REGISTERDROPMAPHANDLER

Return

R3BOOL, true if successfully registered

Param 1:

R3CLID, class id of the geometric object to be handled

JavaScript

rc = obj.REGISTERDROPMAPHANDLER(p1, 0);

Description

Register new 'material mapping' handler function for drag&drop interface. The handler is responsible for returning a map object for the geometric object in question. The handler function is of form: R3OBJ * (*)(R3OBJ *target, R3OBJ *defmap); The handler fetches the name and material from the passed default map object and creates the actual mapping primitive based on the geometry of the 'target' object.

R3VM_MENUSETHOTPOINT

Method

MENUSETHOTPOINT

Identifier

R3VM_MENUSETHOTPOINT

JavaScript

obj.MENUSETHOTPOINT();

Description

R3VM_DEFINEHOTPOINT

Method

DEFINEHOTPOINT

Identifier

R3VM_DEFINEHOTPOINT

JavaScript

obj.DEFINEHOTPOINT();

Description

R3VM_WORLDORIGIN

Method

WORLDORIGIN

Identifier

R3VM_WORLDORIGIN

JavaScript

obj.WORLDORIGIN();

Description

R3VM_DEFINEWORLDORIGIN

Method

DEFINEWORLDORIGIN

Identifier

R3VM_DEFINEWORLDORIGIN

JavaScript

obj.DEFINEWORLDORIGIN();

Description

R3VM_FITCLIPPING

Method

FITCLIPPING

Identifier

R3VM_FITCLIPPING

JavaScript

obj.FITCLIPPING();

Description

R3VM_SAVEWINDOWIMAGE

Method

SAVEWINDOWIMAGE

Identifier

R3VM_SAVEWINDOWIMAGE

Param 3:

char*, file name

JavaScript

obj.SAVEWINDOWIMAGE(p3);

Description

Saves the window contents (image) to a file.

R3VM_BROWSEANDSAVEIMAGE

Method

BROWSEANDSAVEIMAGE

Identifier

R3VM_BROWSEANDSAVEIMAGE

JavaScript

obj.BROWSEANDSAVEIMAGE();

Description

R3VM_SAVEIMAGE

Method

SAVEIMAGE

Identifier

R3VM_SAVEIMAGE

JavaScript

obj.SAVEIMAGE();

Description

R3VM_SETHOTPOINT

Method

SETHOTPOINT

Identifier

R3VM_SETHOTPOINT

Param 3:

R3VECTOR, hot point in abs space

JavaScript

obj.SETHOTPOINT(p3);

Description

Set hot point for the view window

R3VM_ENTERINTERACTION

Method

ENTERINTERACTION

Identifier

R3VM_ENTERINTERACTION

Param 1:

R3BOOL, must be true

Param 3:

R3WINDOWEVENT*, mouse event

JavaScript

obj.ENTERINTERACTION(p1, p3);

Description

Enter interactive panning/editing/zooming.

R3VM_REFRESHRTANDBACKUP

Method

REFRESHRTANDBACKUP

Identifier

R3VM_REFRESHRTANDBACKUP

JavaScript

obj.REFRESHRTANDBACKUP();

Description

R3VM_SHOWRTBACKUP2

Method

SHOWRTBACKUP2

Identifier

R3VM_SHOWRTBACKUP2

JavaScript

obj.SHOWRTBACKUP2();

Description

R3VM_SHOWRTBACKUP

Method

SHOWRTBACKUP

Identifier

R3VM_SHOWRTBACKUP

JavaScript

obj.SHOWRTBACKUP();

Description

R3VM_DRIVE

Method

DRIVE

Identifier

R3VM_DRIVE

JavaScript

obj.DRIVE();

Description

R3VCM_REGISTERFILEDROPGEOMET

Method

REGISTERFILEDROPGEOMET

Identifier

R3VCM_REGISTERFILEDROPGEOMET

Return

R3BOOL, true if handler registration succeeded

Param 1:

R3CLID, class id of drop object to be handled

Param 2:

R3INT, callback class

Param 3:

R3INT, callback method.

JavaScript

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

Description

Register new drop handler to a view window. This handler deals with geometry objects of a dropped file object. The handler corresponding to the class id of the root geometry of a dropped file is called as follows: 'R3SendClassMsgA3(handler_class, handler_method, iplane_csys, primlayer, geom_obj);'

R3VCM_REGISTERFILEDROPHANDLE

Method

REGISTERFILEDROPHANDLE

Identifier

R3VCM_REGISTERFILEDROPHANDLE

Return

R3BOOL, true if handler registration succeeded

Param 1:

R3INT, callback class

Param 3:

R3INT, callback method.

JavaScript

rc = obj.REGISTERFILEDROPHANDLE(p1, p3);

Description

Register new drop handler to a view window. This handler is called when something is dropped alt key held down. The handler corresponding to the class id of the root geometry of a dropped file is called as follows: 'R3SendClassMsgA3(handler_class, handler_method, iplane_csys (origin=drop_pos), primlayer, fname);' if the handler returns nonzero value, callback loop stops.

R3VCM_REGISTERINPUTDEVICE

Method

REGISTERINPUTDEVICE

Identifier

R3VCM_REGISTERINPUTDEVICE

Return

R3BOOL, true if handler registration succeeded

Param 1:

R3CLID, class id identifying the input device

JavaScript

rc = obj.REGISTERINPUTDEVICE(p1, 0);

Description

Register new input device. The device is initialized and closed with the view window.

R3VM_INITCHANNELMENU

Method

INITCHANNELMENU

Identifier

R3VM_INITCHANNELMENU

JavaScript

obj.INITCHANNELMENU();

Description

R3VM_CLEARCHANNELMENU

Method

CLEARCHANNELMENU

Identifier

R3VM_CLEARCHANNELMENU

JavaScript

obj.CLEARCHANNELMENU();

Description

R3VM_ADDCHANNEL

Method

ADDCHANNEL

Identifier

R3VM_ADDCHANNEL

JavaScript

obj.ADDCHANNEL();

Description

R3VM_DOBROWSEANDSAVEIMAGE

Method

DOBROWSEANDSAVEIMAGE

Identifier

R3VM_DOBROWSEANDSAVEIMAGE

JavaScript

obj.DOBROWSEANDSAVEIMAGE();

Description

ViewModel

Attribute

ViewModel

Identifier

R3VA_ViewModel

JavaScript type

Object

C type

R3OBJ*

Description

view model containing attributes to be saved

Syntax

jsobj.SetViewModel(value);
value = jsobj.GetViewModel();

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

ViewList

Attribute

ViewList

Identifier

R3VA_ViewList

JavaScript type

Object

C type

R3OBJ*

Description

whatever system above us which supports 'enumviews' method

Syntax

jsobj.SetViewList(value);

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

ForceLayer

Attribute

ForceLayer

Identifier

R3VA_ForceLayer

JavaScript type

Object

C type

R3OBJ*

Description

current layer

Syntax

jsobj.SetForceLayer(value);

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

MainDraw

Attribute

MainDraw

Identifier

R3VA_MainDraw

JavaScript type

Object

C type

R3OBJ*

Description

Get only for subclasses

Syntax

value = jsobj.GetMainDraw();

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

ModifyDraw

Attribute

ModifyDraw

Identifier

R3VA_ModifyDraw

JavaScript type

Object

C type

R3OBJ*

Description

Get only for subclasses

Syntax

value = jsobj.GetModifyDraw();

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

CurrentInteractor

Attribute

CurrentInteractor

Identifier

R3VA_CurrentInteractor

JavaScript type

Object

C type

R3OBJ*

Description

'R3VA_CurrentInteractor' not documented

Syntax

value = jsobj.GetCurrentInteractor();

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

DoubleClickCallbackObj

Attribute

DoubleClickCallbackObj

Identifier

R3VA_DoubleClickCallbackObj

JavaScript type

Object

C type

R3OBJ*

Description

object to be notified

Syntax

jsobj.SetDoubleClickCallbackObj(value);

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

DoubleClickCallbackMth

Attribute

DoubleClickCallbackMth

Identifier

R3VA_DoubleClickCallbackMth

JavaScript type

Integer

C type

R3INT

Description

notif. method

Syntax

jsobj.SetDoubleClickCallbackMth(value);

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

DoubleClickCallbackPara

Attribute

DoubleClickCallbackPara

Identifier

R3VA_DoubleClickCallbackPara

JavaScript type

String

C type

void*

Description

'R3VA_DoubleClickCallbackParam' not documented

Syntax

jsobj.SetDoubleClickCallbackPara(value);
value = jsobj.GetDoubleClickCallbackPara();

void* value = ...;
R3SetAttrs(r3obj, R3VA_DoubleClickCallbackParam, value, R3TAG_END);
void* value;
R3GetAttrs(r3obj, R3VA_DoubleClickCallbackParam, &value, R3TAG_END);

CompassName

Attribute

CompassName

Identifier

R3VA_CompassName

JavaScript type

String

C type

char*

Description

base name for compasses in this view

Syntax

value = jsobj.GetCompassName();

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

ViewListEnumMth

Attribute

ViewListEnumMth

Identifier

R3VA_ViewListEnumMth

JavaScript type

Integer

C type

R3INT

Description

method for R3WA_ViewList for enumerating all views

Syntax

jsobj.SetViewListEnumMth(value);

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

RSpecs

Attribute

RSpecs

Identifier

R3VA_RSpecs

JavaScript type

Object

C type

R3OBJ*

Description

rendering settings

Syntax

jsobj.SetRSpecs(value);

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

Channels

Attribute

Channels

Identifier

R3VA_Channels

JavaScript type

Object

C type

R3OBJ*

Description

user defined channels

Syntax

jsobj.SetChannels(value);
value = jsobj.GetChannels();

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

Layer

Attribute

Layer

Identifier

R3VA_Layer

JavaScript type

Object

C type

R3OBJ*

Description

Get only for subclasses

Syntax

jsobj.SetLayer(value);
value = jsobj.GetLayer();

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

ViewAutoSelectTag

Attribute

ViewAutoSelectTag

Identifier

R3VA_ViewAutoSelectTag

JavaScript type

Integer

C type

R3INT

Description

call R3SetAttrs(R3VA_ViewList, R3VA_ViewAutoSelectTag, view, ..) to make the view the current view

Syntax

jsobj.SetViewAutoSelectTag(value);

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

ViewModelName

Attribute

ViewModelName

Identifier

R3VA_ViewModelName

JavaScript type

String

C type

char*

Description

Syntax

jsobj.SetViewModelName(value);
value = jsobj.GetViewModelName();

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

Primitives

Attribute

Primitives

Identifier

R3VA_Primitives

JavaScript type

Object

C type

R3OBJ*

Description

read only

Syntax

value = jsobj.GetPrimitives();

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

ActiveCallbackMth

Attribute

ActiveCallbackMth

Identifier

R3VA_ActiveCallbackMth

JavaScript type

Integer

C type

R3INT

Description

notif. method

Syntax

jsobj.SetActiveCallbackMth(value);
value = jsobj.GetActiveCallbackMth();

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

Tags

R3VA_PreferredMapping

R3VA_MapFixedSize

R3VA_MapFixedProportions

R3VA_PostProcOnly

R3VA_BackupRT

R3VA_ModelClid

R3VA_PreferredPriority