#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::GlyphKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The GlyphKit class is a user space object. It is used when defining a glyph.
◆ GlyphKit() [1/3]
HPS::GlyphKit::GlyphKit |
( |
| ) |
|
The default constructor creates an empty GlyphKit object.
◆ GlyphKit() [2/3]
HPS::GlyphKit::GlyphKit |
( |
GlyphKit const & |
in_kit | ) |
|
The copy constructor creates a new GlyphKit object that contains the same settings as the source GlyphKit.
- Parameters
-
◆ GlyphKit() [3/3]
HPS::GlyphKit::GlyphKit |
( |
GlyphKit && |
in_that | ) |
|
The move constructor creates a GlyphKit by transferring the underlying impl of the rvalue reference to this GlyphKit thereby avoiding a copy and allocation.
- Parameters
-
in_that | An rvalue reference to a GlyphKit to take the impl from. |
◆ Empty()
bool HPS::GlyphKit::Empty |
( |
| ) |
const |
|
virtual |
Indicates whether this GlyphKit has any values set on it.
- Returns
- true if no values are set on this GlyphKit, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
bool HPS::GlyphKit::Equals |
( |
GlyphKit const & |
in_kit | ) |
const |
Check if the source GlyphKit is equivalent to this GlyphKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
Creates a GlyphKit which contains the definition of the specified default glyph.
- Parameters
-
in_default_glyph | The default glyph for which to get the corresponding GlyphKit. |
- Returns
- A GlyphKit which contains the definition of the specified default glyph.
◆ ObjectType()
HPS::Type HPS::GlyphKit::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::GlyphKit::operator!= |
( |
GlyphKit const & |
in_kit | ) |
const |
Check if the source GlyphKit is not equivalent to this GlyphKit.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this GlyphKit thereby avoiding a copy.
- Parameters
-
in_that | An rvalue reference to a GlyphKit to take the impl from. |
- Returns
- A reference to this GlyphKit.
◆ operator=() [2/2]
◆ operator==()
bool HPS::GlyphKit::operator== |
( |
GlyphKit const & |
in_kit | ) |
const |
Check if the source GlyphKit is equivalent to this GlyphKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::GlyphKit::Set |
( |
GlyphKit const & |
in_kit | ) |
|
◆ SetElement()
Set a single element for this GlyphKit. This must be specified when defining a glyph.
- Parameters
-
in_element | A reference to the GlyphElement to set on this kit. |
- Returns
- A reference to this GlyphKit.
◆ SetElements() [1/2]
Sets the elements for this GlyphKit. This must be specified when defining a glyph.
- Parameters
-
in_def | The array of elements for the glyph. |
- Returns
- A reference to this GlyphKit.
◆ SetElements() [2/2]
Sets the elements for this GlyphKit. This must be specified when defining a glyph.
- Parameters
-
in_count | Size of the following array. |
in_def | The array of elements for the glyph. |
- Returns
- A reference to this GlyphKit.
◆ SetOffset()
Sets the offset for this GlyphKit. This will determine how the glyph gets shifted relative to the insertion point when the glyph is use. This must be specified when defining a glyph.
- Parameters
-
in_point | The offset for the glyph. |
- Returns
- A reference to this GlyphKit.
◆ SetOrdered()
GlyphKit& HPS::GlyphKit::SetOrdered |
( |
bool |
in_ordered | ) |
|
Sets ordering for this GlyphKit. This will determine whether the glyphs elements are drawn in the order specified. This setting is optional. The default is that glyph elements may be regrouped for faster drawing.
- Parameters
-
in_ordered | The ordering requirement for the glyph. |
- Returns
- A reference to this GlyphKit.
◆ SetRadius()
GlyphKit& HPS::GlyphKit::SetRadius |
( |
sbyte |
in_radius | ) |
|
Sets the radius of this GlyphKit. This must be specified when defining a glyph.
- Parameters
-
in_radius | The radius of the glyph. The value must be in the range [0,127]. |
- Returns
- A reference to this GlyphKit.
◆ Show()
void HPS::GlyphKit::Show |
( |
GlyphKit & |
out_kit | ) |
const |
◆ ShowElements()
Shows the elements for this GlyphKit.
- Parameters
-
out_def | The elements for the glyph. |
- Returns
- true if elements were set, false otherwise.
◆ ShowOffset()
bool HPS::GlyphKit::ShowOffset |
( |
GlyphPoint & |
out_point | ) |
const |
Shows the offset for this GlyphKit.
- Parameters
-
out_point | The offset for the glyph. |
- Returns
- true if an offset was set, false otherwise.
◆ ShowOrdered()
bool HPS::GlyphKit::ShowOrdered |
( |
bool & |
out_ordered | ) |
const |
Shows the ordering requirement for this GlyphKit.
- Parameters
-
out_point | The offset for the glyph. |
- Returns
- true if an offset was set, false otherwise.
◆ ShowRadius()
bool HPS::GlyphKit::ShowRadius |
( |
sbyte & |
out_radius | ) |
const |
Shows the radius for this GlyphKit.
- Parameters
-
out_radius | The radius for the glyph. |
- Returns
- true if a radius was set, false otherwise.
◆ UnsetElements()
GlyphKit& HPS::GlyphKit::UnsetElements |
( |
| ) |
|
Removes the elements for the glyph.
- Returns
- A reference to this GlyphKit.
◆ UnsetEverything()
GlyphKit& HPS::GlyphKit::UnsetEverything |
( |
| ) |
|
◆ UnsetOffset()
GlyphKit& HPS::GlyphKit::UnsetOffset |
( |
| ) |
|
Removes the offset for the glyph.
- Returns
- A reference to this GlyphKit.
◆ UnsetOrdered()
GlyphKit& HPS::GlyphKit::UnsetOrdered |
( |
| ) |
|
Removes the ordering requirement for the glyph.
- Returns
- A reference to this GlyphKit.
◆ UnsetRadius()
GlyphKit& HPS::GlyphKit::UnsetRadius |
( |
| ) |
|
Removes the radius for the glyph.
- Returns
- A reference to this GlyphKit.
The documentation for this class was generated from the following file: