r3wfeng

Class

real/wires/r3wfeng.h

Library

r3wire

Description:

Wire Frame Rendering Engine

See Also

oops/r3root.h

Super Class

r3Root

R3CLID_ROOT

JavaScript

r3Wfengine

Class Identifier

R3CLID_WFENGINE - 141

Methods

UPDATE, RENDERLIGHTSOURCES, ISSHADED, GETCTRLFLAGS, ISINTERRUPTED,

Attributes

PrimLayer, DrawContext, VCam, CtrlFlags, OnlyVirtualRoot, ObjectColors, UvCurveEngine, Shaded, UseDisplayLists, ObjectCount, HiddenVisibility, FlashLight, BackgroundRGB, PrimLayer2, CurrentLayerIndex, NoMaterialUpdates, DrawOnlySelectedObject, MaterialEvaluator2, RenderMore, UpdateBehaviour, LayerLockObject, LayerLockMethod, CanInterrupt, InterruptDelay, SuspendLock, WFContext, YieldDoneMethod,

Registration

int R3RegisterWFEngineClass(R3APP *app);

R3WFM_UPDATE

Method

UPDATE

Identifier

R3WFM_UPDATE

JavaScript

obj.UPDATE();

Description

R3WFM_RENDERLIGHTSOURCES

Method

RENDERLIGHTSOURCES

Identifier

R3WFM_RENDERLIGHTSOURCES

JavaScript

obj.RENDERLIGHTSOURCES();

Description

R3WFM_ISSHADED

Method

ISSHADED

Identifier

R3WFM_ISSHADED

Return

R3BOOL, TRUE if shaded

JavaScript

rc = obj.ISSHADED();

Description

Check whether the renderer is in shaded mode or not

R3WFM_GETCTRLFLAGS

Method

GETCTRLFLAGS

Identifier

R3WFM_GETCTRLFLAGS

Return

R3INT, the flags

JavaScript

rc = obj.GETCTRLFLAGS();

Description

return control flags (same as R3RM_GET/R3WFA_CtrlFlags).

R3WFM_ISINTERRUPTED

Method

ISINTERRUPTED

Identifier

R3WFM_ISINTERRUPTED

JavaScript

obj.ISINTERRUPTED();

Description

returns if wfengine has reached interrupt state (including sync delays)

PrimLayer

Attribute

PrimLayer

Identifier

R3WFA_PrimLayer

JavaScript type

Object

C type

R3OBJ*

Description

'R3WFA_PrimLayer' not documented

Syntax

jsobj.SetPrimLayer(value);
value = jsobj.GetPrimLayer();

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

DrawContext

Attribute

DrawContext

Identifier

R3WFA_DrawContext

JavaScript type

Object

C type

R3OBJ*

Description

'R3WFA_DrawContext' not documented

Syntax

jsobj.SetDrawContext(value);
value = jsobj.GetDrawContext();

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

VCam

Attribute

VCam

Identifier

R3WFA_VCam

JavaScript type

Object

C type

R3OBJ*

Description

'R3WFA_VCam' not documented

Syntax

jsobj.SetVCam(value);
value = jsobj.GetVCam();

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

CtrlFlags

Attribute

CtrlFlags

Identifier

R3WFA_CtrlFlags

JavaScript type

Integer

C type

int

Description

'R3WFA_CtrlFlags' not documented

Syntax

jsobj.SetCtrlFlags(value);
value = jsobj.GetCtrlFlags();

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

OnlyVirtualRoot

Attribute

OnlyVirtualRoot

Identifier

R3WFA_OnlyVirtualRoot

JavaScript type

Integer

C type

int

Description

'R3WFA_OnlyVirtualRoot' not documented

Syntax

jsobj.SetOnlyVirtualRoot(value);
value = jsobj.GetOnlyVirtualRoot();

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

ObjectColors

Attribute

ObjectColors

Identifier

R3WFA_ObjectColors

JavaScript type

Integer

C type

int

Description

'R3WFA_ObjectColors' not documented

Syntax

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

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

UvCurveEngine

Attribute

UvCurveEngine

Identifier

R3WFA_UvCurveEngine

JavaScript type

Integer

C type

int

Description

Render only UV curves in U,V space

Syntax

jsobj.SetUvCurveEngine(value);
value = jsobj.GetUvCurveEngine();

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

Shaded

Attribute

Shaded

Identifier

R3WFA_Shaded

JavaScript type

Integer

C type

int

Description

do openGL or other fast shading

Syntax

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

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

UseDisplayLists

Attribute

UseDisplayLists

Identifier

R3WFA_UseDisplayLists

JavaScript type

Integer

C type

int

Description

'R3WFA_UseDisplayLists' not documented

Syntax

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

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

ObjectCount

Attribute

ObjectCount

Identifier

R3WFA_ObjectCount

JavaScript type

Integer

C type

R3INT

Description

number of objects rendered

Syntax

value = jsobj.GetObjectCount();

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

HiddenVisibility

Attribute

HiddenVisibility

Identifier

R3WFA_HiddenVisibility

JavaScript type

Boolean

C type

R3BOOL

Description

hiddenvis. on

Syntax

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

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

FlashLight

Attribute

FlashLight

Identifier

R3WFA_FlashLight

Type

r3Vect

Description

Syntax

jsobj.SetFlashLight(value);
value = jsobj.GetFlashLight();

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

BackgroundRGB

Attribute

BackgroundRGB

Identifier

R3WFA_BackgroundRGB

Type

r3Vect

Description

Syntax

jsobj.SetBackgroundRGB(value);
value = jsobj.GetBackgroundRGB();

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

PrimLayer2

Attribute

PrimLayer2

Identifier

R3WFA_PrimLayer2

JavaScript type

Object

C type

R3OBJ*

Description

Syntax

jsobj.SetPrimLayer2(value);
value = jsobj.GetPrimLayer2();

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

CurrentLayerIndex

Attribute

CurrentLayerIndex

Identifier

R3WFA_CurrentLayerIndex

JavaScript type

Integer

C type

R3INT

Description

0, 1

Syntax

jsobj.SetCurrentLayerIndex(value);
value = jsobj.GetCurrentLayerIndex();

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

NoMaterialUpdates

Attribute

NoMaterialUpdates

Identifier

R3WFA_NoMaterialUpdates

JavaScript type

Integer

C type

int

Description

dont re-evaluate changed materials

Syntax

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

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

DrawOnlySelectedObject

Attribute

DrawOnlySelectedObject

Identifier

R3WFA_DrawOnlySelectedObject

JavaScript type

Integer

C type

int

Description

'R3WFA_DrawOnlySelectedObjects' not documented

Syntax

jsobj.SetDrawOnlySelectedObject(value);
value = jsobj.GetDrawOnlySelectedObject();

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

MaterialEvaluator2

Attribute

MaterialEvaluator2

Identifier

R3WFA_MaterialEvaluator2

JavaScript type

Object

C type

R3OBJ*

Description

mat evaluator for layer 2

Syntax

jsobj.SetMaterialEvaluator2(value);

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

RenderMore

Attribute

RenderMore

Identifier

R3WFA_RenderMore

JavaScript type

Boolean

C type

R3BOOL

Description

read only. Use this to ask if additional render cycles improve render quality

Syntax

value = jsobj.GetRenderMore();

R3BOOL value;
R3GetAttrs(r3obj, R3WFA_RenderMore, &value, R3TAG_END);

UpdateBehaviour

Attribute

UpdateBehaviour

Identifier

R3WFA_UpdateBehaviour

JavaScript type

Integer

C type

R3INT

Description

uses enum values defined below

Syntax

jsobj.SetUpdateBehaviour(value);
value = jsobj.GetUpdateBehaviour();

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

LayerLockObject

Attribute

LayerLockObject

Identifier

R3WFA_LayerLockObject

JavaScript type

Object

C type

R3OBJ*

Description

'R3WFA_LayerLockObject' not documented

Syntax

jsobj.SetLayerLockObject(value);
value = jsobj.GetLayerLockObject();

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

LayerLockMethod

Attribute

LayerLockMethod

Identifier

R3WFA_LayerLockMethod

JavaScript type

Integer

C type

int

Description

'R3WFA_LayerLockMethod' not documented

Syntax

jsobj.SetLayerLockMethod(value);
value = jsobj.GetLayerLockMethod();

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

CanInterrupt

Attribute

CanInterrupt

Identifier

R3WFA_CanInterrupt

JavaScript type

Boolean

C type

R3BOOL

Description

value is usually set by timer after certain rendr time has elapsed

Syntax

jsobj.SetCanInterrupt(value);
value = jsobj.GetCanInterrupt();

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

InterruptDelay

Attribute

InterruptDelay

Identifier

R3WFA_InterruptDelay

JavaScript type

Integer

C type

R3INT

Description

min. number of milliseconds before wire drawing is canceled for next redraw

Syntax

jsobj.SetInterruptDelay(value);
value = jsobj.GetInterruptDelay();

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

SuspendLock

Attribute

SuspendLock

Identifier

R3WFA_SuspendLock

JavaScript type

String

C type

void*

Description

lock object for arbitrating suspend state changes

Syntax

jsobj.SetSuspendLock(value);

void* value = ...;
R3SetAttrs(r3obj, R3WFA_SuspendLock, value, R3TAG_END);

WFContext

Attribute

WFContext

Identifier

R3WFA_WFContext

JavaScript type

Object

C type

R3OBJ*

Description

read only

Syntax

value = jsobj.GetWFContext();

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

YieldDoneMethod

Attribute

YieldDoneMethod

Identifier

R3WFA_YieldDoneMethod

JavaScript type

Integer

C type

R3INT

Description

Syntax

jsobj.SetYieldDoneMethod(value);
value = jsobj.GetYieldDoneMethod();

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

R3WFF_INTERRUPT

R3WFF_SUSPEND

R3WFF_SLEEPING

R3WFF_OBJECTS

R3WFF_POINTS

R3WFF_BBOX

R3WFF_ROTATE

R3WFF_LIGHTS

R3WFF_TRANSFORMATION

Tags

R3WFCA_RotateHandleSize

R3WFCA_CoordsysHandleSize