DEFINE PATTERN

DEFINE PATTERN defines a pattern, which can be referred to by name further on in other scripts.

Pattern definitions prior to the definition of this pattern may be included in any script; however, patterns defined that way can be used solely in those scripts, in which they are defined, and their subsequent second generation-scripts.

Syntax

DEFINE PATTERN name, id [, scale_dependent, angle, scale_x, scale_y, ref_x, ref_y, fitting_mode, red, green, blue, alpha]

Parameters

name (string): name of the pattern, by which can be referred to this pattern

id (integer): number of the pattern

scale_dependent (integer): appearance of the pattern depends on scale or not

with scale_dependent may be 0 or 1
0: not scale dependant
1: scale dependant

angle (decimal): rotation angle (default: 0.0)

scale_x, scale_y (decimal): scaling of the pattern in X resp. Y direction (default: 1.0)

with scale_x, scale_y ¹ 0

ref_x, ref_y (decimal): X resp. Y coordinate of the reference point (default: (0.0;0.0))

fitting_mode (integer): fitting of the pattern

with fitting_mode may be
1: outside fitting
2: fitting
3: inside fitting

red, green, blue (integer): color palette for masking/background color (default: no color)

with 0 £ red, green resp. blue £ 255

alpha (integer): tilt angle of the pattern

with 0 £ alpha £ 100

Corresponding commands

[set] PATTERN name_string

[set] PATTERN index

Index is a constant referring to a pattern stack in the internal data structure; this stack is modified during script analysis and can also be modified from within the program. Any use of the index instead of the pattern's name is only recommended with the prior use of the INDEX function.

Remarks

Usable since script version 1.1 (Allplan 2012-1).