GlyphLinePatternElement

class HPS.GlyphLinePatternElement : HPS.LinePatternElement

The GlyphLinePatternElement class is a user space object. It is used for specifying glyphs elements within a line pattern.

Public Functions

override void Dispose ()

GlyphLinePatternElement ()

The default constructor creates an empty GlyphLinePatternElement object.

GlyphLinePatternElement (HPS.GlyphLinePatternElement in_that)

The copy constructor creates a new GlyphLinePatternElement object that contains the same settings as the source GlyphLinePatternElement.

Param in_that:The source GlyphLinePatternElement to copy.

GlyphLinePatternElement (HPS.LinePatternElement in_that)

This constructor creates a GlyphLinePatternElement object that contains the same settings as the source LinePatternElement. The copy will only be successful if the source line pattern element is really an upcast of a glyph line pattern element. Otherwise the copy will fail and the resulting GlyphLinePatternElement will be invalid.

Param in_that:The source LinePatternElement to copy.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return:The declared type of the object in question, which may differ from the true, underlying type.

void SetFixed (bool in_state)

Sets whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.

Param in_state:Whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.

void SetInsetBehavior (HPS.LinePattern.InsetBehavior in_behavior)

Sets the inset behavior for this GlyphLinePatternElement.

Param in_behavior:  The inset behavior for this GlyphLinePatternElement.

void SetMirror (bool in_state)

Sets whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.

Param in_state:Whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.

void SetRotation (float in_degrees)

Sets the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.

Param in_degrees:  The angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.

void SetSource (string in_source)

Sets the name of the source for this GlyphLinePatternElement.

Param in_source:  UTF8-encoded name of the source for this GlyphLinePatternElement.

void SetWeight (float in_weight, HPS.LinePattern.SizeUnits in_units)

Sets the weight for this GlyphLinePatternElement.

Param in_weight:  The weight for this GlyphLinePatternElement. Param in_units:The units of the weight for this GlyphLinePatternElement.

bool ShowFixed (out bool out_state)

Shows whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.

Param out_state:  Whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector. Return:true if a fixed flag was set, false otherwise.

bool ShowInsetBehavior (out HPS.LinePattern.InsetBehavior out_behavior)

Shows the inset behavior for this GlyphLinePatternElement.

Param out_behavior:  The inset behavior for this GlyphLinePatternElement. Return:true if an inset behavior was set, false otherwise.

bool ShowMirror (out bool out_state)

Shows whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.

Param out_state:  Whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation. Return:true if a mirror flag was set, false otherwise.

bool ShowRotation (out float out_degrees)

Shows the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.

Param out_degrees:  The angle in degrees the GlyphLinePatternElement is rotated relative to the line vector. Return:true if an angle was set, false otherwise.

bool ShowSource (out string out_source)

Shows the name of the source for this GlyphLinePatternElement.

Param out_source:  UTF8-encoded name of the source for this GlyphLinePatternElement. Return:true if a source was set, false otherwise.

bool ShowWeight (out float out_weight, out HPS.LinePattern.SizeUnits out_units)

Shows the weight for this GlyphLinePatternElement.

Param out_weight:  The weight for this GlyphLinePatternElement. Param out_units:  The units for the weight for this GlyphLinePatternElement. Return:true if a weight was set, false otherwise.