HPS::LinePatternElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::LinePatternElement:
HPS::Object HPS::BlankLinePatternElement HPS::GlyphLinePatternElement HPS::SolidLinePatternElement

Public Member Functions

bool Equals (LinePatternElement const &in_that) const
 
 LinePatternElement ()
 
 LinePatternElement (LinePatternElement const &in_that)
 
 LinePatternElement (LinePatternElement &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (LinePatternElement const &in_that) const
 
LinePatternElementoperator= (LinePatternElement &&in_that)
 
LinePatternElementoperator= (LinePatternElement const &in_that)
 
bool operator== (LinePatternElement const &in_that) const
 
void Set (LinePatternElement const &in_that)
 
void SetSize (float in_size, LinePattern::SizeUnits in_units)
 
bool ShowSize (float &out_size, LinePattern::SizeUnits &out_units) const
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
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 ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::LinePatternElement
 
- 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 ()
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ LinePatternElement() [1/3]

HPS::LinePatternElement::LinePatternElement ( )

The default constructor creates an empty LinePatternElement object.

◆ LinePatternElement() [2/3]

HPS::LinePatternElement::LinePatternElement ( LinePatternElement const &  in_that)

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

Parameters
in_thatThe source LinePatternElement to copy.

◆ LinePatternElement() [3/3]

HPS::LinePatternElement::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_thatAn rvalue reference to a LinePatternElement to take the impl from.

Member Function Documentation

◆ Equals()

bool HPS::LinePatternElement::Equals ( LinePatternElement const &  in_that) const

Check if the source LinePatternElement is equivalent to this LinePatternElement.

Parameters
in_thatThe source LinePatternElement to compare to this LinePatternElement.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

HPS::Type HPS::LinePatternElement::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::Object.

Reimplemented in HPS::GlyphLinePatternElement, HPS::BlankLinePatternElement, and HPS::SolidLinePatternElement.

◆ operator!=()

bool HPS::LinePatternElement::operator!= ( LinePatternElement const &  in_that) const

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

Parameters
in_thatThe source LinePatternElement to compare to this LinePatternElement.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

LinePatternElement& HPS::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_thatAn rvalue reference to an LinePatternElement to take the impl from.
Returns
A reference to this LinePatternElement.

◆ operator=() [2/2]

LinePatternElement& HPS::LinePatternElement::operator= ( LinePatternElement const &  in_that)

Copies the source LinePatternElement into this LinePatternElement.

Parameters
in_thatThe source LinePatternElement to copy.
Returns
A reference to this LinePatternElement.

◆ operator==()

bool HPS::LinePatternElement::operator== ( LinePatternElement const &  in_that) const

Check if the source LinePatternElement is equivalent to this LinePatternElement.

Parameters
in_thatThe source LinePatternElement to compare to this LinePatternElement.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::LinePatternElement::Set ( LinePatternElement const &  in_that)

Copies the source LinePatternElement into this LinePatternElement.

Parameters
in_thatThe source LinePatternElement to copy.

◆ SetSize()

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

Sets the size of this LinePatternElement.

Parameters
in_sizeThe size of this LinePatternElement.
in_unitsThe units for the size of this LinePatternElement.

◆ ShowSize()

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

Shows the size of this LinePatternElement.

Parameters
out_sizeThe size of this LinePatternElement.
out_unitsThe units for the size of this LinePatternElement.
Returns
true if a size was set, false otherwise.

The documentation for this class was generated from the following file: