LinePattern

class HPS.LinePattern : public IDisposable

The LinePattern class is a concept class for line-pattern-related enum classes.

Public Types

enum Cap

Enumerates the predefined cap types that can be used at the ends of line segments within a line pattern.

Values:

Butt
Square
Round
Mitre
enum Default

Enumerates the predefined line patterns in Visualize. These can be accessed via the LinePatternKit.GetDefault function and their appearance can be seen here. Hardware acceleration for line patterns is available when the following conditions are met:You are using the DirectX11 or OpenGL2 driver You are using Visualize 2015 or later Segment-level display lists are active The line weight is 1 The following line patterns can be hardware accelerated: Dashed, Dotted, DashDot, Dash2Dot, Dash3Dot, LongDash, FineDot. The pattern does not continue along adjacent edges. The pattern is restarted for each edge.

Values:

Solid

A solid unbroked line pattern.

DashDot

A repeating pattern of 18 solid pixels, 5 blank pixels, 4 solid pixels, and 5 blank pixels.

Dashed

A repeating pattern of 10 solid pixels and 6 blank pixels.

Dotted

A repeating pattern of 5 solid pixels and 3 blank pixels.

Dash2Dot

A repeating pattern of 15 solid pixels, 4 blank pixels, 3 solid pixels, 3 blank pixels, 3 solid pixels, and 4 blank pixels.

Dash3Dot

A repeating pattern of 15 solid pixels, 2 blank pixels, 3 solid pixels, 2 blank pixels, 3 solid pixels, 2 blank pixels, 3 solid pixels, and 2 blank pixels.

LongDash

A repeating pattern of 26 solid pixels and 6 blank pixels.

LongDashShortDash

A repeating pattern of 100 solid pixels, 10 blank pixels, 20 solid pixels, and 10 blank pixels.

LongDash2ShortDash

A repeating pattern of 86 solid pixels, 8 blank pixels, 15 solid pixels, 8 blank pixels, 15 solid pixels, and 8 blank pixels.

FineDot

A repeating pattern of 1 solid pixel and 3 blank pixels.

enum InsetBehavior

Enumerates how glyphs interact with other line pattern elements within a line pattern.

Values:

Overlap

Glyphs will overlap with surrounding line pattern elements.

Trim

Glyphs will overlap with surrounding line pattern elements.

Inline

Glyphs will not overlap with surrounding line pattern elements, and adjacent line pattern elements will not be trimmed.

enum Join

Enumerates the types of join to use for a line pattern. Joins will always be mitred at the half angle for the smaller angle defined by two line segments. This enumeration defines what the join will look like for the larger angle defined by two line segments.

Values:

Mitre

The join for the larger angle will be mitred, i.e., the segments will meet at a point at the half angle of the larger angle.

Round

The join for the larger angle will be rounded, i.e., there will be a circle that subtends the larger angle.

Bevel

The join for the larger angle will be beveled, i.e., there will be a line that subtends the larger angle.

enum Justification

Enumerates the justfication modes for a line pattern. These are used to attempt to make the line pattern appear evenly spaced between end points of a line.

Values:

Center
Stretch
enum Modifier

Enumerates the types of joins, start caps, and end caps that can be set when a line pattern attribute is set.

Values:

GlyphName

A glyph was set for the cap or join. The glyph name is valid.

Enumerated

A predefined (enumerated) cap or join was set. The enumeration type is valid.

enum SizeUnits

Enumerates the units used when specifying length, weight and offsets for line patterns.

Values:

ObjectSpace

Object space units ignoring any scaling components in modelling matrices.

SubscreenRelative

Fraction of the height of the outermost window.

WindowRelative

Fraction of the height of the local window.

WorldSpace

Object space units including any scaling components in modelling matrices and cameras.

Points

Points units typically used for text size. 1 point corresponds to 1/72 inch.

Pixels

Number of pixels.

ScaleFactor

Fraction of the default line width.

Public Functions

void Dispose ()
LinePattern (HPS.LinePattern in_that)