class HT_Parallel_Line

class HT_Parallel_Line_Set

This class provides the definition for the sets of parallel line patterns that are the basis of the fill patterns defined by HT_Hatch_Pattern. The pattern consists of some number of parallel line sets defined within a unit square. These are sets of parallel line patterns which start at a specific origin, cross at various angles, are spaced at intervals, and can be skewed (offset) to a specified distance.

See Also For a code example and illustration see, HT_Hatch_Pattern . For more information, see the section, "User Defined Hatch Patterns" in "Chapter 2, "Renditions," and HT_Rendition hatch_pattern. Access methods

angle

Returns the line set angle.

count

Returns the number of values in the array of floats.

length

Internal ¾ sum of lengths in the pattern array.

pattern

Returns the array of floats.

skew

Returns the multiplier values for each R, G, and B component.

spacing

Returns the spacing between the lines.

Returns the x origin.

Returns the y origin.

Operators

operator=

Standard operator for copying the array.

Constructor/Destructor

HT_Parallel_Line_Set

Creates an HT_Parallel_Line_Set object.

~HT_Parallel_Line_Set

Destructor.

HT_Parallel_Line_Set::angle

Purpose

Returns the angle of the line pattern from the origin of the unit square. Synopsis

float angle (void) const

HT_Parallel_Line_Set::count

Purpose

Returns the number of values in the array of floats that make up the pattern definition. Synopsis

int count (void) const

Details For example, the following line pattern has a count of 2 with an array of .5, .5.

¾ ¾

That is, it has 2 dashes and 2 spaces each .5 units long.

HT_Parallel_Line_Set::HT_Parallel_Line_Set

Purpose

Constructs an HT_Parallel_Line_Set object. Synopsis

HT_Parallel_Line_Set ()

HEIDI_API HT_Parallel_Line_Set (float x, float y, float angle, float spacing, float skew = 0.0f,
                              int pattern_count = 0, float const * pattern = null)

Details The second form shows the order of the arguments and which have default values, to the constructor.

HT_Parallel_Line_Set::~HT_Parallel_Line_Set

Purpose

Destructor. Synopsis

HT_Parallel_Line_Set::~HT_Parallel_Line_Set ()

HT_Parallel_Line_Set::length

Purpose

Internal ¾ sum of lengths in the pattern array. Synopsis

float length (void) const

HT_Parallel_Line_Set::operator=

Purpose

Standard operator for copying the array. Synopsis

HEIDI_API HT_Parallel_Line_Set const & operator= (HT_Parallel_Line_Set const & input) alter

HT_Parallel_Line_Set::pattern

Purpose

Returns the array of floats. Synopsis

float const *   pattern (void) const

HT_Parallel_Line_Set::skew

Purpose

Returns a structure that holds the multiplier values for each R, G, and B component. Synopsis

float skew (void) const

HT_Parallel_Line_Set::spacing

Purpose

. Synopsis

float spacing (void) const

HT_Parallel_Line_Set::x

Purpose

Returns the x origin. Synopsis

float x (void) const

Details The origin is based on the lower left corner of the unit square.

HT_Parallel_Line_Set::y

Purpose

Returns the y origin. Synopsis

float y (void) const

Details The origin is based on the lower left corner of the unit square.