LinePatternParallelKit
-
class
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
-
virtual bool
Empty() const Indicates whether this LinePatternParallelKit has any values set on it.
Returns: true if no values are set on this LinePatternParallelKit, false otherwise.
-
bool
Equals(LinePatternParallelKit const &in_kit) const Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit.
Parameters: in_kit – The source LinePatternParallelKit to compare to this LinePatternParallelKit. Returns: true if the objects are equivalent, false otherwise.
-
LinePatternParallelKit() The default constructor creates an empty LinePatternParallelKit object.
-
LinePatternParallelKit(LinePatternParallelKit &&in_that) The move constructor creates a LinePatternParallelKit by transferring the underlying impl of the rvalue reference to this LinePatternParallelKit thereby avoiding a copy and allocation.
Parameters: in_that – An rvalue reference to a LinePatternParallelKit to take the impl from.
-
LinePatternParallelKit(LinePatternParallelKit const &in_kit) The copy constructor creates a new LinePatternParallelKit object that contains the same settings as the source LinePatternParallelKit.
Parameters: in_kit – The source LinePatternParallelKit to copy.
-
inline virtual HPS::Type
ObjectType() const 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).
Returns: The declared type of the object in question, which may differ from the true, underlying type.
-
bool
operator!=(LinePatternParallelKit const &in_kit) const Check if the source LinePatternParallelKit is not equivalent to this LinePatternParallelKit.
Parameters: in_kit – The source LinePatternParallelKit to compare to this LinePatternParallelKit. Returns: true if the objects are not equivalent, false otherwise.
-
LinePatternParallelKit &
operator=(LinePatternParallelKit &&in_that) The move assignment operator transfers the underlying impl of the rvalue reference to this LinePatternParallelKit thereby avoiding a copy.
Parameters: in_that – An rvalue reference to a LinePatternParallelKit to take the impl from. Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
operator=(LinePatternParallelKit const &in_kit) Copies the source LinePatternParallelKit into this LinePatternParallelKit.
Parameters: in_kit – The source LinePatternParallelKit to copy. Returns: A reference to this LinePatternParallelKit.
-
bool
operator==(LinePatternParallelKit const &in_kit) const Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit.
Parameters: in_kit – The source LinePatternParallelKit to compare to this LinePatternParallelKit. Returns: true if the objects are equivalent, false otherwise.
-
void
Set(LinePatternParallelKit const &in_kit) Copies the source LinePatternParallelKit into this LinePatternParallelKit.
Parameters: in_kit – The source LinePatternParallelKit to copy.
-
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.
Parameters: in_state – Whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit. Returns: A reference to this LinePatternParallelKit.
-
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.
Parameters: in_state – Whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit. Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
SetBody(LinePatternElement const &in_element) Sets the line pattern element body for this LinePatternParallelKit.
Parameters: in_element – The line pattern element body for this LinePatternParallelKit. Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
SetBody(LinePatternElementArray const &in_elements) Sets the line pattern element array for this LinePatternParallelKit.
Parameters: in_elements – The line pattern element array for this LinePatternParallelKit. Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
SetBody(size_t in_count, LinePatternElement const in_elements[]) Sets the line pattern element body for this LinePatternParallelKit.
Parameters: - in_count – Size of the following array.
- in_elements – The line pattern element body for this LinePatternParallelKit.
Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
SetContinuous(bool in_state) Sets whether to reset the line pattern in each segment for this LinePatternParallelKit.
Parameters: in_state – Whether to reset the line pattern in each segment for this LinePatternParallelKit. Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
SetEndCap(GlyphLinePatternElement const &in_end) Sets the glyph to draw at the end point for this LinePatternParallelKit.
Parameters: in_end – The glyph to draw at the end point for this LinePatternParallelKit. Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
SetJoin(GlyphLinePatternElement const &in_join) Sets the glyph to draw at all joins for this LinePatternParallelKit.
Parameters: in_join – The glyph to draw at all joins for this LinePatternParallelKit. Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
SetJustification(LinePattern::Justification in_type) Sets how the pattern will fit between the end points for this LinePatternParallelKit.
Parameters: in_type – How the pattern will fit between the end points for this LinePatternParallelKit. Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
SetOffset(float in_offset, LinePattern::SizeUnits in_units, bool in_fixed = false) Sets the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.
Parameters: - 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.
Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
SetStartCap(GlyphLinePatternElement const &in_start) Sets the glyph to draw at the start point for this LinePatternParallelKit.
Parameters: in_start – The glyph to draw at the start point for this LinePatternParallelKit. Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
SetWeight(float in_weight, LinePattern::SizeUnits in_units, bool in_fixed = false) Sets the line weight for this LinePatternParallelKit.
Parameters: - 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.
Returns: A reference to this LinePatternParallelKit.
-
void
Show(LinePatternParallelKit &out_kit) const Copies this LinePatternParallelKit into the given LinePatternParallelKit.
Parameters: out_kit – The LinePatternParallelKit to populate with the contents of this LinePatternParallelKit.
-
bool
ShowAbsoluteLength(bool &out_state) const Shows whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
Parameters: out_state – Whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit. Returns: true if an absolute length was set, false otherwise.
-
bool
ShowAbsoluteWeight(bool &out_state) const Shows whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
Parameters: out_state – Whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit. Returns: true if an absolute weight was set, false otherwise.
-
bool
ShowBody(LinePatternElementArray &out_elements) const Shows the line pattern element body for this LinePatternParallelKit.
Parameters: out_elements – The line pattern element body for this LinePatternParallelKit. Returns: true if a body was set, false otherwise.
-
bool
ShowContinuous(bool &out_state) const Shows whether to reset the line pattern in each segment for this LinePatternParallelKit.
Parameters: out_state – Whether to reset the line pattern in each segment for this LinePatternParallelKit. Returns: true if a continuous flag was set, false otherwise.
-
bool
ShowEndCap(GlyphLinePatternElement &out_end) const Shows the glyph to draw at the end point for this LinePatternParallelKit.
Parameters: out_end – The glyph to draw at the end point for this LinePatternParallelKit. Returns: true if an end cap was set, false otherwise.
-
bool
ShowJoin(GlyphLinePatternElement &out_join) const Shows the glyph to draw at all joins for this LinePatternParallelKit.
Parameters: out_join – The glyph to draw at all joins for this LinePatternParallelKit. Returns: true if a join was set, false otherwise.
-
bool
ShowJustification(LinePattern::Justification &out_type) const Shows how the pattern will fit between the end points for this LinePatternParallelKit.
Parameters: out_type – How the pattern will fit between the end points for this LinePatternParallelKit. Returns: true if a justficiation was set, false otherwise.
-
bool
ShowOffset(float &out_offset, LinePattern::SizeUnits &out_units, bool &out_fixed) const Shows the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.
Parameters: - 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.
Returns: true if an offset is set, false otherwise.
-
bool
ShowStartCap(GlyphLinePatternElement &out_start) const Shows the glyph to draw at the start point for this LinePatternParallelKit.
Parameters: out_start – The glyph to draw at the start point for this LinePatternParallelKit. Returns: true if a start cap was set, false otherwise.
-
bool
ShowWeight(float &out_weight, LinePattern::SizeUnits &out_units, bool &out_fixed) const Shows the line weight for this LinePatternParallelKit.
Parameters: - 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.
Returns: true if a weight was set, false otherwise.
-
LinePatternParallelKit &
UnsetAbsoluteLength() Removes whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
UnsetAbsoluteWeight() Removes whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
UnsetBody() Removes the line pattern element body for this LinePatternParallelKit.
Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
UnsetContinuous() Removes whether to reset the line pattern in each segment for this LinePatternParallelKit.
Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
UnsetEndCap() Removes the glyph to draw at the end point for this LinePatternParallelKit.
Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
UnsetEverything() Removes all settings from this LinePatternParallelKit.
Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
UnsetJoin() Removes the glyph to draw at all joins for this LinePatternParallelKit.
Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
UnsetJustification() Removes how the pattern will fit between the end points for this LinePatternParallelKit.
Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
UnsetOffset() Removes the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.
Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
UnsetStartCap() Removes the glyph to draw at the start point for this LinePatternParallelKit.
Returns: A reference to this LinePatternParallelKit.
-
LinePatternParallelKit &
UnsetWeight() Removes the line weight for this LinePatternParallelKit.
Returns: A reference to this LinePatternParallelKit.
-
virtual
~LinePatternParallelKit()
-
virtual bool