r3grid

Class

real/code/r3grid.h

Library

r3code

Description:

Grid Class

See Also

oops/r3model.h

Super Class

r3Model

R3CLID_MODEL

JavaScript

r3Grid

Class Identifier

R3CLID_GRID - 44

Methods

SNAPPOINT, DRAW,

Attributes

HorizontalSpacing, VerticalSpacing, NormalSpacing, Origin, Color, Color2, ColorCycle, Count, FixedSize,

Registration

int R3RegisterGridClass(R3APP *app);

R3GRIDM_SNAPPOINT

Method

SNAPPOINT

Identifier

R3GRIDM_SNAPPOINT

Param 1:

R3COORDSYS

Param 3:

R3VECTOR, point;

JavaScript

obj.SNAPPOINT(p1, p3);

Description

Snap point to grid

R3GRIDM_DRAW

Method

DRAW

Identifier

R3GRIDM_DRAW

Param 1:

R3OBJ*, draw context

Param 3:

R3OBJ*, viewcam object

JavaScript

obj.DRAW(p1, p3);

Description

Draw grid

HorizontalSpacing

Attribute

HorizontalSpacing

Identifier

R3GRIDA_HorizontalSpacing

JavaScript type

Number

C type

R3FLOAT

Description

spacing in x direction

Syntax

jsobj.SetHorizontalSpacing(value);
value = jsobj.GetHorizontalSpacing();

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

VerticalSpacing

Attribute

VerticalSpacing

Identifier

R3GRIDA_VerticalSpacing

JavaScript type

Number

C type

R3FLOAT

Description

spacing in y direction

Syntax

jsobj.SetVerticalSpacing(value);
value = jsobj.GetVerticalSpacing();

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

NormalSpacing

Attribute

NormalSpacing

Identifier

R3GRIDA_NormalSpacing

JavaScript type

Number

C type

R3FLOAT

Description

spacing in z direction

Syntax

jsobj.SetNormalSpacing(value);
value = jsobj.GetNormalSpacing();

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

Origin

Attribute

Origin

Identifier

R3GRIDA_Origin

Type

r3Vect

Description

origin

Syntax

jsobj.SetOrigin(value);
value = jsobj.GetOrigin();

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

Color

Attribute

Color

Identifier

R3GRIDA_Color

Type

r3Vect

Description

R3FLOACOLOR3, primary color

Syntax

jsobj.SetColor(value);
value = jsobj.GetColor();

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

Color2

Attribute

Color2

Identifier

R3GRIDA_Color2

Type

r3Vect

Description

R3FLOACOLOR3, secondary color

Syntax

jsobj.SetColor2(value);
value = jsobj.GetColor2();

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

ColorCycle

Attribute

ColorCycle

Identifier

R3GRIDA_ColorCycle

JavaScript type

Integer

C type

R3INT

Description

modulo for cycling primary / secondary color

Syntax

jsobj.SetColorCycle(value);
value = jsobj.GetColorCycle();

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

Count

Attribute

Count

Identifier

R3GRIDA_Count

JavaScript type

Integer

C type

R3INT

Description

size of the grid

Syntax

jsobj.SetCount(value);
value = jsobj.GetCount();

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

FixedSize

Attribute

FixedSize

Identifier

R3GRIDA_FixedSize

JavaScript type

Boolean

C type

R3BOOL

Description

if TRUE, fixed size grid

Syntax

jsobj.SetFixedSize(value);
value = jsobj.GetFixedSize();

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