REFERENCE MANUAL
The GlyphLinePatternElement class is a user space object. More...
Public Member Functions | |
override void | Dispose () |
GlyphLinePatternElement () | |
The default constructor creates an empty GlyphLinePatternElement object. More... | |
GlyphLinePatternElement (HPS.LinePatternElement in_that) | |
This constructor creates a GlyphLinePatternElement object that contains the same settings as the source LinePatternElement. More... | |
GlyphLinePatternElement (HPS.GlyphLinePatternElement in_that) | |
This constructor creates a GlyphLinePatternElement object that contains the same settings as the source LinePatternElement. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | SetFixed (bool in_state) |
Sets whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector. More... | |
void | SetInsetBehavior (HPS.LinePattern.InsetBehavior in_behavior) |
Sets the inset behavior for this GlyphLinePatternElement. More... | |
void | SetMirror (bool in_state) |
Sets whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation. More... | |
void | SetRotation (float in_degrees) |
Sets the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector. More... | |
void | SetSource (string in_source) |
Sets the name of the source for this GlyphLinePatternElement. More... | |
void | SetWeight (float in_weight, HPS.LinePattern.SizeUnits in_units) |
Sets the weight for this GlyphLinePatternElement. More... | |
bool | ShowFixed (out bool out_state) |
Shows whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector. More... | |
bool | ShowInsetBehavior (out HPS.LinePattern.InsetBehavior out_behavior) |
Shows the inset behavior for this GlyphLinePatternElement. More... | |
bool | ShowMirror (out bool out_state) |
Shows whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation. More... | |
bool | ShowRotation (out float out_degrees) |
Shows the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector. More... | |
bool | ShowSource (out string out_source) |
Shows the name of the source for this GlyphLinePatternElement. More... | |
bool | ShowWeight (out float out_weight, out HPS.LinePattern.SizeUnits out_units) |
Shows the weight for this GlyphLinePatternElement. More... | |
![]() | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.LinePatternElement in_that) |
Check if the source LinePatternElement is equivalent to this LinePatternElement. More... | |
override int | GetHashCode () |
LinePatternElement () | |
The default constructor creates an empty LinePatternElement object. More... | |
LinePatternElement (HPS.LinePatternElement in_that) | |
The copy constructor creates a new LinePatternElement object that contains the same settings as the source LinePatternElement. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.LinePatternElement in_that) |
Copies the source LinePatternElement into this LinePatternElement. More... | |
void | SetSize (float in_size, HPS.LinePattern.SizeUnits in_units) |
Sets the size of this LinePatternElement. More... | |
bool | ShowSize (out float out_size, out HPS.LinePattern.SizeUnits out_units) |
Shows the size of this LinePatternElement. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.LinePatternElement a, HPS.LinePatternElement b) |
static bool | operator== (HPS.LinePatternElement a, HPS.LinePatternElement b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The GlyphLinePatternElement class is a user space object.
It is used for specifying glyphs elements within a line pattern.
HPS.GlyphLinePatternElement.GlyphLinePatternElement | ( | ) |
The default constructor creates an empty GlyphLinePatternElement object.
HPS.GlyphLinePatternElement.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.
in_that | The source <ref refid="class_h_p_s_1_1_line_pattern_element" kindref="compound">LinePatternElement</ref> to copy. |
HPS.GlyphLinePatternElement.GlyphLinePatternElement | ( | HPS.GlyphLinePatternElement | 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.
in_that | The source <ref refid="class_h_p_s_1_1_line_pattern_element" kindref="compound">LinePatternElement</ref> to copy. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.GlyphLinePatternElement.SetFixed | ( | bool | in_state | ) |
Sets whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.
in_state | Whether the angle of the <ref refid="class_h_p_s_1_1_glyph_line_pattern_element" kindref="compound">GlyphLinePatternElement</ref> should be fixed relative to the line vector. |
void HPS.GlyphLinePatternElement.SetInsetBehavior | ( | HPS.LinePattern.InsetBehavior | in_behavior | ) |
Sets the inset behavior for this GlyphLinePatternElement.
in_behavior | The inset behavior for this <ref refid="class_h_p_s_1_1_glyph_line_pattern_element" kindref="compound">GlyphLinePatternElement</ref>. |
void HPS.GlyphLinePatternElement.SetMirror | ( | bool | in_state | ) |
Sets whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.
in_state | Whether to flip this <ref refid="class_h_p_s_1_1_glyph_line_pattern_element" kindref="compound">GlyphLinePatternElement</ref> about the x-axis prior to applying any rotation. |
void HPS.GlyphLinePatternElement.SetRotation | ( | float | in_degrees | ) |
Sets the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.
in_degrees | The angle in degrees the <ref refid="class_h_p_s_1_1_glyph_line_pattern_element" kindref="compound">GlyphLinePatternElement</ref> is rotated relative to the line vector. |
void HPS.GlyphLinePatternElement.SetSource | ( | string | in_source | ) |
Sets the name of the source for this GlyphLinePatternElement.
in_source | UTF8-encoded name of the source for this <ref refid="class_h_p_s_1_1_glyph_line_pattern_element" kindref="compound">GlyphLinePatternElement</ref>. |
void HPS.GlyphLinePatternElement.SetWeight | ( | float | in_weight, |
HPS.LinePattern.SizeUnits | in_units | ||
) |
Sets the weight for this GlyphLinePatternElement.
in_weight | The weight for this <ref refid="class_h_p_s_1_1_glyph_line_pattern_element" kindref="compound">GlyphLinePatternElement</ref>. |
in_units | The units of the weight for this <ref refid="class_h_p_s_1_1_glyph_line_pattern_element" kindref="compound">GlyphLinePatternElement</ref>. |
bool HPS.GlyphLinePatternElement.ShowFixed | ( | out bool | out_state | ) |
Shows whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.
out_state | Whether the angle of the <ref refid="class_h_p_s_1_1_glyph_line_pattern_element" kindref="compound">GlyphLinePatternElement</ref> should be fixed relative to the line vector. |
bool HPS.GlyphLinePatternElement.ShowInsetBehavior | ( | out HPS.LinePattern.InsetBehavior | out_behavior | ) |
Shows the inset behavior for this GlyphLinePatternElement.
out_behavior | The inset behavior for this <ref refid="class_h_p_s_1_1_glyph_line_pattern_element" kindref="compound">GlyphLinePatternElement</ref>. |
bool HPS.GlyphLinePatternElement.ShowMirror | ( | out bool | out_state | ) |
Shows whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.
out_state | Whether to flip this <ref refid="class_h_p_s_1_1_glyph_line_pattern_element" kindref="compound">GlyphLinePatternElement</ref> about the x-axis prior to applying any rotation. |
bool HPS.GlyphLinePatternElement.ShowRotation | ( | out float | out_degrees | ) |
Shows the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.
out_degrees | The angle in degrees the <ref refid="class_h_p_s_1_1_glyph_line_pattern_element" kindref="compound">GlyphLinePatternElement</ref> is rotated relative to the line vector. |
bool HPS.GlyphLinePatternElement.ShowSource | ( | out string | out_source | ) |
Shows the name of the source for this GlyphLinePatternElement.
out_source | UTF8-encoded name of the source for this <ref refid="class_h_p_s_1_1_glyph_line_pattern_element" kindref="compound">GlyphLinePatternElement</ref>. |
bool HPS.GlyphLinePatternElement.ShowWeight | ( | out float | out_weight, |
out HPS.LinePattern.SizeUnits | out_units | ||
) |
Shows the weight for this GlyphLinePatternElement.
out_weight | The weight for this <ref refid="class_h_p_s_1_1_glyph_line_pattern_element" kindref="compound">GlyphLinePatternElement</ref>. |
out_units | The units for the weight for this <ref refid="class_h_p_s_1_1_glyph_line_pattern_element" kindref="compound">GlyphLinePatternElement</ref>. |