HPS::LinePatternOptionsKit Class Reference

#include <hps.h>

Inheritance diagram for HPS::LinePatternOptionsKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (LinePatternOptionsKit const &in_kit) const
 
 LinePatternOptionsKit ()
 
 LinePatternOptionsKit (LinePatternOptionsKit const &in_kit)
 
 LinePatternOptionsKit (LinePatternOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (LinePatternOptionsKit const &in_kit) const
 
LinePatternOptionsKitoperator= (LinePatternOptionsKit &&in_that)
 
LinePatternOptionsKitoperator= (LinePatternOptionsKit const &in_kit)
 
bool operator== (LinePatternOptionsKit const &in_kit) const
 
void Set (LinePatternOptionsKit const &in_kit)
 
LinePatternOptionsKitSetEndCap (char const *in_glyph)
 
LinePatternOptionsKitSetEndCap (LinePattern::Cap in_type)
 
LinePatternOptionsKitSetInnerCap (LinePattern::Cap in_type)
 
LinePatternOptionsKitSetJoin (char const *in_glyph)
 
LinePatternOptionsKitSetJoin (LinePattern::Join in_type)
 
LinePatternOptionsKitSetStartCap (char const *in_glyph)
 
LinePatternOptionsKitSetStartCap (LinePattern::Cap in_type)
 
void Show (LinePatternOptionsKit &out_kit) const
 
bool ShowEndCap (LinePattern::Modifier &out_modifier, UTF8 &out_glyph, LinePattern::Cap &out_type) const
 
bool ShowInnerCap (LinePattern::Cap &out_type) const
 
bool ShowJoin (LinePattern::Modifier &out_modifier, UTF8 &out_glyph, LinePattern::Join &out_type) const
 
bool ShowStartCap (LinePattern::Modifier &out_modifier, UTF8 &out_glyph, LinePattern::Cap &out_type) const
 
LinePatternOptionsKitUnsetEndCap ()
 
LinePatternOptionsKitUnsetEverything ()
 
LinePatternOptionsKitUnsetInnerCap ()
 
LinePatternOptionsKitUnsetJoin ()
 
LinePatternOptionsKitUnsetStartCap ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::LinePatternOptionsKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (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_kitThe 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_thatAn rvalue reference to a LinePatternOptionsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::LinePatternOptionsKit::Empty ( ) const
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_kitThe source LinePatternOptionsKit to compare to this LinePatternOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

HPS::Type HPS::LinePatternOptionsKit::ObjectType ( ) const
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_kitThe 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_thatAn 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_kitThe 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_kitThe 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_kitThe 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_glyphUTF8-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_typeThe 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_typeThe 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_glyphUTF8-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_typeThe 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_glyphUTF8-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_typeThe 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_kitThe 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_modifierIndicates which of the following arguments is valid.
out_glyphUTF8-encoded name of the glyph to use as the end cap. This is only valid if out_modifier is LinePattern::Modifier::GlyphName.
out_typeThe 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_typeThe 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_modifierIndicates which of the following arguments is valid.
out_glyphUTF8-encoded name of the glyph to use as the join. This is only valid if out_modifier is LinePattern::Modifier::GlyphName.
out_typeThe 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_modifierIndicates which of the following arguments is valid.
out_glyphUTF8-encoded name of the glyph to use as the start cap. This is only valid if out_modifier is LinePattern::Modifier::GlyphName.
out_typeThe 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: