The LinePatternParallelKit class is a user space object. More...
#include <hps.h>
Public Member Functions | |
LinePatternParallelKit () | |
The default constructor creates an empty LinePatternParallelKit object. More... | |
LinePatternParallelKit (LinePatternParallelKit const &in_kit) | |
The copy constructor creates a new LinePatternParallelKit object that contains the same settings as the source LinePatternParallelKit. More... | |
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. More... | |
LinePatternParallelKit & | operator= (LinePatternParallelKit &&in_that) |
The move assignment operator transfers the underlying impl of the rvalue reference to this LinePatternParallelKit thereby avoiding a copy. More... | |
virtual | ~LinePatternParallelKit () |
HPS::Type | ObjectType () const |
void | Set (LinePatternParallelKit const &in_kit) |
Copies the source LinePatternParallelKit into this LinePatternParallelKit. More... | |
void | Show (LinePatternParallelKit &out_kit) const |
Copies this LinePatternParallelKit into the given LinePatternParallelKit. More... | |
LinePatternParallelKit & | operator= (LinePatternParallelKit const &in_kit) |
Copies the source LinePatternParallelKit into this LinePatternParallelKit. More... | |
bool | Empty () const |
Indicates whether this LinePatternParallelKit has any values set on it. More... | |
bool | Equals (LinePatternParallelKit const &in_kit) const |
Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit. More... | |
bool | operator== (LinePatternParallelKit const &in_kit) const |
Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit. More... | |
bool | operator!= (LinePatternParallelKit const &in_kit) const |
Check if the source LinePatternParallelKit is not equivalent to this LinePatternParallelKit. More... | |
LinePatternParallelKit & | SetStartCap (GlyphLinePatternElement const &in_start) |
Sets the glyph to draw at the start point for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | SetEndCap (GlyphLinePatternElement const &in_end) |
Sets the glyph to draw at the end point for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | SetJoin (GlyphLinePatternElement const &in_join) |
Sets the glyph to draw at all joins for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | SetBody (LinePatternElementArray const &in_elements) |
Sets the line pattern element array for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | SetBody (size_t in_count, LinePatternElement const in_elements []) |
Sets the line pattern element body for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | SetBody (LinePatternElement const &in_element) |
Sets the line pattern element body for this LinePatternParallelKit. More... | |
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... | |
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... | |
LinePatternParallelKit & | SetJustification (LinePattern::Justification in_type) |
Sets how the pattern will fit between the end points for this LinePatternParallelKit. More... | |
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. More... | |
LinePatternParallelKit & | SetWeight (float in_weight, LinePattern::SizeUnits in_units, bool in_fixed=false) |
Sets the line weight for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | SetContinuous (bool in_state) |
Sets whether to reset the line pattern in each segment for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | UnsetStartCap () |
Removes the glyph to draw at the start point for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | UnsetEndCap () |
Removes the glyph to draw at the end point for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | UnsetJoin () |
Removes the glyph to draw at all joins for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | UnsetBody () |
Removes the line pattern element body for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | UnsetAbsoluteLength () |
Removes whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | UnsetAbsoluteWeight () |
Removes whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | UnsetJustification () |
Removes how the pattern will fit between the end points for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | UnsetOffset () |
Removes the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | UnsetWeight () |
Removes the line weight for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | UnsetContinuous () |
Removes whether to reset the line pattern in each segment for this LinePatternParallelKit. More... | |
LinePatternParallelKit & | UnsetEverything () |
Removes all settings from this LinePatternParallelKit. More... | |
bool | ShowStartCap (GlyphLinePatternElement &out_start) const |
Shows the glyph to draw at the start point for this LinePatternParallelKit. More... | |
bool | ShowEndCap (GlyphLinePatternElement &out_end) const |
Shows the glyph to draw at the end point for this LinePatternParallelKit. More... | |
bool | ShowJoin (GlyphLinePatternElement &out_join) const |
Shows the glyph to draw at all joins for this LinePatternParallelKit. More... | |
bool | ShowBody (LinePatternElementArray &out_elements) const |
Shows the line pattern element body for this LinePatternParallelKit. More... | |
bool | ShowAbsoluteLength (bool &out_state) const |
Shows whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit. More... | |
bool | ShowAbsoluteWeight (bool &out_state) const |
Shows whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit. More... | |
bool | ShowJustification (LinePattern::Justification &out_type) const |
Shows how the pattern will fit between the end points for this LinePatternParallelKit. More... | |
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. More... | |
bool | ShowWeight (float &out_weight, LinePattern::SizeUnits &out_units, bool &out_fixed) const |
Shows the line weight for this LinePatternParallelKit. More... | |
bool | ShowContinuous (bool &out_state) const |
Shows whether to reset the line pattern in each segment for this LinePatternParallelKit. More... | |
virtual HPS::Type | Type () const |
This function returns the true type of the underlying object. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS::Type in_mask) const |
This function indicates whether this Object has the given Type mask. More... | |
intptr_t | GetClassID () const |
Returns a unique identifier that is shared by all objects of the same class. More... | |
intptr_t | GetInstanceID () const |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
Static Public Member Functions | |
template<typename T > | |
static intptr_t | ClassID () |
Unique identifier for this class. More... | |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::LinePatternParallelKit |
The LinePatternParallelKit class is a user space object.
It is used to define a single parallel within a line pattern.
HPS::LinePatternParallelKit::LinePatternParallelKit | ( | ) |
The default constructor creates an empty LinePatternParallelKit object.
HPS::LinePatternParallelKit::LinePatternParallelKit | ( | LinePatternParallelKit const & | in_kit | ) |
The copy constructor creates a new LinePatternParallelKit object that contains the same settings as the source LinePatternParallelKit.
in_kit | The source LinePatternParallelKit to copy. |
HPS::LinePatternParallelKit::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.
in_that | An rvalue reference to a LinePatternParallelKit to take the impl from. |
|
virtual |
|
inlinestaticinherited |
Unique identifier for this class.
Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.
|
virtual |
Indicates whether this LinePatternParallelKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::LinePatternParallelKit::Equals | ( | LinePatternParallelKit const & | in_kit | ) | const |
Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit.
in_kit | The source LinePatternParallelKit to compare to this LinePatternParallelKit. |
|
inherited |
Returns a unique identifier that is shared by all objects of the same class.
|
inherited |
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.
|
inherited |
|
inlinevirtual |
bool HPS::LinePatternParallelKit::operator!= | ( | LinePatternParallelKit const & | in_kit | ) | const |
Check if the source LinePatternParallelKit is not equivalent to this LinePatternParallelKit.
in_kit | The source LinePatternParallelKit to compare to this LinePatternParallelKit. |
LinePatternParallelKit& HPS::LinePatternParallelKit::operator= | ( | LinePatternParallelKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this LinePatternParallelKit thereby avoiding a copy.
in_that | An rvalue reference to a LinePatternParallelKit to take the impl from. |
LinePatternParallelKit& HPS::LinePatternParallelKit::operator= | ( | LinePatternParallelKit const & | in_kit | ) |
Copies the source LinePatternParallelKit into this LinePatternParallelKit.
in_kit | The source LinePatternParallelKit to copy. |
bool HPS::LinePatternParallelKit::operator== | ( | LinePatternParallelKit const & | in_kit | ) | const |
Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit.
in_kit | The source LinePatternParallelKit to compare to this LinePatternParallelKit. |
|
virtualinherited |
Resets this object to its initial, uninitialized state.
Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.
void HPS::LinePatternParallelKit::Set | ( | LinePatternParallelKit const & | in_kit | ) |
Copies the source LinePatternParallelKit into this LinePatternParallelKit.
in_kit | The source LinePatternParallelKit to copy. |
LinePatternParallelKit& 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.
in_state | Whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit. |
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.
in_state | Whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit. |
LinePatternParallelKit& HPS::LinePatternParallelKit::SetBody | ( | LinePatternElementArray const & | in_elements | ) |
Sets the line pattern element array for this LinePatternParallelKit.
in_elements | The line pattern element array for this LinePatternParallelKit. |
LinePatternParallelKit& HPS::LinePatternParallelKit::SetBody | ( | size_t | in_count, |
LinePatternElement const | in_elements[] | ||
) |
Sets the line pattern element body for this LinePatternParallelKit.
in_count | Size of the following array. |
in_elements | The line pattern element body for this LinePatternParallelKit. |
LinePatternParallelKit& HPS::LinePatternParallelKit::SetBody | ( | LinePatternElement const & | in_element | ) |
Sets the line pattern element body for this LinePatternParallelKit.
in_element | The line pattern element body for this LinePatternParallelKit. |
LinePatternParallelKit& HPS::LinePatternParallelKit::SetContinuous | ( | bool | in_state | ) |
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. |
LinePatternParallelKit& HPS::LinePatternParallelKit::SetEndCap | ( | GlyphLinePatternElement const & | in_end | ) |
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. |
LinePatternParallelKit& HPS::LinePatternParallelKit::SetJoin | ( | GlyphLinePatternElement const & | in_join | ) |
Sets the glyph to draw at all joins for this LinePatternParallelKit.
in_join | The glyph to draw at all joins for this LinePatternParallelKit. |
LinePatternParallelKit& HPS::LinePatternParallelKit::SetJustification | ( | LinePattern::Justification | in_type | ) |
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. |
LinePatternParallelKit& HPS::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.
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. |
LinePatternParallelKit& HPS::LinePatternParallelKit::SetStartCap | ( | GlyphLinePatternElement const & | in_start | ) |
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. |
LinePatternParallelKit& HPS::LinePatternParallelKit::SetWeight | ( | float | in_weight, |
LinePattern::SizeUnits | in_units, | ||
bool | in_fixed = false |
||
) |
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. |
void HPS::LinePatternParallelKit::Show | ( | LinePatternParallelKit & | out_kit | ) | const |
Copies this LinePatternParallelKit into the given LinePatternParallelKit.
out_kit | The LinePatternParallelKit to populate with the contents of this LinePatternParallelKit. |
bool HPS::LinePatternParallelKit::ShowAbsoluteLength | ( | bool & | out_state | ) | const |
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. |
bool HPS::LinePatternParallelKit::ShowAbsoluteWeight | ( | bool & | out_state | ) | const |
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. |
bool HPS::LinePatternParallelKit::ShowBody | ( | LinePatternElementArray & | out_elements | ) | const |
Shows the line pattern element body for this LinePatternParallelKit.
out_elements | The line pattern element body for this LinePatternParallelKit. |
bool HPS::LinePatternParallelKit::ShowContinuous | ( | bool & | out_state | ) | const |
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. |
bool HPS::LinePatternParallelKit::ShowEndCap | ( | GlyphLinePatternElement & | out_end | ) | const |
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. |
bool HPS::LinePatternParallelKit::ShowJoin | ( | GlyphLinePatternElement & | out_join | ) | const |
Shows the glyph to draw at all joins for this LinePatternParallelKit.
out_join | The glyph to draw at all joins for this LinePatternParallelKit. |
bool HPS::LinePatternParallelKit::ShowJustification | ( | LinePattern::Justification & | out_type | ) | const |
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. |
bool HPS::LinePatternParallelKit::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.
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. |
bool HPS::LinePatternParallelKit::ShowStartCap | ( | GlyphLinePatternElement & | out_start | ) | const |
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. |
bool HPS::LinePatternParallelKit::ShowWeight | ( | float & | out_weight, |
LinePattern::SizeUnits & | out_units, | ||
bool & | out_fixed | ||
) | const |
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. |
|
inlinevirtualinherited |
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.
Reimplemented from HPS::Object.
LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetAbsoluteLength | ( | ) |
Removes whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetAbsoluteWeight | ( | ) |
Removes whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetBody | ( | ) |
Removes the line pattern element body for this LinePatternParallelKit.
LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetContinuous | ( | ) |
Removes whether to reset the line pattern in each segment for this LinePatternParallelKit.
LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetEndCap | ( | ) |
Removes the glyph to draw at the end point for this LinePatternParallelKit.
LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetEverything | ( | ) |
Removes all settings from this LinePatternParallelKit.
LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetJoin | ( | ) |
Removes the glyph to draw at all joins for this LinePatternParallelKit.
LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetJustification | ( | ) |
Removes how the pattern will fit between the end points for this LinePatternParallelKit.
LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetOffset | ( | ) |
Removes the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.
LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetStartCap | ( | ) |
Removes the glyph to draw at the start point for this LinePatternParallelKit.
LinePatternParallelKit& HPS::LinePatternParallelKit::UnsetWeight | ( | ) |
Removes the line weight for this LinePatternParallelKit.
|
static |