LinePatternParallelKit
- class HPS.LinePatternParallelKit : public HPS.Kit
The LinePatternParallelKit class is a user space object. It is used to define a single parallel within a line pattern.
Public Functions
- override void Dispose ()
- override bool Empty ()
Indicates whether this LinePatternParallelKit has any values set on it.
- Return
true if no values are set on this LinePatternParallelKit, false otherwise.
- bool Equals (HPS.LinePatternParallelKit in_kit)
Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit.
- Param in_kit
The source LinePatternParallelKit to compare to this LinePatternParallelKit.
- Return
true if the objects are equivalent, false otherwise.
- override bool Equals (Object obj)
- override int GetHashCode ()
- LinePatternParallelKit ()
The default constructor creates an empty LinePatternParallelKit object.
- LinePatternParallelKit (HPS.LinePatternParallelKit in_kit)
The copy constructor creates a new LinePatternParallelKit object that contains the same settings as the source LinePatternParallelKit.
- Param in_kit
The source LinePatternParallelKit 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 Set (HPS.LinePatternParallelKit in_kit)
Copies the source LinePatternParallelKit into this LinePatternParallelKit.
- Param in_kit
The source LinePatternParallelKit to copy.
- 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.
- Param in_state
Whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- 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.
- Param in_state
Whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit SetBody (HPS.LinePatternElement in_element)
Sets the line pattern element body for this LinePatternParallelKit.
- Param in_element
The line pattern element body for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit SetBody (HPS.LinePatternElement[] in_elements)
Sets the line pattern element array for this LinePatternParallelKit.
- Param in_elements
The line pattern element array for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit SetContinuous (bool in_state)
Sets whether to reset the line pattern in each segment for this LinePatternParallelKit.
- Param in_state
Whether to reset the line pattern in each segment for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit SetEndCap (HPS.GlyphLinePatternElement in_end)
Sets the glyph to draw at the end point for this LinePatternParallelKit.
- Param in_end
The glyph to draw at the end point for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit SetJoin (HPS.GlyphLinePatternElement in_join)
Sets the glyph to draw at all joins for this LinePatternParallelKit.
- Param in_join
The glyph to draw at all joins for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit SetJustification (HPS.LinePattern.Justification in_type)
Sets how the pattern will fit between the end points for this LinePatternParallelKit.
- Param in_type
How the pattern will fit between the end points for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- 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.
- Param in_offset
The offset above (positive) or below (negative) the line connecting two points defining a segment for this LinePatternParallelKit.
- Param in_units
The units for the offset for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- 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.
- Param in_offset
The offset above (positive) or below (negative) the line connecting two points defining a segment for this LinePatternParallelKit.
- Param in_units
The units for the offset for this LinePatternParallelKit.
- Param 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.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit SetStartCap (HPS.GlyphLinePatternElement in_start)
Sets the glyph to draw at the start point for this LinePatternParallelKit.
- Param in_start
The glyph to draw at the start point for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit SetWeight (float in_weight, HPS.LinePattern.SizeUnits in_units)
Sets the line weight for this LinePatternParallelKit.
- Param in_weight
The line weight for this LinePatternParallelKit.
- Param in_units
The units for the weight for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit SetWeight (float in_weight, HPS.LinePattern.SizeUnits in_units, bool in_fixed)
Sets the line weight for this LinePatternParallelKit.
- Param in_weight
The line weight for this LinePatternParallelKit.
- Param in_units
The units for the weight for this LinePatternParallelKit.
- Param in_fixed
Whether to override the effective line weight in the segment where this pattern is used. Defaults to false.
- Return
A reference to this LinePatternParallelKit.
- void Show (out HPS.LinePatternParallelKit out_kit)
Copies this LinePatternParallelKit into the given LinePatternParallelKit.
- Param out_kit
The LinePatternParallelKit to populate with the contents of this LinePatternParallelKit.
- bool ShowAbsoluteLength (out bool out_state)
Shows whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
- Param out_state
Whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
- Return
true if an absolute length was set, false otherwise.
- bool ShowAbsoluteWeight (out bool out_state)
Shows whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
- Param out_state
Whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
- Return
true if an absolute weight was set, false otherwise.
- bool ShowBody (out HPS.LinePatternElement[] out_elements)
Shows the line pattern element body for this LinePatternParallelKit.
- Param out_elements
The line pattern element body for this LinePatternParallelKit.
- Return
true if a body was set, false otherwise.
- bool ShowContinuous (out bool out_state)
Shows whether to reset the line pattern in each segment for this LinePatternParallelKit.
- Param out_state
Whether to reset the line pattern in each segment for this LinePatternParallelKit.
- Return
true if a continuous flag was set, false otherwise.
- bool ShowEndCap (out HPS.GlyphLinePatternElement out_end)
Shows the glyph to draw at the end point for this LinePatternParallelKit.
- Param out_end
The glyph to draw at the end point for this LinePatternParallelKit.
- Return
true if an end cap was set, false otherwise.
- bool ShowJoin (out HPS.GlyphLinePatternElement out_join)
Shows the glyph to draw at all joins for this LinePatternParallelKit.
- Param out_join
The glyph to draw at all joins for this LinePatternParallelKit.
- Return
true if a join was set, false otherwise.
- bool ShowJustification (out HPS.LinePattern.Justification out_type)
Shows how the pattern will fit between the end points for this LinePatternParallelKit.
- Param out_type
How the pattern will fit between the end points for this LinePatternParallelKit.
- Return
true if a justficiation was set, false otherwise.
- 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.
- Param out_offset
The offset above (positive) or below (negative) the line connecting two points defining a segment for this LinePatternParallelKit.
- Param out_units
The units for the offset for this LinePatternParallelKit.
- Param out_fixed
Whether to prevent scaling the offset based on the effective line weight in the segment where this pattern is used.
- Return
true if an offset is set, false otherwise.
- bool ShowStartCap (out HPS.GlyphLinePatternElement out_start)
Shows the glyph to draw at the start point for this LinePatternParallelKit.
- Param out_start
The glyph to draw at the start point for this LinePatternParallelKit.
- Return
true if a start cap was set, false otherwise.
- bool ShowWeight (out float out_weight, out HPS.LinePattern.SizeUnits out_units, out bool out_fixed)
Shows the line weight for this LinePatternParallelKit.
- Param out_weight
The line weight for this LinePatternParallelKit.
- Param out_units
The units for the weight for this LinePatternParallelKit.
- Param out_fixed
Whether to override the effective line weight in the segment where this pattern is used.
- Return
true if a weight was set, false otherwise.
- HPS.LinePatternParallelKit UnsetAbsoluteLength ()
Removes whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit UnsetAbsoluteWeight ()
Removes whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit UnsetBody ()
Removes the line pattern element body for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit UnsetContinuous ()
Removes whether to reset the line pattern in each segment for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit UnsetEndCap ()
Removes the glyph to draw at the end point for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit UnsetEverything ()
Removes all settings from this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit UnsetJoin ()
Removes the glyph to draw at all joins for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit UnsetJustification ()
Removes how the pattern will fit between the end points for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit UnsetOffset ()
Removes the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit UnsetStartCap ()
Removes the glyph to draw at the start point for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
- HPS.LinePatternParallelKit UnsetWeight ()
Removes the line weight for this LinePatternParallelKit.
- Return
A reference to this LinePatternParallelKit.
Public Static Functions
- bool operator!= (HPS.LinePatternParallelKit a, HPS.LinePatternParallelKit b)
- bool operator== (HPS.LinePatternParallelKit a, HPS.LinePatternParallelKit b)