Text

ntx_type: ntx_name

NTX name features represent the most general format for text strings. It gives full positioning control over individual characters within the strings.

The writer can write text in two ways:

Each character is passed list attributes for its properities ntx_name_element{}.character ntx_name_element{}.x ntx_name_element{}.y ntx_name_element{}.ntx_ rotation

Given ntx_name_string the writer will build the above list attributes.

The existence of ntx_number_of_characters determines which mode the writer will use. If ntx_number_of_characters exists, the writer will be expecting the above list attributes; if ntx_number_of_characters does not exist, the writer will build the text attributes from ntx_name_string.

Name features may have the following attributes:

Attribute Name

Contents

ntx_scale

The denominator of the largest scale for which the data is valid. A value of zero means the scale indicator is undefined.

Range: signed 32-bit integer

Default: 0

ntx_weight

The line weight of the object, in steps of 0.001 inches at map scale. A positive value indicates that a rectangular slit should be used to plot the line. A negative value indicates that a round dot should be used to plot the line.

Range: signed 32-bit integer

Default: 0

ntx_font

The font is specified with an integer value that refers to a pattern file which defines the shape of the text characters. The format of such a pattern file is outside of the scope of the NTX format definition, allowing users the freedom to design their own font formats.

Range: signed 32-bit integer

Default: 1

ntx_name_string

The text string of the object.

Range: Any character string

Default: <blank>

ntx_spacing

This is used during writing to specify the space given between each character of the string. The value in ntx_size is used as the default space between each character. The number given in ntx_spacing is used as a multiplication factor against the default spacing.

Range: Any real number

Default: 1.0

ntx_is_linear

This Boolean flag set on reading that signifies if all characters in the text are placed along a line. This may be used when deciding if the ntx_name_string should be used instead of each separate character.

In order for a name to be considered linear, the angle of the first character is taken as a reference and all other character angles are compared to it. As well, the angles of the lines that would connect each character position are compared to the reference angle. If the angles differ by no more than 5 degrees, this flag will be set to Yes.

Range: Yes | No

Default: No

ntx_number_of_characters

The number of individual characters in the name object.

Range: 0 to 32767

Default: 0

ntx_name_element{}.
character

The individual characters for each name element.

Range: Maximum size is 12 characters.

Default: <blank>

ntx_name_element{}.x

ntx_name_element{}.y

The optical centre of individual characters for each name element.

Range: Any real number

Default: 0.0

ntx_name_element{}.ntx_ rotation

The angle of individual characters for each name element. The angle is specified in degrees of arc, counterclockwise. Zero means upright.

Range: -360.0 to +360.0

Default: 0.0

ntx_type: ntx_text

NTX text features hold text blocks. A single 2D or 3D position is associated with the text block. Text features may have the following attributes:

Attribute Name

Contents

ntx_scale

The denominator of the largest scale for which the data is valid. A value of zero means the scale indicator is undefined.

Range: signed 32-bit integer

Default: 0

ntx_font_type

Range: Valid values are:

1 = Text edited by usl$editor

These text blocks contain special formatting codes within the text block prefixed by a backslash.

Default: 1

ntx_rotation

The angle of the string, in degrees.

Range: -360.0 to +360.0

Default: 0.0

ntx_justification

The justification of the text block. Valid values are between –4 and +4 inclusive. This represents the position on the cover of the block, or the centre, that was used to position the block.

Range: -4 to 4

The meaning of the justification values are as follows:

Default: 0

ntx_text_string

The text string of the object.

Range: Any character string

Default: <blank>