HPS::GlyphLinePatternElement Class Reference

#include <hps.h>

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

Public Member Functions

 GlyphLinePatternElement ()
 
 GlyphLinePatternElement (LinePatternElement const &in_that)
 
 GlyphLinePatternElement (GlyphLinePatternElement const &in_that)
 
 GlyphLinePatternElement (GlyphLinePatternElement &&in_that)
 
HPS::Type ObjectType () const
 
GlyphLinePatternElementoperator= (GlyphLinePatternElement const &in_that)
 
GlyphLinePatternElementoperator= (GlyphLinePatternElement &&in_that)
 
void SetFixed (bool in_state)
 
void SetInsetBehavior (LinePattern::InsetBehavior in_behavior)
 
void SetMirror (bool in_state)
 
void SetRotation (float in_degrees)
 
void SetSource (char const *in_source)
 
void SetWeight (float in_weight, LinePattern::SizeUnits in_units)
 
bool ShowFixed (bool &out_state) const
 
bool ShowInsetBehavior (LinePattern::InsetBehavior &out_behavior) const
 
bool ShowMirror (bool &out_state) const
 
bool ShowRotation (float &out_degrees) const
 
bool ShowSource (UTF8 &out_source) const
 
bool ShowWeight (float &out_weight, LinePattern::SizeUnits &out_units) const
 
- Public Member Functions inherited from HPS::LinePatternElement
bool Equals (LinePatternElement const &in_that) const
 
 LinePatternElement ()
 
 LinePatternElement (LinePatternElement const &in_that)
 
 LinePatternElement (LinePatternElement &&in_that)
 
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::GlyphLinePatternElement
 
- Static Public Attributes inherited from HPS::LinePatternElement
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 GlyphLinePatternElement class is a user space object. It is used for specifying glyphs elements within a line pattern.

Constructor & Destructor Documentation

◆ GlyphLinePatternElement() [1/4]

HPS::GlyphLinePatternElement::GlyphLinePatternElement ( )

The default constructor creates an empty GlyphLinePatternElement object.

◆ GlyphLinePatternElement() [2/4]

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

This constructor creates a GlyphLinePatternElement object that contains the same settings as the source LinePatternElement. The copy will only be successful if the source line pattern element is really an upcast of a glyph line pattern element. Otherwise the copy will fail and the resulting GlyphLinePatternElement will be invalid.

Parameters
in_thatThe source LinePatternElement to copy.

◆ GlyphLinePatternElement() [3/4]

HPS::GlyphLinePatternElement::GlyphLinePatternElement ( GlyphLinePatternElement const &  in_that)

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

Parameters
in_thatThe source GlyphLinePatternElement to copy.

◆ GlyphLinePatternElement() [4/4]

HPS::GlyphLinePatternElement::GlyphLinePatternElement ( GlyphLinePatternElement &&  in_that)

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

Parameters
in_thatAn rvalue reference to a GlyphLinePatternElement to take the impl from.

Member Function Documentation

◆ ObjectType()

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

◆ operator=() [1/2]

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

Copies the source GlyphLinePatternElement into this GlyphLinePatternElement.

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

◆ operator=() [2/2]

GlyphLinePatternElement& HPS::GlyphLinePatternElement::operator= ( GlyphLinePatternElement &&  in_that)

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

Parameters
in_thatAn rvalue reference to a GlyphLinePatternElement to take the impl from.
Returns
A reference to this GlyphLinePatternElement.

◆ SetFixed()

void HPS::GlyphLinePatternElement::SetFixed ( bool  in_state)

Sets whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.

Parameters
in_stateWhether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.

◆ SetInsetBehavior()

void HPS::GlyphLinePatternElement::SetInsetBehavior ( LinePattern::InsetBehavior  in_behavior)

Sets the inset behavior for this GlyphLinePatternElement.

Parameters
in_behaviorThe inset behavior for this GlyphLinePatternElement.

◆ SetMirror()

void HPS::GlyphLinePatternElement::SetMirror ( bool  in_state)

Sets whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.

Parameters
in_stateWhether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.

◆ SetRotation()

void HPS::GlyphLinePatternElement::SetRotation ( float  in_degrees)

Sets the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.

Parameters
in_degreesThe angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.

◆ SetSource()

void HPS::GlyphLinePatternElement::SetSource ( char const *  in_source)

Sets the name of the source for this GlyphLinePatternElement.

Parameters
in_sourceUTF8-encoded name of the source for this GlyphLinePatternElement.

◆ SetWeight()

void HPS::GlyphLinePatternElement::SetWeight ( float  in_weight,
LinePattern::SizeUnits  in_units 
)

Sets the weight for this GlyphLinePatternElement.

Parameters
in_weightThe weight for this GlyphLinePatternElement.
in_unitsThe units of the weight for this GlyphLinePatternElement.

◆ ShowFixed()

bool HPS::GlyphLinePatternElement::ShowFixed ( bool &  out_state) const

Shows whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.

Parameters
out_stateWhether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.
Returns
true if a fixed flag was set, false otherwise.

◆ ShowInsetBehavior()

bool HPS::GlyphLinePatternElement::ShowInsetBehavior ( LinePattern::InsetBehavior out_behavior) const

Shows the inset behavior for this GlyphLinePatternElement.

Parameters
out_behaviorThe inset behavior for this GlyphLinePatternElement.
Returns
true if an inset behavior was set, false otherwise.

◆ ShowMirror()

bool HPS::GlyphLinePatternElement::ShowMirror ( bool &  out_state) const

Shows whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.

Parameters
out_stateWhether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.
Returns
true if a mirror flag was set, false otherwise.

◆ ShowRotation()

bool HPS::GlyphLinePatternElement::ShowRotation ( float &  out_degrees) const

Shows the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.

Parameters
out_degreesThe angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.
Returns
true if an angle was set, false otherwise.

◆ ShowSource()

bool HPS::GlyphLinePatternElement::ShowSource ( UTF8 out_source) const

Shows the name of the source for this GlyphLinePatternElement.

Parameters
out_sourceUTF8-encoded name of the source for this GlyphLinePatternElement.
Returns
true if a source was set, false otherwise.

◆ ShowWeight()

bool HPS::GlyphLinePatternElement::ShowWeight ( float &  out_weight,
LinePattern::SizeUnits out_units 
) const

Shows the weight for this GlyphLinePatternElement.

Parameters
out_weightThe weight for this GlyphLinePatternElement.
out_unitsThe units for the weight for this GlyphLinePatternElement.
Returns
true if a weight was set, false otherwise.

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