r3cpsmod

Class

real/code/r3cpsmod.h

Library

r3code

Description:

Compass Model Class. This model contains Compass specific options that need to be saved.

See Also

oops/r3model.h

Super Class

r3Model

R3CLID_MODEL

JavaScript

r3Compassmodel

Class Identifier

R3CLID_COMPASSMODEL - 1262

Methods

ADDCOMPASS, DELETECOMPASS, ENUMCOMPASSES, SETCOMPASSMACR, GETCOMPASSMACR, FINDCOMPASS, SETCOMPASSLABE, GETCOMPASSLABE, MAKECOMPASSNAM, ALLOCLABELS, FREELABELS, FREELABELS, FINDCTCOMPASS,

Attributes

Registration

int R3RegisterCompassModelClass(R3APP *app);

R3COMPASSMODM_ADDCOMPASS

Method

ADDCOMPASS

Identifier

R3COMPASSMODM_ADDCOMPASS

Param 3:

char*, name for the new compass.

JavaScript

obj.ADDCOMPASS(p3);

Description

Adds a compass.

R3COMPASSMODM_DELETECOMPASS

Method

DELETECOMPASS

Identifier

R3COMPASSMODM_DELETECOMPASS

Param 3:

char*, name of the compass to be deleted.

JavaScript

obj.DELETECOMPASS(p3);

Description

Deletes a compass.

R3COMPASSMODM_ENUMCOMPASSES

Method

ENUMCOMPASSES

Identifier

R3COMPASSMODM_ENUMCOMPASSES

Param 1:

R3OBJ*, callback object

Param 2:

R3INT, callback method

Param 3:

void*, user context

JavaScript

obj.ENUMCOMPASSES(p1, p2, p3);

Description

Enumerates compasses.

R3COMPASSMODM_SETCOMPASSMACR

Method

SETCOMPASSMACR

Identifier

R3COMPASSMODM_SETCOMPASSMACR

Param 1:

char*, name of the compass

Param 2:

R3INT*, array of two values: direction and distance

Param 3:

char*, macro name

JavaScript

obj.SETCOMPASSMACR(p1, p2, p3);

Description

Sets a named macro for a given compass and position

R3COMPASSMODM_GETCOMPASSMACR

Method

GETCOMPASSMACR

Identifier

R3COMPASSMODM_GETCOMPASSMACR

Param 1:

char*, name of the compass

Param 2:

R3INT*, array of two values: direction and distance

Param 3:

char*, buffer for macro name

JavaScript

obj.GETCOMPASSMACR(p1, p2, p3);

Description

Gets a named macro for a given compass and position

R3COMPASSMODM_FINDCOMPASS

Method

FINDCOMPASS

Identifier

R3COMPASSMODM_FINDCOMPASS

Return

R3BOOL, TRUE if compass is found, FALSE otherwise

Param 3:

char*, compass name

JavaScript

rc = obj.FINDCOMPASS(p3);

Description

Finds a compass by name.

R3COMPASSMODM_SETCOMPASSLABE

Method

SETCOMPASSLABE

Identifier

R3COMPASSMODM_SETCOMPASSLABE

Param 1:

char*, name of the compass

Param 2:

R3INT*, array of two values: direction and distance

Param 3:

char*, label

JavaScript

obj.SETCOMPASSLABE(p1, p2, p3);

Description

Sets a label for a given compass and position

R3COMPASSMODM_GETCOMPASSLABE

Method

GETCOMPASSLABE

Identifier

R3COMPASSMODM_GETCOMPASSLABE

Param 1:

char*, name of the compass

Param 2:

R3INT*, array of two values: direction and distance

Param 3:

char*, buffer for label

JavaScript

obj.GETCOMPASSLABE(p1, p2, p3);

Description

Gets a label for a given compass and position

R3COMPASSMODM_MAKECOMPASSNAM

Method

MAKECOMPASSNAM

Identifier

R3COMPASSMODM_MAKECOMPASSNAM

Param 1:

char*, name of the compass

Param 3:

R3TAG*, R3COMPASSMODA_CompassName, R3COMPASSMODA_ToolName, R3COMPASSMODA_KeyString, R3COMPASSMODA_ClassName, R3COMPASSMODA_EditString

JavaScript

obj.MAKECOMPASSNAM(p1, p3);

Description

Make compass name

R3COMPASSMODM_ALLOCLABELS

Method

ALLOCLABELS

Identifier

R3COMPASSMODM_ALLOCLABELS

Return

R3BOOL, true if succeeded

Param 1:

char*, compass name

JavaScript

rc = obj.ALLOCLABELS(p1, 0);

Description

Given compass name, allocate the labels for the compass menu

R3COMPASSMODM_FREELABELS

Method

FREELABELS

Identifier

R3COMPASSMODM_FREELABELS

JavaScript

obj.FREELABELS();

Description

free compass labels

R3COMPASSMODCM_FREELABELS

Method

FREELABELS

Identifier

R3COMPASSMODCM_FREELABELS

Param 1:

R3INT, number of circles

JavaScript

obj.FREELABELS(p1, 0);

Description

Class method, free compass labels

R3COMPASSMODM_FINDCTCOMPASS

Method

FINDCTCOMPASS

Identifier

R3COMPASSMODM_FINDCTCOMPASS

Return

R3BOOL, true if compass found

Param 1:

char*, best compass name

Param 3:

R3TAG*, R3COMPASSMODA_CompassName, R3COMPASSMODA_ToolName, R3COMPASSMODA_KeyString, R3COMPASSMODA_ClassName, R3COMPASSMODA_EditString

JavaScript

rc = obj.FINDCTCOMPASS(p1, p3);

Description

Find compass that best matches the given context sensitive conditions. If found, * the method returns with TRUE and the p1 holds the name of the compass.

Tags

R3COMPASSMODA_CompassName

R3COMPASSMODA_ToolName

R3COMPASSMODA_KeyString

R3COMPASSMODA_ClassName

R3COMPASSMODA_EditString