#include <hps.h>

Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::LinePatternOptionsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The LinePatternOptionsKit class is a user space object. It is used for specifying (or overriding) some line pattern options when setting a line pattern on a segment.
Constructor & Destructor Documentation
◆ LinePatternOptionsKit() [1/3]
HPS::LinePatternOptionsKit::LinePatternOptionsKit | ( | ) |
The default constructor creates an empty LinePatternOptionsKit object.
◆ LinePatternOptionsKit() [2/3]
HPS::LinePatternOptionsKit::LinePatternOptionsKit | ( | LinePatternOptionsKit const & | in_kit | ) |
The copy constructor creates a new LinePatternOptionsKit object that contains the same settings as the source LinePatternOptionsKit.
- Parameters
-
in_kit The source LinePatternOptionsKit to copy.
◆ LinePatternOptionsKit() [3/3]
HPS::LinePatternOptionsKit::LinePatternOptionsKit | ( | LinePatternOptionsKit && | in_that | ) |
The move constructor creates a LinePatternOptionsKit by transferring the underlying impl of the rvalue reference to this LinePatternOptionsKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a LinePatternOptionsKit to take the impl from.
Member Function Documentation
◆ Empty()
|
virtual |
Indicates whether this LinePatternOptionsKit has any values set on it.
- Returns
- true if no values are set on this LinePatternOptionsKit, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
bool HPS::LinePatternOptionsKit::Equals | ( | LinePatternOptionsKit const & | in_kit | ) | const |
Check if the source LinePatternOptionsKit is equivalent to this LinePatternOptionsKit.
- Parameters
-
in_kit The source LinePatternOptionsKit to compare to this LinePatternOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ ObjectType()
|
inlinevirtual |
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.
Reimplemented from HPS::Kit.
◆ operator!=()
bool HPS::LinePatternOptionsKit::operator!= | ( | LinePatternOptionsKit const & | in_kit | ) | const |
Check if the source LinePatternOptionsKit is not equivalent to this LinePatternOptionsKit.
- Parameters
-
in_kit The source LinePatternOptionsKit to compare to this LinePatternOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
LinePatternOptionsKit& HPS::LinePatternOptionsKit::operator= | ( | LinePatternOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this LinePatternOptionsKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a LinePatternOptionsKit to take the impl from.
- Returns
- A reference to this LinePatternOptionsKit.
◆ operator=() [2/2]
LinePatternOptionsKit& HPS::LinePatternOptionsKit::operator= | ( | LinePatternOptionsKit const & | in_kit | ) |
Copies the source LinePatternOptionsKit into this LinePatternOptionsKit.
- Parameters
-
in_kit The source LinePatternOptionsKit to copy.
- Returns
- A reference to this LinePatternOptionsKit.
◆ operator==()
bool HPS::LinePatternOptionsKit::operator== | ( | LinePatternOptionsKit const & | in_kit | ) | const |
Check if the source LinePatternOptionsKit is equivalent to this LinePatternOptionsKit.
- Parameters
-
in_kit The source LinePatternOptionsKit to compare to this LinePatternOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::LinePatternOptionsKit::Set | ( | LinePatternOptionsKit const & | in_kit | ) |
Copies the source LinePatternOptionsKit into this LinePatternOptionsKit.
- Parameters
-
in_kit The source LinePatternOptionsKit to copy.
◆ SetEndCap() [1/2]
LinePatternOptionsKit& HPS::LinePatternOptionsKit::SetEndCap | ( | char const * | in_glyph | ) |
Sets the glyph to use as the end cap for the associated line pattern.
- Parameters
-
in_glyph UTF8-encoded name of the glyph to use as the end cap for the associated line pattern.
- Returns
- A reference to this LinePatternOptionsKit.
◆ SetEndCap() [2/2]
LinePatternOptionsKit& HPS::LinePatternOptionsKit::SetEndCap | ( | LinePattern::Cap | in_type | ) |
Sets the cap to use as the end cap for the associated line pattern.
- Parameters
-
in_type The type of cap to use as the end cap for the associated line pattern.
- Returns
- A reference to this LinePatternOptionsKit.
◆ SetInnerCap()
LinePatternOptionsKit& HPS::LinePatternOptionsKit::SetInnerCap | ( | LinePattern::Cap | in_type | ) |
Sets the cap to use as the inner cap for the associated line pattern.
- Parameters
-
in_type The type of cap to use as the inner cap for the associated line pattern.
- Returns
- A reference to this LinePatternOptionsKit.
◆ SetJoin() [1/2]
LinePatternOptionsKit& HPS::LinePatternOptionsKit::SetJoin | ( | char const * | in_glyph | ) |
Sets the glyph to use as the join for the associated line pattern.
- Parameters
-
in_glyph UTF8-encoded name of the glyph to use as the join for the associated line pattern.
- Returns
- A reference to this LinePatternOptionsKit.
◆ SetJoin() [2/2]
LinePatternOptionsKit& HPS::LinePatternOptionsKit::SetJoin | ( | LinePattern::Join | in_type | ) |
Sets the join to use for the associated line pattern.
- Parameters
-
in_type The type of join to use for the associated line pattern.
- Returns
- A reference to this LinePatternOptionsKit.
◆ SetStartCap() [1/2]
LinePatternOptionsKit& HPS::LinePatternOptionsKit::SetStartCap | ( | char const * | in_glyph | ) |
Sets the glyph to use as the start cap for the associated line pattern.
- Parameters
-
in_glyph UTF8-encoded name of the glyph to use as the start cap for the associated line pattern.
- Returns
- A reference to this LinePatternOptionsKit.
◆ SetStartCap() [2/2]
LinePatternOptionsKit& HPS::LinePatternOptionsKit::SetStartCap | ( | LinePattern::Cap | in_type | ) |
Sets the cap to use as the start cap for the associated line pattern.
- Parameters
-
in_type The type of cap to use as the start cap for the associated line pattern.
- Returns
- A reference to this LinePatternOptionsKit.
◆ Show()
void HPS::LinePatternOptionsKit::Show | ( | LinePatternOptionsKit & | out_kit | ) | const |
Copies this LinePatternOptionsKit into the given LinePatternOptionsKit.
- Parameters
-
out_kit The LinePatternOptionsKit to populate with the contents of this LinePatternOptionsKit.
◆ ShowEndCap()
bool HPS::LinePatternOptionsKit::ShowEndCap | ( | LinePattern::Modifier & | out_modifier, |
UTF8 & | out_glyph, | ||
LinePattern::Cap & | out_type | ||
) | const |
Shows the end cap for this LinePatternOptionsKit.
- Parameters
-
out_modifier Indicates which of the following arguments is valid. out_glyph UTF8-encoded name of the glyph to use as the end cap. This is only valid if out_modifier is LinePattern::Modifier::GlyphName. out_type The predefined type of cap to use as the end cap. This is only valid if out_modifier is LinePattern::Modifier::Enumerated.
- Returns
- true if an end cap was set, false otherwise.
◆ ShowInnerCap()
bool HPS::LinePatternOptionsKit::ShowInnerCap | ( | LinePattern::Cap & | out_type | ) | const |
Shows the inner cap for this LinePatternOptionsKit.
- Parameters
-
out_type The predefined type of cap to use as the inner cap.
- Returns
- true if an inner cap was set, false otherwise.
◆ ShowJoin()
bool HPS::LinePatternOptionsKit::ShowJoin | ( | LinePattern::Modifier & | out_modifier, |
UTF8 & | out_glyph, | ||
LinePattern::Join & | out_type | ||
) | const |
Shows the join for this LinePatternOptionsKit.
- Parameters
-
out_modifier Indicates which of the following arguments is valid. out_glyph UTF8-encoded name of the glyph to use as the join. This is only valid if out_modifier is LinePattern::Modifier::GlyphName. out_type The predefined type of join to use. This is only valid if out_modifier is LinePattern::Modifier::Enumerated.
- Returns
- true if a join was set, false otherwise.
◆ ShowStartCap()
bool HPS::LinePatternOptionsKit::ShowStartCap | ( | LinePattern::Modifier & | out_modifier, |
UTF8 & | out_glyph, | ||
LinePattern::Cap & | out_type | ||
) | const |
Shows the start cap for this LinePatternOptionsKit.
- Parameters
-
out_modifier Indicates which of the following arguments is valid. out_glyph UTF8-encoded name of the glyph to use as the start cap. This is only valid if out_modifier is LinePattern::Modifier::GlyphName. out_type The predefined type of cap to use as the start cap. This is only valid if out_modifier is LinePattern::Modifier::Enumerated.
- Returns
- true if a start cap was set, false otherwise.
◆ UnsetEndCap()
LinePatternOptionsKit& HPS::LinePatternOptionsKit::UnsetEndCap | ( | ) |
Removes the end cap for this LinePatternOptionsKit. This will result in the end cap defined on the associated line pattern (if any) getting used when set with this LinePatternOptionsKit.
- Returns
- A reference to this LinePatternOptionsKit.
◆ UnsetEverything()
LinePatternOptionsKit& HPS::LinePatternOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this LinePatternOptionsKit.
- Returns
- A reference to this LinePatternOptionsKit.
◆ UnsetInnerCap()
LinePatternOptionsKit& HPS::LinePatternOptionsKit::UnsetInnerCap | ( | ) |
Removes the inner cap for this LinePatternOptionsKit.
- Returns
- A reference to this LinePatternOptionsKit.
◆ UnsetJoin()
LinePatternOptionsKit& HPS::LinePatternOptionsKit::UnsetJoin | ( | ) |
Removes the join for this LinePatternOptionsKit. This will result in the join defined on the associated line pattern (if any) getting used when set with this LinePatternOptionsKit.
- Returns
- A reference to this LinePatternOptionsKit.
◆ UnsetStartCap()
LinePatternOptionsKit& HPS::LinePatternOptionsKit::UnsetStartCap | ( | ) |
Removes the start cap for this LinePatternOptionsKit. This will result in the start cap defined on the associated line pattern (if any) getting used when set with this LinePatternOptionsKit.
- Returns
- A reference to this LinePatternOptionsKit.
The documentation for this class was generated from the following file:
- include/hps.h