r3vmod

r3vmod2d

r3vmod

Class

real/intact/r3vmod.h

Library

r3ia

Description:

View Model Class. This model contains View window specific options which needs to be saved.

See Also

oops/r3model.h

See Also

real/code/r3vcam.h

Super Class

r3Model

R3CLID_MODEL

JavaScript

r3Viewmodel

Class Identifier

R3CLID_VIEWMODEL - 90

Methods

REGISTEREXTENSION, FINDEXTENSION, SETMACRO, GETMACRO, SETNATIVEORIENTATION, GOTONATIVEORIENTATIO, ROTATE, GETCURRENTCANVAS, UPDATECANVAS, SYNCIPANDCAMERA, RESET, CAMERACALL, ROTATETOMAIN, MAKECOMPASSNAME, FITCLIPPING, IPCALL, UPDATECAMERA, IMAGECHANGED, PUSH, POP, FRONT, SIDE, TOP, RECURSIONSTOP, TRACKOUT,

Attributes

VCam, Left, Top, Width, Height, SubWin, AspectRatio, Projection, Position, Aimpoint, Heading, IPlaneHeading, Scale, DepthOfField, FStop, FocalDistance, CoordSys, IPCoordSys, Distance, View, StickyLayer, RSpecName, CanvasFlags, Shaded, RayTrace, ObjectColors, DrawOnlyVirtualRoot, GridSnap, GridDraw, ObjectsAreInputPlane, CanvasClass, TransformTarget, TransformType, AttachToCamera, AttachToCameraName, Camera, UseDisplayLists, SyncDrawing, EffectName, AbsGrid, DisableComposition, Hotpoint, DrawBoundingBox, DrawRotateHandle, GridName, ImageName, BackdropImage, UseCanvasAsBackdrop, FilmSensitivity, Flash, CamOrigin, CamDirection, LensFlare, FilmWidth, CenterCoordSys, CornerCoordSys, KeepIPlaneOrthogonal, OverScan, BoxRelX, BoxRelY, BoxRelW, BoxRelH, RenderBoxActive, ImageAspect, RelHeading, RelIPlaneHeading, SizeLocked, DrawAimPoint, DrawHotPoint, MinClipDist, MaxClipDist, CaptureRayTrace, HiddenVisibility, AnimationPreviewOutp, AnimationPreviewFile, DitheringScale, NoMaterialUpdates, AttachToIPlane, BackdropWeight, DrawOnlySelected, IsTempImage, NoVertPersp, RayTraceCache, ImageEffectName, FieldEffectName, FrameEffectName, DrawingDisabled, Is2D, ViewCount, RotationFriction, VelocityFriction, EnginePower, Active, Locking, NoAutoRedraw, FixBackdropAspect, AutoEffects, BackupRayTrace, Navigation, NativeCoordSys, DrawLabel, BoxOrder,

Registration

int R3RegisterVmodClass(R3APP *app);

R3VMODCM_REGISTEREXTENSION

Method

REGISTEREXTENSION

Identifier

R3VMODCM_REGISTEREXTENSION

Return

R3BOOL, TRUE if succeeded.

Param 1:

char*, name for the model

Param 2:

R3INT, class id of the model to be created

Param 3:

R3TAG*, for future exapand, currently not used.

JavaScript

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

Description

Ask view model to create extension model object

R3VMODM_FINDEXTENSION

Method

FINDEXTENSION

Identifier

R3VMODM_FINDEXTENSION

Return

R3OBJ*, address of the found model object or NULL if not found

Param 3:

R3INT, class id of the model to be searched

JavaScript

rc = obj.FINDEXTENSION(p3);

Description

Find extension model object by its class id.

R3VMODM_SETMACRO

Method

SETMACRO

Identifier

R3VMODM_SETMACRO

Return

void*, TRUE if successful

Param 3:

char*, macro name

JavaScript

rc = obj.SETMACRO(p3);

Description

Sets a macro name for a given compass direction and distance.

R3VMODM_GETMACRO

Method

GETMACRO

Identifier

R3VMODM_GETMACRO

Return

char*, the macro name

JavaScript

rc = obj.GETMACRO();

Description

Gets the macro name for a given compass direction and distance.

R3VMODM_SETNATIVEORIENTATION

Method

SETNATIVEORIENTATION

Identifier

R3VMODM_SETNATIVEORIENTATION

JavaScript

obj.SETNATIVEORIENTATION();

Description

Sets the current orientation of view camera as the native orientation

R3VMODM_GOTONATIVEORIENTATIO

Method

GOTONATIVEORIENTATIO

Identifier

R3VMODM_GOTONATIVEORIENTATIO

JavaScript

obj.GOTONATIVEORIENTATIO();

Description

resets the view camera to its native orientation

R3VMODM_ROTATE

Method

ROTATE

Identifier

R3VMODM_ROTATE

Param 1:

R3FLOAT, amount of horiz. rotation in radians

Param 2:

R3FLOAT, amount of vert. rotation in radians

Param 3:

R3INT, rotate flags as defined below, defines what to rotate

JavaScript

obj.ROTATE(p1, p2, p3);

Description

rotates view's camera in its native orientation

R3VMODM_GETCURRENTCANVAS

Method

GETCURRENTCANVAS

Identifier

R3VMODM_GETCURRENTCANVAS

Return

R3OBJ*, address of the canvas specific model.

JavaScript

rc = obj.GETCURRENTCANVAS();

Description

Fetch canvas specific options of the current canvas

R3VMODM_UPDATECANVAS

Method

UPDATECANVAS

Identifier

R3VMODM_UPDATECANVAS

Param 3:

R3OBJ*, address of the canvas object

JavaScript

obj.UPDATECANVAS(p3);

Description

Ask canvas specific model to update options of the currently selected canvas.

R3VMODM_SYNCIPANDCAMERA

Method

SYNCIPANDCAMERA

Identifier

R3VMODM_SYNCIPANDCAMERA

Param 3:

R3INT, specifies what is rotated to orthogonal position

JavaScript

obj.SYNCIPANDCAMERA(p3);

Description

'Sychnronizes' iplane/camera/world orientation

R3VMODM_RESET

Method

RESET

Identifier

R3VMODM_RESET

Param 3:

R3INT, specifies what is resetted and how

JavaScript

obj.RESET(p3);

Description

Resets view or world depending on p3 specifier defined below

R3VMODM_CAMERACALL

Method

CAMERACALL

Identifier

R3VMODM_CAMERACALL

JavaScript

obj.CAMERACALL();

Description

R3VMODM_ROTATETOMAIN

Method

ROTATETOMAIN

Identifier

R3VMODM_ROTATETOMAIN

Param 1:

R3INT, rotate flags as defined below, defines what to rotate

Param 3:

R3INT, see rotate directions below

JavaScript

obj.ROTATETOMAIN(p1, p3);

Description

Rotates from current view to closest main native projection axis direction

R3VMODCM_MAKECOMPASSNAME

Method

MAKECOMPASSNAME

Identifier

R3VMODCM_MAKECOMPASSNAME

Param 1:

char*, buffer for the name to be generated

JavaScript

obj.MAKECOMPASSNAME(p1, 0);

Description

Class method. Create symbolic name for a compass

R3VMODM_FITCLIPPING

Method

FITCLIPPING

Identifier

R3VMODM_FITCLIPPING

JavaScript

obj.FITCLIPPING();

Description

Match min & max clipping distance by selected objects

R3VMODM_IPCALL

Method

IPCALL

Identifier

R3VMODM_IPCALL

JavaScript

obj.IPCALL();

Description

R3VMODM_UPDATECAMERA

Method

UPDATECAMERA

Identifier

R3VMODM_UPDATECAMERA

JavaScript

obj.UPDATECAMERA();

Description

Update the orientation to mathch the currently activate camera object. * This method is called internally if camera tracking is activated.

R3VMODM_IMAGECHANGED

Method

IMAGECHANGED

Identifier

R3VMODM_IMAGECHANGED

Return

R3BOOL, TRUE if this vmod depends on teh changed image

Param 3:

char*, name of the image OBJECT

JavaScript

rc = obj.IMAGECHANGED(p3);

Description

Tells the vmod object that an image has changed

R3VMODM_PUSH

Method

PUSH

Identifier

R3VMODM_PUSH

Return

R3BOOL, true if succeeded

JavaScript

rc = obj.PUSH();

Description

Pust the current state on stack. The POPSTATE can be used for * restoring the previous state.

R3VMODM_POP

Method

POP

Identifier

R3VMODM_POP

Return

R3BOOL, true if succeeded

JavaScript

rc = obj.POP();

Description

Restore the previous state from the stack.

R3VMODM_FRONT

Method

FRONT

Identifier

R3VMODM_FRONT

Param 3:

R3BOOL, true to invert the direction

JavaScript

obj.FRONT(p3);

Description

Set front view.

R3VMODM_SIDE

Method

SIDE

Identifier

R3VMODM_SIDE

Param 3:

R3BOOL, true to invert the direction

JavaScript

obj.SIDE(p3);

Description

Set side view.

R3VMODM_TOP

Method

TOP

Identifier

R3VMODM_TOP

Param 3:

R3BOOL, true to invert the direction

JavaScript

obj.TOP(p3);

Description

Set top view.

R3VMODM_RECURSIONSTOP

Method

RECURSIONSTOP

Identifier

R3VMODM_RECURSIONSTOP

Param 3:

R3INT, 1 or -1

JavaScript

obj.RECURSIONSTOP(p3);

Description

Optimize camera tracking updates

R3VMODM_TRACKOUT

Method

TRACKOUT

Identifier

R3VMODM_TRACKOUT

JavaScript

obj.TRACKOUT();

Description

If in full tracking mode, update the camera object.

R3VMODM_ROTATETOMAIN direction types:

R3VM_ROTATEUP
R3VM_ROTATEDOWN
R3VM_ROTATELEFT
R3VM_ROTATERIGHT
R3VMRESET_TONATIVE
R3VMRESET_TOFRONTVIEW
R3VMRESET_WORLD

Flags for ROTATE method

R3VMODROTATE_CAMERA
R3VMODROTATE_IPLANE
R3VMODROTATE_BANK
R3VMODROTATE_ABOUTVP

VCam

Attribute

VCam

Identifier

R3VMODA_VCam

JavaScript type

Object

C type

R3OBJ*

Description

viewcam object used for 3d->2D transformations

Syntax


value = jsobj.GetVCam();


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

Left

Attribute

Left

Identifier

R3VMODA_Left

JavaScript type

Integer

C type

R3INT

Description

left, top edge

Syntax


jsobj.SetLeft(value);
value = jsobj.GetLeft();


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

Top

Attribute

Top

Identifier

R3VMODA_Top

JavaScript type

Integer

C type

int

Description

... of the view canvas

Syntax


jsobj.SetTop(value);
value = jsobj.GetTop();


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

Width

Attribute

Width

Identifier

R3VMODA_Width

JavaScript type

Integer

C type

R3INT

Description

width and height of the view canvas

Syntax


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


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

Height

Attribute

Height

Identifier

R3VMODA_Height

JavaScript type

Integer

C type

int

Description

'R3VMODA_Height' not documented

Syntax


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


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

SubWin

Attribute

SubWin

Identifier

R3VMODA_SubWin

JavaScript type

Boolean

C type

R3BOOL

Description

true if sub view

Syntax


jsobj.SetSubWin(value);
value = jsobj.GetSubWin();


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

AspectRatio

Attribute

AspectRatio

Identifier

R3VMODA_AspectRatio

JavaScript type

Number

C type

R3FLOAT

Description

pixel aspect ratio h/w

Syntax


jsobj.SetAspectRatio(value);
value = jsobj.GetAspectRatio();


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

Projection

Attribute

Projection

Identifier

R3VMODA_Projection

JavaScript type

Integer

C type

R3INT

Description

R3VC_PERSPECTIVE/R3VC_ORTHOGRAPHIC

Syntax


jsobj.SetProjection(value);
value = jsobj.GetProjection();


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

Position

Attribute

Position

Identifier

R3VMODA_Position

Type

r3Vect

Description

position of the observer

Syntax


jsobj.SetPosition(value);
value = jsobj.GetPosition();


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

Aimpoint

Attribute

Aimpoint

Identifier

R3VMODA_Aimpoint

Type

r3Vect

Description

aimpoint

Syntax


jsobj.SetAimpoint(value);
value = jsobj.GetAimpoint();


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

Heading

Attribute

Heading

Identifier

R3VMODA_Heading

JavaScript type

Number

C type

R3FLOAT

Description

these three angles define orientation of the camera

Syntax


jsobj.SetHeading(value);
value = jsobj.GetHeading();


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

IPlaneHeading

Attribute

IPlaneHeading

Identifier

R3VMODA_IPlaneHeading

JavaScript type

Number

C type

R3FLOAT

Description

orientation of the input plane (mouse plane)

Syntax


jsobj.SetIPlaneHeading(value);
value = jsobj.GetIPlaneHeading();


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

Scale

Attribute

Scale

Identifier

R3VMODA_Scale

JavaScript type

Number

C type

R3FLOAT

Description

scale for zooming

Syntax


jsobj.SetScale(value);
value = jsobj.GetScale();


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

DepthOfField

Attribute

DepthOfField

Identifier

R3VMODA_DepthOfField

JavaScript type

Boolean

C type

R3BOOL

Description

dof on/off

Syntax


jsobj.SetDepthOfField(value);
value = jsobj.GetDepthOfField();


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

FStop

Attribute

FStop

Identifier

R3VMODA_FStop

JavaScript type

Number

C type

R3FLOAT

Description

for depth-of-field effect

Syntax


jsobj.SetFStop(value);
value = jsobj.GetFStop();


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

FocalDistance

Attribute

FocalDistance

Identifier

R3VMODA_FocalDistance

JavaScript type

Number

C type

R3FLOAT

Description

controls aimpoint distance

Syntax


jsobj.SetFocalDistance(value);
value = jsobj.GetFocalDistance();


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

CoordSys

Attribute

CoordSys

Identifier

R3VMODA_CoordSys

Type

r3Coordsys

Description

orientation of the camera (read only)

Syntax


jsobj.SetCoordSys(value);
value = jsobj.GetCoordSys();


R3COORDSYS value = ...;
R3SetAttrs(r3obj, R3VMODA_CoordSys, &value, R3TAG_END);
R3COORDSYS value;
R3GetAttrs(r3obj, R3VMODA_CoordSys, &value, R3TAG_END);

IPCoordSys

Attribute

IPCoordSys

Identifier

R3VMODA_IPCoordSys

Type

r3Coordsys

Description

orientation of the input plane (read only)

Syntax


jsobj.SetIPCoordSys(value);
value = jsobj.GetIPCoordSys();


R3COORDSYS value = ...;
R3SetAttrs(r3obj, R3VMODA_IPCoordSys, &value, R3TAG_END);
R3COORDSYS value;
R3GetAttrs(r3obj, R3VMODA_IPCoordSys, &value, R3TAG_END);

Distance

Attribute

Distance

Identifier

R3VMODA_Distance

JavaScript type

Number

C type

R3FLOAT

Description

relative to aimpoint

Syntax


jsobj.SetDistance(value);
value = jsobj.GetDistance();


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

View

Attribute

View

Identifier

R3VMODA_View

JavaScript type

Object

C type

R3OBJ*

Description

'R3VMODA_View' not documented

Syntax


jsobj.SetView(value);
value = jsobj.GetView();


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

StickyLayer

Attribute

StickyLayer

Identifier

R3VMODA_StickyLayer

JavaScript type

Boolean

C type

R3BOOL

Description

if true locked to certain layer

Syntax


jsobj.SetStickyLayer(value);
value = jsobj.GetStickyLayer();


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

RSpecName

Attribute

RSpecName

Identifier

R3VMODA_RSpecName

JavaScript type

String

C type

char*

Description

'R3VMODA_RSpecName' not documented

Syntax


jsobj.SetRSpecName(value);
value = jsobj.GetRSpecName();


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

CanvasFlags

Attribute

CanvasFlags

Identifier

R3VMODA_CanvasFlags

JavaScript type

Integer

C type

int

Description

'R3VMODA_CanvasFlags' not documented

Syntax


jsobj.SetCanvasFlags(value);
value = jsobj.GetCanvasFlags();


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

Shaded

Attribute

Shaded

Identifier

R3VMODA_Shaded

JavaScript type

Boolean

C type

R3BOOL

Description

set true for shaded mode, false for wire frame

Syntax


jsobj.SetShaded(value);
value = jsobj.GetShaded();


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

RayTrace

Attribute

RayTrace

Identifier

R3VMODA_RayTrace

JavaScript type

Integer

C type

R3INT

Description

see raytrace enum below

Syntax


jsobj.SetRayTrace(value);
value = jsobj.GetRayTrace();


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

ObjectColors

Attribute

ObjectColors

Identifier

R3VMODA_ObjectColors

JavaScript type

Integer

C type

int

Description

'R3VMODA_ObjectColors' not documented

Syntax


jsobj.SetObjectColors(value);
value = jsobj.GetObjectColors();


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

DrawOnlyVirtualRoot

Attribute

DrawOnlyVirtualRoot

Identifier

R3VMODA_DrawOnlyVirtualRoot

JavaScript type

Boolean

C type

R3BOOL

Description

'R3VMODA_DrawOnlyVirtualRoot' not documented

Syntax


jsobj.SetDrawOnlyVirtualRoot(value);
value = jsobj.GetDrawOnlyVirtualRoot();


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

GridSnap

Attribute

GridSnap

Identifier

R3VMODA_GridSnap

JavaScript type

Integer

C type

int

Description

'R3VMODA_GridSnap' not documented

Syntax


jsobj.SetGridSnap(value);
value = jsobj.GetGridSnap();


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

GridDraw

Attribute

GridDraw

Identifier

R3VMODA_GridDraw

JavaScript type

Integer

C type

int

Description

'R3VMODA_GridDraw' not documented

Syntax


jsobj.SetGridDraw(value);
value = jsobj.GetGridDraw();


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

ObjectsAreInputPlane

Attribute

ObjectsAreInputPlane

Identifier

R3VMODA_ObjectsAreInputPlane

JavaScript type

Integer

C type

int

Description

'R3VMODA_ObjectsAreInputPlane' not documented

Syntax


jsobj.SetObjectsAreInputPlane(value);
value = jsobj.GetObjectsAreInputPlane();


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

CanvasClass

Attribute

CanvasClass

Identifier

R3VMODA_CanvasClass

JavaScript type

Integer

C type

int

Description

'R3VMODA_CanvasClass' not documented

Syntax


jsobj.SetCanvasClass(value);
value = jsobj.GetCanvasClass();


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

TransformTarget

Attribute

TransformTarget

Identifier

R3VMODA_TransformTarget

JavaScript type

Integer

C type

int

Description

'R3VMODA_TransformTarget' not documented

Syntax


jsobj.SetTransformTarget(value);
value = jsobj.GetTransformTarget();


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

TransformType

Attribute

TransformType

Identifier

R3VMODA_TransformType

JavaScript type

Integer

C type

int

Description

'R3VMODA_TransformType' not documented

Syntax


jsobj.SetTransformType(value);
value = jsobj.GetTransformType();


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

AttachToCamera

Attribute

AttachToCamera

Identifier

R3VMODA_AttachToCamera

JavaScript type

Integer

C type

int

Description

See attach types below

Syntax


jsobj.SetAttachToCamera(value);
value = jsobj.GetAttachToCamera();


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

AttachToCameraName

Attribute

AttachToCameraName

Identifier

R3VMODA_AttachToCameraName

JavaScript type

String

C type

char[]

Description

name of current camera can be read using this tag

Syntax


value = jsobj.GetAttachToCameraName();


char[] value;
R3GetAttrs(r3obj, R3VMODA_AttachToCameraName, &value, R3TAG_END);

Camera

Attribute

Camera

Identifier

R3VMODA_Camera

JavaScript type

Object

C type

R3OBJ*

Description

'R3VMODA_Camera' not documented

Syntax


value = jsobj.GetCamera();


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

UseDisplayLists

Attribute

UseDisplayLists

Identifier

R3VMODA_UseDisplayLists

JavaScript type

Integer

C type

int

Description

'R3VMODA_UseDisplayLists' not documented

Syntax


jsobj.SetUseDisplayLists(value);
value = jsobj.GetUseDisplayLists();


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

SyncDrawing

Attribute

SyncDrawing

Identifier

R3VMODA_SyncDrawing

JavaScript type

Integer

C type

int

Description

'R3VMODA_SyncDrawing' not documented

Syntax


jsobj.SetSyncDrawing(value);
value = jsobj.GetSyncDrawing();


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

EffectName

Attribute

EffectName

Identifier

R3VMODA_EffectName

JavaScript type

String

C type

char*

Description

'R3VMODA_EffectName' not documented

Syntax


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


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

AbsGrid

Attribute

AbsGrid

Identifier

R3VMODA_AbsGrid

JavaScript type

Boolean

C type

R3BOOL

Description

ground plane drawing on/off

Syntax


jsobj.SetAbsGrid(value);
value = jsobj.GetAbsGrid();


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

DisableComposition

Attribute

DisableComposition

Identifier

R3VMODA_DisableComposition

JavaScript type

Boolean

C type

R3BOOL

Description

'R3VMODA_DisableComposition' not documented

Syntax


jsobj.SetDisableComposition(value);
value = jsobj.GetDisableComposition();


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

Hotpoint

Attribute

Hotpoint

Identifier

R3VMODA_Hotpoint

Type

r3Vect

Description

iplane origin

Syntax


jsobj.SetHotpoint(value);
value = jsobj.GetHotpoint();


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

DrawBoundingBox

Attribute

DrawBoundingBox

Identifier

R3VMODA_DrawBoundingBox

JavaScript type

Integer

C type

int

Description

'R3VMODA_DrawBoundingBox' not documented

Syntax


jsobj.SetDrawBoundingBox(value);
value = jsobj.GetDrawBoundingBox();


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

DrawRotateHandle

Attribute

DrawRotateHandle

Identifier

R3VMODA_DrawRotateHandle

JavaScript type

Integer

C type

int

Description

'R3VMODA_DrawRotateHandle' not documented

Syntax


jsobj.SetDrawRotateHandle(value);
value = jsobj.GetDrawRotateHandle();


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

GridName

Attribute

GridName

Identifier

R3VMODA_GridName

JavaScript type

String

C type

char*

Description

name of the current grid

Syntax


jsobj.SetGridName(value);
value = jsobj.GetGridName();


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

ImageName

Attribute

ImageName

Identifier

R3VMODA_ImageName

JavaScript type

String

C type

char*

Description

name of the current backdrop image

Syntax


jsobj.SetImageName(value);
value = jsobj.GetImageName();


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

BackdropImage

Attribute

BackdropImage

Identifier

R3VMODA_BackdropImage

JavaScript type

Boolean

C type

R3BOOL

Description

backdrop image active/inactive (read only)

Syntax


jsobj.SetBackdropImage(value);
value = jsobj.GetBackdropImage();


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

UseCanvasAsBackdrop

Attribute

UseCanvasAsBackdrop

Identifier

R3VMODA_UseCanvasAsBackdrop

JavaScript type

Integer

C type

R3INT

Description

use primary rendering (wireframe) as backdrop for ray tracing

Syntax


jsobj.SetUseCanvasAsBackdrop(value);
value = jsobj.GetUseCanvasAsBackdrop();


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

FilmSensitivity

Attribute

FilmSensitivity

Identifier

R3VMODA_FilmSensitivity

JavaScript type

Number

C type

R3FLOAT

Description

acts like brightness

Syntax


jsobj.SetFilmSensitivity(value);
value = jsobj.GetFilmSensitivity();


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

Flash

Attribute

Flash

Identifier

R3VMODA_Flash

Type

r3Vect

Description

color of automatic flash associated with view's camera

Syntax


jsobj.SetFlash(value);
value = jsobj.GetFlash();


R3FLOATCOLOR3 value = ...;
R3SetAttrs(r3obj, R3VMODA_Flash, value, R3TAG_END);
R3FLOATCOLOR3 value;
R3GetAttrs(r3obj, R3VMODA_Flash, &value, R3TAG_END);

CamOrigin

Attribute

CamOrigin

Identifier

R3VMODA_CamOrigin

Type

r3Vect

Description

changes position of the camera by rotation

Syntax


jsobj.SetCamOrigin(value);
value = jsobj.GetCamOrigin();


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

CamDirection

Attribute

CamDirection

Identifier

R3VMODA_CamDirection

Type

r3Vect

Description

changes aimpoint of the camera by rotation

Syntax


jsobj.SetCamDirection(value);
value = jsobj.GetCamDirection();


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

LensFlare

Attribute

LensFlare

Identifier

R3VMODA_LensFlare

JavaScript type

String

C type

char*

Description

name of lens flare rendering effect

Syntax


jsobj.SetLensFlare(value);
value = jsobj.GetLensFlare();


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

FilmWidth

Attribute

FilmWidth

Identifier

R3VMODA_FilmWidth

JavaScript type

Number

C type

R3FLOAT

Description

film size defines image aspect ratio & view opening angle

Syntax


jsobj.SetFilmWidth(value);
value = jsobj.GetFilmWidth();


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

CenterCoordSys

Attribute

CenterCoordSys

Identifier

R3VMODA_CenterCoordSys

JavaScript type

Boolean

C type

R3BOOL

Description

draw coordsys on world origin

Syntax


jsobj.SetCenterCoordSys(value);
value = jsobj.GetCenterCoordSys();


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

CornerCoordSys

Attribute

CornerCoordSys

Identifier

R3VMODA_CornerCoordSys

JavaScript type

Boolean

C type

R3BOOL

Description

draw coordsys on world view corner

Syntax


jsobj.SetCornerCoordSys(value);
value = jsobj.GetCornerCoordSys();


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

KeepIPlaneOrthogonal

Attribute

KeepIPlaneOrthogonal

Identifier

R3VMODA_KeepIPlaneOrthogonal

JavaScript type

Boolean

C type

R3BOOL

Description

if TRUE iplane is always kept perpendicular to the camera

Syntax


jsobj.SetKeepIPlaneOrthogonal(value);
value = jsobj.GetKeepIPlaneOrthogonal();


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

OverScan

Attribute

OverScan

Identifier

R3VMODA_OverScan

JavaScript type

Number

C type

R3FLOAT

Description

proportion of view scale/camera scale in camera tracking

Syntax


jsobj.SetOverScan(value);
value = jsobj.GetOverScan();


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

BoxRelX

Attribute

BoxRelX

Identifier

R3VMODA_BoxRelX

JavaScript type

Number

C type

R3FLOAT

Description

0..1, relative box coordinates for box ray tracing

Syntax


jsobj.SetBoxRelX(value);
value = jsobj.GetBoxRelX();


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

BoxRelY

Attribute

BoxRelY

Identifier

R3VMODA_BoxRelY

JavaScript type

Number

C type

R3FLOAT

Description

'R3VMODA_BoxRelY' not documented

Syntax


jsobj.SetBoxRelY(value);
value = jsobj.GetBoxRelY();


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

BoxRelW

Attribute

BoxRelW

Identifier

R3VMODA_BoxRelW

JavaScript type

Number

C type

R3FLOAT

Description

'R3VMODA_BoxRelW' not documented

Syntax


jsobj.SetBoxRelW(value);
value = jsobj.GetBoxRelW();


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

BoxRelH

Attribute

BoxRelH

Identifier

R3VMODA_BoxRelH

JavaScript type

Number

C type

R3FLOAT

Description

'R3VMODA_BoxRelH' not documented

Syntax


jsobj.SetBoxRelH(value);
value = jsobj.GetBoxRelH();


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

RenderBoxActive

Attribute

RenderBoxActive

Identifier

R3VMODA_RenderBoxActive

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


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


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

ImageAspect

Attribute

ImageAspect

Identifier

R3VMODA_ImageAspect

JavaScript type

Number

C type

R3FLOAT

Description

image height/width, pixel aspect corrected ratio

Syntax


jsobj.SetImageAspect(value);
value = jsobj.GetImageAspect();


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

RelHeading

Attribute

RelHeading

Identifier

R3VMODA_RelHeading

JavaScript type

Number

C type

R3FLOAT

Description

these three angles define orientation of the camera in native csys

Syntax


jsobj.SetRelHeading(value);
value = jsobj.GetRelHeading();


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

RelIPlaneHeading

Attribute

RelIPlaneHeading

Identifier

R3VMODA_RelIPlaneHeading

JavaScript type

Number

C type

R3FLOAT

Description

orientation of the input plane (mouse plane) in native csys

Syntax


jsobj.SetRelIPlaneHeading(value);
value = jsobj.GetRelIPlaneHeading();


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

SizeLocked

Attribute

SizeLocked

Identifier

R3VMODA_SizeLocked

JavaScript type

Boolean

C type

R3BOOL

Description

size locked

Syntax


jsobj.SetSizeLocked(value);
value = jsobj.GetSizeLocked();


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

DrawAimPoint

Attribute

DrawAimPoint

Identifier

R3VMODA_DrawAimPoint

JavaScript type

Boolean

C type

R3BOOL

Description

aimp. draw on/off

Syntax


jsobj.SetDrawAimPoint(value);
value = jsobj.GetDrawAimPoint();


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

DrawHotPoint

Attribute

DrawHotPoint

Identifier

R3VMODA_DrawHotPoint

JavaScript type

Boolean

C type

R3BOOL

Description

hotp. draw on/off

Syntax


jsobj.SetDrawHotPoint(value);
value = jsobj.GetDrawHotPoint();


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

MinClipDist

Attribute

MinClipDist

Identifier

R3VMODA_MinClipDist

JavaScript type

Number

C type

R3FLOAT

Description

in meters

Syntax


jsobj.SetMinClipDist(value);
value = jsobj.GetMinClipDist();


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

MaxClipDist

Attribute

MaxClipDist

Identifier

R3VMODA_MaxClipDist

JavaScript type

Number

C type

R3FLOAT

Description

in meters

Syntax


jsobj.SetMaxClipDist(value);
value = jsobj.GetMaxClipDist();


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

CaptureRayTrace

Attribute

CaptureRayTrace

Identifier

R3VMODA_CaptureRayTrace

JavaScript type

Boolean

C type

R3BOOL

Description

update backdrop from ray tracing

Syntax


jsobj.SetCaptureRayTrace(value);
value = jsobj.GetCaptureRayTrace();


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

HiddenVisibility

Attribute

HiddenVisibility

Identifier

R3VMODA_HiddenVisibility

JavaScript type

Boolean

C type

R3BOOL

Description

use transparency to show handles etc. through shaded objects

Syntax


jsobj.SetHiddenVisibility(value);
value = jsobj.GetHiddenVisibility();


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

AnimationPreviewOutp

Attribute

AnimationPreviewOutp

Identifier

R3VMODA_AnimationPreviewOutp

JavaScript type

String

C type

char*

Description

Syntax


jsobj.SetAnimationPreviewOutp(value);
value = jsobj.GetAnimationPreviewOutp();


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

AnimationPreviewFile

Attribute

AnimationPreviewFile

Identifier

R3VMODA_AnimationPreviewFile

JavaScript type

String

C type

char*

Description

Syntax


jsobj.SetAnimationPreviewFile(value);
value = jsobj.GetAnimationPreviewFile();


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

DitheringScale

Attribute

DitheringScale

Identifier

R3VMODA_DitheringScale

JavaScript type

Number

C type

R3FLOAT

Description

RGB dither scale for (non palette mapped, less than 24 bit) views

Syntax


jsobj.SetDitheringScale(value);
value = jsobj.GetDitheringScale();


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

NoMaterialUpdates

Attribute

NoMaterialUpdates

Identifier

R3VMODA_NoMaterialUpdates

JavaScript type

Integer

C type

int

Description

R23BOOL, freeze shaded material recomputations

Syntax


jsobj.SetNoMaterialUpdates(value);
value = jsobj.GetNoMaterialUpdates();


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

AttachToIPlane

Attribute

AttachToIPlane

Identifier

R3VMODA_AttachToIPlane

JavaScript type

Boolean

C type

R3BOOL

Description

use geom. iplane object to control vmod's iplane

Syntax


jsobj.SetAttachToIPlane(value);
value = jsobj.GetAttachToIPlane();


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

BackdropWeight

Attribute

BackdropWeight

Identifier

R3VMODA_BackdropWeight

JavaScript type

Number

C type

R3FLOAT

Description

backdrop weight

Syntax


jsobj.SetBackdropWeight(value);
value = jsobj.GetBackdropWeight();


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

DrawOnlySelected

Attribute

DrawOnlySelected

Identifier

R3VMODA_DrawOnlySelected

JavaScript type

Boolean

C type

R3BOOL

Description

draw only seleced objects and their children

Syntax


jsobj.SetDrawOnlySelected(value);
value = jsobj.GetDrawOnlySelected();


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

IsTempImage

Attribute

IsTempImage

Identifier

R3VMODA_IsTempImage

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetIsTempImage(value);
value = jsobj.GetIsTempImage();


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

NoVertPersp

Attribute

NoVertPersp

Identifier

R3VMODA_NoVertPersp

JavaScript type

Boolean

C type

R3BOOL

Description

eliminate vertical perspective

Syntax


jsobj.SetNoVertPersp(value);
value = jsobj.GetNoVertPersp();


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

RayTraceCache

Attribute

RayTraceCache

Identifier

R3VMODA_RayTraceCache

JavaScript type

Boolean

C type

R3BOOL

Description

keep previous scene state in memory

Syntax


jsobj.SetRayTraceCache(value);
value = jsobj.GetRayTraceCache();


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

ImageEffectName

Attribute

ImageEffectName

Identifier

R3VMODA_ImageEffectName

JavaScript type

String

C type

char*

Description

'R3VMODA_ImageEffectName' not documented

Syntax


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


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

FieldEffectName

Attribute

FieldEffectName

Identifier

R3VMODA_FieldEffectName

JavaScript type

String

C type

char*

Description

'R3VMODA_FieldEffectName' not documented

Syntax


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


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

FrameEffectName

Attribute

FrameEffectName

Identifier

R3VMODA_FrameEffectName

JavaScript type

String

C type

char*

Description

'R3VMODA_FrameEffectName' not documented

Syntax


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


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

DrawingDisabled

Attribute

DrawingDisabled

Identifier

R3VMODA_DrawingDisabled

JavaScript type

Boolean

C type

R3BOOL

Description

turn rendering off

Syntax


jsobj.SetDrawingDisabled(value);
value = jsobj.GetDrawingDisabled();


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

Is2D

Attribute

Is2D

Identifier

R3VMODA_Is2D

JavaScript type

Boolean

C type

R3BOOL

Description

view model for UV Views

Syntax


jsobj.SetIs2D(value);
value = jsobj.GetIs2D();


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

ViewCount

Attribute

ViewCount

Identifier

R3VMODA_ViewCount

JavaScript type

Integer

C type

R3INT

Description

number of view using this view model (currently 0 or 1)

Syntax


value = jsobj.GetViewCount();


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

RotationFriction

Attribute

RotationFriction

Identifier

R3VMODA_RotationFriction

Type

r3Vect

Description

Syntax


jsobj.SetRotationFriction(value);
value = jsobj.GetRotationFriction();


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

VelocityFriction

Attribute

VelocityFriction

Identifier

R3VMODA_VelocityFriction

Type

r3Vect

Description

Syntax


jsobj.SetVelocityFriction(value);
value = jsobj.GetVelocityFriction();


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

EnginePower

Attribute

EnginePower

Identifier

R3VMODA_EnginePower

JavaScript type

Number

C type

R3FLOAT

Description

Syntax


jsobj.SetEnginePower(value);
value = jsobj.GetEnginePower();


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

Active

Attribute

Active

Identifier

R3VMODA_Active

JavaScript type

Boolean

C type

R3BOOL

Description

set if the vmod is active in the window list

Syntax


jsobj.SetActive(value);
value = jsobj.GetActive();


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

Locking

Attribute

Locking

Identifier

R3VMODA_Locking

JavaScript type

Integer

C type

R3INT

Description

see enum below

Syntax


jsobj.SetLocking(value);
value = jsobj.GetLocking();


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

NoAutoRedraw

Attribute

NoAutoRedraw

Identifier

R3VMODA_NoAutoRedraw

JavaScript type

Boolean

C type

R3BOOL

Description

disables automatic refreshing when model changes

Syntax


jsobj.SetNoAutoRedraw(value);
value = jsobj.GetNoAutoRedraw();


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

FixBackdropAspect

Attribute

FixBackdropAspect

Identifier

R3VMODA_FixBackdropAspect

JavaScript type

Boolean

C type

R3BOOL

Description

Turns off auto backdrop strecthing to fit view size

Syntax


jsobj.SetFixBackdropAspect(value);
value = jsobj.GetFixBackdropAspect();


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

AutoEffects

Attribute

AutoEffects

Identifier

R3VMODA_AutoEffects

JavaScript type

Boolean

C type

R3BOOL

Description

configure post effects automatically in project loading

Syntax


jsobj.SetAutoEffects(value);
value = jsobj.GetAutoEffects();


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

BackupRayTrace

Attribute

BackupRayTrace

Identifier

R3VMODA_BackupRayTrace

JavaScript type

Boolean

C type

R3BOOL

Description

backup the ray traced image to a file for futher processing

Syntax


jsobj.SetBackupRayTrace(value);
value = jsobj.GetBackupRayTrace();


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

Navigation

Attribute

Navigation

Identifier

R3VMODA_Navigation

JavaScript type

Boolean

C type

R3BOOL

Description

enable game-like mouse navigation mode

Syntax


jsobj.SetNavigation(value);
value = jsobj.GetNavigation();


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

NativeCoordSys

Attribute

NativeCoordSys

Identifier

R3VMODA_NativeCoordSys

Type

r3Coordsys

Description

native coord sys

Syntax


jsobj.SetNativeCoordSys(value);
value = jsobj.GetNativeCoordSys();


R3COORDSYS* value = ...;
R3SetAttrs(r3obj, R3VMODA_NativeCoordSys, value, R3TAG_END);
R3COORDSYS* value;
R3GetAttrs(r3obj, R3VMODA_NativeCoordSys, &value, R3TAG_END);

DrawLabel

Attribute

DrawLabel

Identifier

R3VMODA_DrawLabel

JavaScript type

Boolean

C type

R3BOOL

Description

draw vmod name label

Syntax


jsobj.SetDrawLabel(value);
value = jsobj.GetDrawLabel();


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

BoxOrder

Attribute

BoxOrder

Identifier

R3VMODA_BoxOrder

JavaScript type

Integer

C type

R3INT

Description

see box orders below

Syntax


jsobj.SetBoxOrder(value);
value = jsobj.GetBoxOrder();


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

R3VMTT_VIEW_AND_INPUTPLANE
R3VMTT_VIEW
R3VMTT_INPUTPLANE
R3VMTT_WORLD
R3VMTT_OBJECTS
R3VMTT_TEXTURE
R3VMTT_NATIVEORIENTATION

TransformType

R3VMTT_ROTATE
R3VMTT_DEFINEORIGIN
R3VMTT_DEFINEX
R3VMTT_DEFINEY
R3VMTT_DEFINEZBYRAYHIT
R3VMTT_ZOOM
R3VMTT_PAN
R3VMTT_DISTANCE
R3VMTT_RECTZOOMINOUT
R3VMTT_DEFINEBOX
R3VMTT_DEFINEHOTPOINT
R3VMTT_DEFINEWORLDORIGIN
R3VMTT_MOVEMINCLIP
R3VMTT_MOVEMAXCLIP

Current camera connection

R3VMCTRACK_NONE
R3VMCTRACK_ANIMPLAY
R3VMCTRACK_ALWAYS

view camera locking

R3VMLOCK_NONE
R3VMLOCK_ALL
R3VMLOCK_DIRECTION

raytracing

R3VMRT_NORMAL
R3VMRT_AUTOMATIC
R3VMRT_LMB

Object Colors

R3VMCF_BLACK
R3VMCF_OBJECT
R3VMCF_CLASS
R3VMCF_MAPPEDOBJECT

box rendering order

R3VMBOXORD_ORDNUM
R3VMBOXORD_DISTRIBUTED
R3VMBOXORD_CENTERED
R3VMBOXORD_INVERSEDRDNUM

Public strings

R3VMODS_DEFAULTCOMPASSNAME
R3VMODS_PRIVATE

Tags

Tags

R3VMODA_IPlane
R3VMODA_DefaultBackdrop
R3VMODA_KeyString
R3VMODA_ClassName
R3VMODA_EditString
R3VMODA_ToolName
R3VMODA_CompassName
R3VMODA_BackdropImageContents