Command: hatchstyle

Syntax

hatchstyle <name> {
    <stroke_def>
    ...
}

or

hatchstyle <name> = <ident>

Description

Create or redefine a hatchstyle identifier.

Parameters

• <name>
  The name of the hatchstyle identifier.

• <stroke_def>
  A list of pattern phrases describing the characteristics of one stroke of the hatch pattern. Two strokes would constitute a typical cross-hatching pattern. Phrases are separated by commas.

• <ident>
  Copy the attributes of an existing hatchstyle identifier into the new hatchstyle identifier. All command switches are ignored.

Switches

None

Block

The data block containing multiple <stroke_def> phrases. Available phrases are as follows:

• a=<angle>
  The angle at which line strokes are to be drawn. It is measured counterclockwise from zero, the horizontal. The default is zero.

• col=<color>
  Defines the color of the line strokes.

• g=<num>
  Indicates the spacing (or gap) between parallel line strokes.

• ls=<linestyle | color>
  Defines the linestyle of the line strokes. This will override any col parameter, and vice versa.

• o=<num>
  Offset the first line by a distance. This has the effect of using a gap of size <num> before the first line is drawn. It is used once only. Thereafter the value of g is used between consecutive strokes. If omitted, the value is that of the gap (g=).

• su=<text>
  The units in which the dimensions (g and o) are measured. Possible values can be found here. If omitted, the default is M.

Phrases apply only to the stroke definition of which they are a part. They do not apply to other strokes unless included in those stroke definitions.

Notes

Multiple stroke definitions create a hatchstyle identifier array, but the identifier <name> should not be declared as an array. The array creation is performed automatically.

If no color is provided in a stroke, a default foreground color (usually black) is used.

Hatchstyle identifiers can have global or application scope, but cannot have local scope. When local hatchstyle identifiers are required, string identifiers should be used to reference the hatchstyles by name.

Examples

Simple single stroke pattern.

hatchstyle hatch_45 { a=45, g=50 }

Simple cross-hatch pattern.

hatchstyle cross_hatch {
    a=45, g=100
    a=135, g=100
}

Multi-colored tartan pattern (four- strokes).

hatchstyle macduff {
    col=blue, a=45, g=125
    col=blue, a=45, o=25, g=125
    col=green, a=135, g=50
    col=green, a=135, o=10, g=50
}

A three-stroke pattern.

hatchstyle my_hatch {
    a=0, g=100; # Continuous.
    a=0, o=50, g=100, ls=dot_dash; # Dot-Dash.
    a=90, g=200; # Thick vertical bars.
}

A general hatch pattern for screen display only with gaps of 20 pixels

hatchstyle screen_20 {
    su=p, a=45, g=20
    su=p, a=135, g=20; # Note: p in both lines.
}

Make a copy of a hatchstyle.

hatchstyle new_hatch = cross_hatch

See Also