LinePatternOptionsKit

class HPS::LinePatternOptionsKit : public HPS::Kit 

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.

Public Functions

virtual bool Empty() const

Indicates whether this LinePatternOptionsKit has any values set on it.

Returns: true if no values are set on this LinePatternOptionsKit, false otherwise.

bool 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.

LinePatternOptionsKit(): The default constructor creates an empty LinePatternOptionsKit object.

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.

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.

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!=(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.

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.

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.

bool 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.

void Set(LinePatternOptionsKit const &in_kit)

Copies the source LinePatternOptionsKit into this LinePatternOptionsKit.

Parameters: in_kit – The source LinePatternOptionsKit to copy.

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.

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.

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.

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.

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.

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.

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.

void 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.

bool 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.

bool 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.

bool 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.

bool 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.

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.

LinePatternOptionsKit &UnsetEverything()

Removes all settings from this LinePatternOptionsKit.

Returns: A reference to this LinePatternOptionsKit.

LinePatternOptionsKit &UnsetInnerCap()

Removes the inner cap for this LinePatternOptionsKit.

Returns: A reference to this LinePatternOptionsKit.

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.

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.

virtual ~LinePatternOptionsKit()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::LinePatternOptionsKit