The LinePatternParallelKit class is a user space object. It is used to define a single parallel within a line pattern. More...
Public Member Functions | |
override void | Dispose () |
LinePatternParallelKit () | |
The default constructor creates an empty LinePatternParallelKit object. More... | |
LinePatternParallelKit (HPS.LinePatternParallelKit in_kit) | |
The copy constructor creates a new LinePatternParallelKit object that contains the same settings as the source LinePatternParallelKit. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.LinePatternParallelKit in_kit) |
Copies the source LinePatternParallelKit into this LinePatternParallelKit. More... | |
void | Show (out HPS.LinePatternParallelKit out_kit) |
Copies this LinePatternParallelKit into the given LinePatternParallelKit. More... | |
override bool | Empty () |
Indicates whether this LinePatternParallelKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.LinePatternParallelKit in_kit) |
Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | SetStartCap (HPS.GlyphLinePatternElement in_start) |
Sets the glyph to draw at the start point for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | SetEndCap (HPS.GlyphLinePatternElement in_end) |
Sets the glyph to draw at the end point for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | SetJoin (HPS.GlyphLinePatternElement in_join) |
Sets the glyph to draw at all joins for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | SetBody (HPS.LinePatternElement[] in_elements) |
Sets the line pattern element array for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | SetAbsoluteLength (bool in_state) |
Sets a flag indicating whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | SetAbsoluteWeight (bool in_state) |
Sets a flag indicating whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | SetJustification (HPS.LinePattern.Justification in_type) |
Sets how the pattern will fit between the end points for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | SetOffset (float in_offset, HPS.LinePattern.SizeUnits in_units, bool in_fixed) |
Sets the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | SetOffset (float in_offset, HPS.LinePattern.SizeUnits in_units) |
Sets the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | SetWeight (float in_weight, HPS.LinePattern.SizeUnits in_units, bool in_fixed) |
Sets the line weight for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | SetWeight (float in_weight, HPS.LinePattern.SizeUnits in_units) |
Sets the line weight for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | SetContinuous (bool in_state) |
Sets whether to reset the line pattern in each segment for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | UnsetStartCap () |
Removes the glyph to draw at the start point for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | UnsetEndCap () |
Removes the glyph to draw at the end point for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | UnsetJoin () |
Removes the glyph to draw at all joins for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | UnsetBody () |
Removes the line pattern element body for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | UnsetAbsoluteLength () |
Removes whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | UnsetAbsoluteWeight () |
Removes whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | UnsetJustification () |
Removes how the pattern will fit between the end points for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | UnsetOffset () |
Removes the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | UnsetWeight () |
Removes the line weight for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | UnsetContinuous () |
Removes whether to reset the line pattern in each segment for this LinePatternParallelKit. More... | |
HPS.LinePatternParallelKit | UnsetEverything () |
Removes all settings from this LinePatternParallelKit. More... | |
bool | ShowStartCap (out HPS.GlyphLinePatternElement out_start) |
Shows the glyph to draw at the start point for this LinePatternParallelKit. More... | |
bool | ShowEndCap (out HPS.GlyphLinePatternElement out_end) |
Shows the glyph to draw at the end point for this LinePatternParallelKit. More... | |
bool | ShowJoin (out HPS.GlyphLinePatternElement out_join) |
Shows the glyph to draw at all joins for this LinePatternParallelKit. More... | |
bool | ShowBody (out HPS.LinePatternElement[] out_elements) |
Shows the line pattern element body for this LinePatternParallelKit. More... | |
bool | ShowAbsoluteLength (out bool out_state) |
Shows whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit. More... | |
bool | ShowAbsoluteWeight (out bool out_state) |
Shows whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit. More... | |
bool | ShowJustification (out HPS.LinePattern.Justification out_type) |
Shows how the pattern will fit between the end points for this LinePatternParallelKit. More... | |
bool | ShowOffset (out float out_offset, out HPS.LinePattern.SizeUnits out_units, out bool out_fixed) |
Shows the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit. More... | |
bool | ShowWeight (out float out_weight, out HPS.LinePattern.SizeUnits out_units, out bool out_fixed) |
Shows the line weight for this LinePatternParallelKit. More... | |
bool | ShowContinuous (out bool out_state) |
Shows whether to reset the line pattern in each segment for this LinePatternParallelKit. More... | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object that) | |
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... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
Static Public Member Functions | |
static bool | operator== (HPS.LinePatternParallelKit a, HPS.LinePatternParallelKit b) |
static bool | operator!= (HPS.LinePatternParallelKit a, HPS.LinePatternParallelKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The LinePatternParallelKit class is a user space object. It is used to define a single parallel within a line pattern.
|
inline |
The default constructor creates an empty LinePatternParallelKit object.
|
inline |
The copy constructor creates a new LinePatternParallelKit object that contains the same settings as the source LinePatternParallelKit.
in_kit | The source LinePatternParallelKit to copy. |
|
inlinevirtual |
Indicates whether this LinePatternParallelKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit.
in_kit | The source LinePatternParallelKit to compare to this LinePatternParallelKit. |
|
inlinevirtual |
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.
|
inline |
Copies the source LinePatternParallelKit into this LinePatternParallelKit.
in_kit | The source LinePatternParallelKit to copy. |
|
inline |
Sets a flag indicating whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
in_state | Whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit. |
|
inline |
Sets a flag indicating whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
in_state | Whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit. |
|
inline |
Sets the line pattern element array for this LinePatternParallelKit.
in_elements | The line pattern element array for this LinePatternParallelKit. |
|
inline |
Sets whether to reset the line pattern in each segment for this LinePatternParallelKit.
in_state | Whether to reset the line pattern in each segment for this LinePatternParallelKit. |
|
inline |
Sets the glyph to draw at the end point for this LinePatternParallelKit.
in_end | The glyph to draw at the end point for this LinePatternParallelKit. |
|
inline |
Sets the glyph to draw at all joins for this LinePatternParallelKit.
in_join | The glyph to draw at all joins for this LinePatternParallelKit. |
|
inline |
Sets how the pattern will fit between the end points for this LinePatternParallelKit.
in_type | How the pattern will fit between the end points for this LinePatternParallelKit. |
|
inline |
Sets the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.
in_offset | The offset above (positive) or below (negative) the line connecting two points defining a segment for this LinePatternParallelKit. |
in_units | The units for the offset for this LinePatternParallelKit. |
in_fixed | Whether to prevent scaling the offset based on the effective line weight in the segment where this pattern is used. Defaults to false. |
|
inline |
Sets the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.
in_offset | The offset above (positive) or below (negative) the line connecting two points defining a segment for this LinePatternParallelKit. |
in_units | The units for the offset for this LinePatternParallelKit. |
|
inline |
Sets the glyph to draw at the start point for this LinePatternParallelKit.
in_start | The glyph to draw at the start point for this LinePatternParallelKit. |
|
inline |
Sets the line weight for this LinePatternParallelKit.
in_weight | The line weight for this LinePatternParallelKit. |
in_units | The units for the weight for this LinePatternParallelKit. |
in_fixed | Whether to override the effective line weight in the segment where this pattern is used. Defaults to false. |
|
inline |
Sets the line weight for this LinePatternParallelKit.
in_weight | The line weight for this LinePatternParallelKit. |
in_units | The units for the weight for this LinePatternParallelKit. |
|
inline |
Copies this LinePatternParallelKit into the given LinePatternParallelKit.
out_kit | The LinePatternParallelKit to populate with the contents of this LinePatternParallelKit. |
|
inline |
Shows whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
out_state | Whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit. |
|
inline |
Shows whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
out_state | Whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit. |
|
inline |
Shows the line pattern element body for this LinePatternParallelKit.
out_elements | The line pattern element body for this LinePatternParallelKit. |
|
inline |
Shows whether to reset the line pattern in each segment for this LinePatternParallelKit.
out_state | Whether to reset the line pattern in each segment for this LinePatternParallelKit. |
|
inline |
Shows the glyph to draw at the end point for this LinePatternParallelKit.
out_end | The glyph to draw at the end point for this LinePatternParallelKit. |
|
inline |
Shows the glyph to draw at all joins for this LinePatternParallelKit.
out_join | The glyph to draw at all joins for this LinePatternParallelKit. |
|
inline |
Shows how the pattern will fit between the end points for this LinePatternParallelKit.
out_type | How the pattern will fit between the end points for this LinePatternParallelKit. |
|
inline |
Shows the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.
out_offset | The offset above (positive) or below (negative) the line connecting two points defining a segment for this LinePatternParallelKit. |
out_units | The units for the offset for this LinePatternParallelKit. |
out_fixed | Whether to prevent scaling the offset based on the effective line weight in the segment where this pattern is used. |
|
inline |
Shows the glyph to draw at the start point for this LinePatternParallelKit.
out_start | The glyph to draw at the start point for this LinePatternParallelKit. |
|
inline |
Shows the line weight for this LinePatternParallelKit.
out_weight | The line weight for this LinePatternParallelKit. |
out_units | The units for the weight for this LinePatternParallelKit. |
out_fixed | Whether to override the effective line weight in the segment where this pattern is used. |
|
inline |
Removes whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
|
inline |
Removes whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
|
inline |
Removes the line pattern element body for this LinePatternParallelKit.
|
inline |
Removes whether to reset the line pattern in each segment for this LinePatternParallelKit.
|
inline |
Removes the glyph to draw at the end point for this LinePatternParallelKit.
|
inline |
Removes all settings from this LinePatternParallelKit.
|
inline |
Removes the glyph to draw at all joins for this LinePatternParallelKit.
|
inline |
Removes how the pattern will fit between the end points for this LinePatternParallelKit.
|
inline |
Removes the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.
|
inline |
Removes the glyph to draw at the start point for this LinePatternParallelKit.
|
inline |
Removes the line weight for this LinePatternParallelKit.