PM_GET_LABEL_PROPERTIES

Syntax

int_val = PM_GET_LABEL_PROPERTIES ( label_name [, keyword, arguments, ...] );

Input arguments

string	label_name	The name of the used label.
string	keyword

Output arguments

dynamic

arguments

Return Values

Success:

int

0

Performed successfully.

Failure:

int	-1	Script interface error.
int	-2	No such label.
int	-3	Unknown keyword.

Description

This function gets properties of a given label definition. Detailed information about the values and their meaning is given in the Plant Modeller's Administrator Manual.

The following keyword/argument combinations are accepted:

"SYMNAME", sym_name
Expects one string to receive the name of the symbol to be used to render the label. For text type labels this string contains digits that will be converted to a number that will then be used as the text type in DW. For symbol type labels this is the name of the symbol.

"TARGET_TYPE", target_type
Expects one integer to receive the target type of the label. Can be PM_LBL_TARGET_OBJECT, PM_LBL_TARGET_CONNECTION or PM_LBL_TARGET_POINT. These constants are defined in include file pm_annot.h.

"MATCHRULE", match_rule
Expects one integer to receive the matching rule of the label. Matchrule indicates to what kind of objects this label is intended to be used with.

"INPUTRULE", input_rule
Expects one integer to receive the inputrule of the label.
Inputrule indicates how the points (pick point, origin, and reference line end point) related to a label are input. See defined constants PM_LBL_IR_xxx in "pm_annot.h".

"DATA_EDITABLE", data_editable
Expects one integer to receive a boolean value. If TRUE then the user should be allowed to edit label data after it has been extracted from 3D model but before it is sent to the label for display.

"LABEL_TYPE", label_type
Expects one integer to receive the type of the label. This specifies the target (object, node, or 3D point) and the type of the dw object (text or symbol) that implements the label. The value is the same as in the "desc" field of the definitions in Labels.def.

"SCALE_X", scale_x
Expects one float to receive the x-scale applied to the symbol that renders the label.

"SCALE_Y", scale_y
Expects one float to receive the y-scale applied to the symbol that renders the label.

"ROTATION", rotation
Expects one float to receive the rotation in degrees applied to the symbol that renders the label.