REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
bool | Equals (LinePatternElement const &in_that) const |
LinePatternElement () | |
LinePatternElement (LinePatternElement const &in_that) | |
LinePatternElement (LinePatternElement &&in_that) | |
Type | ObjectType () const |
bool | operator!= (LinePatternElement const &in_that) const |
LinePatternElement & | operator= (LinePatternElement &&in_that) |
LinePatternElement & | operator= (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 |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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.
LinePatternElement::LinePatternElement | ( | ) |
The default constructor creates an empty LinePatternElement object.
LinePatternElement::LinePatternElement | ( | LinePatternElement const & | in_that | ) |
The copy constructor creates a new LinePatternElement object that contains the same settings as the source LinePatternElement.
in_that | The source LinePatternElement to copy. |
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.
in_that | An rvalue reference to a LinePatternElement to take the impl from. |
bool LinePatternElement::Equals | ( | LinePatternElement const & | in_that | ) | const |
Check if the source LinePatternElement is equivalent to this LinePatternElement.
in_that | The source LinePatternElement to compare to this LinePatternElement. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
Reimplemented in GlyphLinePatternElement, BlankLinePatternElement, and SolidLinePatternElement.
bool LinePatternElement::operator!= | ( | LinePatternElement const & | in_that | ) | const |
Check if the source LinePatternElement is not equivalent to this LinePatternElement.
in_that | The source LinePatternElement to compare to this LinePatternElement. |
LinePatternElement& LinePatternElement::operator= | ( | LinePatternElement && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this LinePatternElement thereby avoiding a copy.
in_that | An rvalue reference to an LinePatternElement to take the impl from. |
LinePatternElement& LinePatternElement::operator= | ( | LinePatternElement const & | in_that | ) |
Copies the source LinePatternElement into this LinePatternElement.
in_that | The source LinePatternElement to copy. |
bool LinePatternElement::operator== | ( | LinePatternElement const & | in_that | ) | const |
Check if the source LinePatternElement is equivalent to this LinePatternElement.
in_that | The source LinePatternElement to compare to this LinePatternElement. |
void LinePatternElement::Set | ( | LinePatternElement const & | in_that | ) |
Copies the source LinePatternElement into this LinePatternElement.
in_that | The source LinePatternElement to copy. |
void LinePatternElement::SetSize | ( | float | in_size, |
LinePattern::SizeUnits | in_units | ||
) |
Sets the size of this LinePatternElement.
in_size | The size of this LinePatternElement. |
in_units | The units for the size of this LinePatternElement. |
bool LinePatternElement::ShowSize | ( | float & | out_size, |
LinePattern::SizeUnits & | out_units | ||
) | const |
Shows the size of this LinePatternElement.
out_size | The size of this LinePatternElement. |
out_units | The units for the size of this LinePatternElement. |