
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. 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. More... | |
GlyphLinePatternElement (HPS.GlyphLinePatternElement in_that) | |
The copy constructor creates a new GlyphLinePatternElement object that contains the same settings as the source GlyphLinePatternElement. More... | |
override HPS.Type | ObjectType () |
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 () |
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 the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. 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 |
Detailed Description
The GlyphLinePatternElement class is a user space object. It is used for specifying glyphs elements within a line pattern.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty GlyphLinePatternElement object.
|
inline |
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.
- Parameters
-
in_that The source LinePatternElement to copy.
|
inline |
The copy constructor creates a new GlyphLinePatternElement object that contains the same settings as the source GlyphLinePatternElement.
- Parameters
-
in_that The source GlyphLinePatternElement to copy.
Member Function Documentation
|
inline |
Sets whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.
- Parameters
-
in_state Whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.
|
inline |
Sets the inset behavior for this GlyphLinePatternElement.
- Parameters
-
in_behavior The inset behavior for this GlyphLinePatternElement.
|
inline |
Sets whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.
- Parameters
-
in_state Whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.
|
inline |
Sets the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.
- Parameters
-
in_degrees The angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.
|
inline |
Sets the name of the source for this GlyphLinePatternElement.
- Parameters
-
in_source UTF8-encoded name of the source for this GlyphLinePatternElement.
|
inline |
Sets the weight for this GlyphLinePatternElement.
- Parameters
-
in_weight The weight for this GlyphLinePatternElement. in_units The units of the weight for this GlyphLinePatternElement.
|
inline |
Shows whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.
- Parameters
-
out_state Whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.
- Returns
- true if a fixed flag was set, false otherwise.
|
inline |
Shows the inset behavior for this GlyphLinePatternElement.
- Parameters
-
out_behavior The inset behavior for this GlyphLinePatternElement.
- Returns
- true if an inset behavior was set, false otherwise.
|
inline |
Shows whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.
- Parameters
-
out_state Whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.
- Returns
- true if a mirror flag was set, false otherwise.
|
inline |
Shows the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.
- Parameters
-
out_degrees The angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.
- Returns
- true if an angle was set, false otherwise.
|
inline |
Shows the name of the source for this GlyphLinePatternElement.
- Parameters
-
out_source UTF8-encoded name of the source for this GlyphLinePatternElement.
- Returns
- true if a source was set, false otherwise.
|
inline |
Shows the weight for this GlyphLinePatternElement.
- Parameters
-
out_weight The weight for this GlyphLinePatternElement. out_units The units for the weight for this GlyphLinePatternElement.
- Returns
- true if a weight was set, false otherwise.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.GlyphLinePatternElement.cs