LinePatternElement

class HPS::LinePatternElement : public HPS::Object

The LinePatternElement class is a user space object. It is the base class for other line pattern element types. Line pattern elements are used to define a pattern that can be assigned lines or edges.

Subclassed by HPS::BlankLinePatternElement, HPS::GlyphLinePatternElement, HPS::SolidLinePatternElement

Public Functions

bool Equals(LinePatternElement const &in_that) const

Check if the source LinePatternElement is equivalent to this LinePatternElement.

Parameters

in_that – The source LinePatternElement to compare to this LinePatternElement.

Returns

true if the objects are equivalent, false otherwise.

LinePatternElement()

The default constructor creates an empty LinePatternElement object.

LinePatternElement(LinePatternElement &&in_that)

The move constructor creates a LinePatternElement by transferring the underlying impl of the rvalue reference to this LinePatternElement thereby avoiding a copy and allocation.

Parameters

in_that – An rvalue reference to a LinePatternElement to take the impl from.

LinePatternElement(LinePatternElement const &in_that)

The copy constructor creates a new LinePatternElement object that contains the same settings as the source LinePatternElement.

Parameters

in_that – The source LinePatternElement 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!=(LinePatternElement const &in_that) const

Check if the source LinePatternElement is not equivalent to this LinePatternElement.

Parameters

in_that – The source LinePatternElement to compare to this LinePatternElement.

Returns

true if the objects are not equivalent, false otherwise.

LinePatternElement &operator=(LinePatternElement &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this LinePatternElement thereby avoiding a copy.

Parameters

in_that – An rvalue reference to an LinePatternElement to take the impl from.

Returns

A reference to this LinePatternElement.

LinePatternElement &operator=(LinePatternElement const &in_that)

Copies the source LinePatternElement into this LinePatternElement.

Parameters

in_that – The source LinePatternElement to copy.

Returns

A reference to this LinePatternElement.

bool operator==(LinePatternElement const &in_that) const

Check if the source LinePatternElement is equivalent to this LinePatternElement.

Parameters

in_that – The source LinePatternElement to compare to this LinePatternElement.

Returns

true if the objects are equivalent, false otherwise.

void Set(LinePatternElement const &in_that)

Copies the source LinePatternElement into this LinePatternElement.

Parameters

in_that – The source LinePatternElement to copy.

void SetSize(float in_size, LinePattern::SizeUnits in_units)

Sets the size of this LinePatternElement.

Parameters

• in_size – The size of this LinePatternElement.

• in_units – The units for the size of this LinePatternElement.

bool ShowSize(float &out_size, LinePattern::SizeUnits &out_units) const

Shows the size of this LinePatternElement.

Parameters

• out_size – The size of this LinePatternElement.

• out_units – The units for the size of this LinePatternElement.

Returns

true if a size was set, false otherwise.

~LinePatternElement()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::LinePatternElement