r3tbase

Class

real/code/r3tbase.h

Library

r3code

Description:

Construction tool base class. Keeps track of installed construction tools.

See Also

oops/r3root.h

Super Class

r3Root

R3CLID_ROOT

JavaScript

r3Toolbase

Class Identifier

R3CLID_TOOLBASE - 336

Methods

UPDATESELECTED, APPLY, CREATECONTROLS,

Attributes

PrimLayer, Layer, Tool, Controls, ImageLayer, UnitConverter, ProgressIndicator, MaterialLayer,

Registration

int R3RegisterToolBaseClass(R3APP *app);

R3TBASEM_UPDATESELECTED

Method

UPDATESELECTED

Identifier

R3TBASEM_UPDATESELECTED

Return

R3BOOL, TRUE enables 'apply' button so that the tool can be applied.

Param 1:

R3INT, number of selected objects

Param 3:

R3LIST, list of selected objects

JavaScript

rc = obj.UPDATESELECTED(p1, p3);

Description

This method is sent to the tool object when the user has played with the selected object. The tool can check out the selected objects and decide whether or not they are valid.

R3TBASEM_APPLY

Method

APPLY

Identifier

R3TBASEM_APPLY

Param 3:

R3TAG*, R3TBASEA_Layer - current project R3TBASEA_PrimLayer - geometric primitives R3TBASEA_MaterialLayer - materials R3TBASEA_ImageLayer - images

JavaScript

obj.APPLY(p3);

Description

This method is sent to the tool when the user has clicked the 'Apply'.

R3TBASEM_CREATECONTROLS

Method

CREATECONTROLS

Identifier

R3TBASEM_CREATECONTROLS

Param 3:

R3TAG*, R3TBASEA_Window

JavaScript

obj.CREATECONTROLS(p3);

Description

This method is sent to the tool when the tool window is instanced. The tool creates necessary gadgets here. Gadgets must be created inside one geometry manager, which is later fetched using R3TBASEA_Controls tag.

PrimLayer

Attribute

PrimLayer

Identifier

R3TBASEA_PrimLayer

JavaScript type

Object

C type

R3OBJ*

Description

geometric primitives

Syntax

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

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

Layer

Attribute

Layer

Identifier

R3TBASEA_Layer

JavaScript type

Object

C type

R3OBJ*

Description

current project

Syntax

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

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

Tool

Attribute

Tool

Identifier

R3TBASEA_Tool

JavaScript type

Integer

C type

R3INT*

Description

class id of the tool

Syntax

value = jsobj.GetTool();

R3INT* value;
R3GetAttrs(r3obj, R3TBASEA_Tool, &value, R3TAG_END);

Controls

Attribute

Controls

Identifier

R3TBASEA_Controls

JavaScript type

String

C type

void*

Description

geometry manager containing gadgets for the tool

Syntax

value = jsobj.GetControls();

void* value;
R3GetAttrs(r3obj, R3TBASEA_Controls, &value, R3TAG_END);

ImageLayer

Attribute

ImageLayer

Identifier

R3TBASEA_ImageLayer

JavaScript type

Object

C type

R3OBJ*

Description

Syntax

jsobj.SetImageLayer(value);
value = jsobj.GetImageLayer();

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

UnitConverter

Attribute

UnitConverter

Identifier

R3TBASEA_UnitConverter

JavaScript type

Object

C type

R3OBJ*

Description

Syntax

jsobj.SetUnitConverter(value);

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

ProgressIndicator

Attribute

ProgressIndicator

Identifier

R3TBASEA_ProgressIndicator

JavaScript type

Object

C type

R3OBJ*

Description

Syntax

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

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

MaterialLayer

Attribute

MaterialLayer

Identifier

R3TBASEA_MaterialLayer

JavaScript type

Object

C type

R3OBJ*

Description

Syntax

jsobj.SetMaterialLayer(value);
value = jsobj.GetMaterialLayer();

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

Tags

R3TBASEA_Window