#include <hps.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (GlyphKit const &in_kit) const |
GlyphKit () | |
GlyphKit (GlyphKit const &in_kit) | |
GlyphKit (GlyphKit &&in_that) | |
HPS::Type | ObjectType () const |
bool | operator!= (GlyphKit const &in_kit) const |
GlyphKit & | operator= (GlyphKit &&in_that) |
GlyphKit & | operator= (GlyphKit const &in_kit) |
bool | operator== (GlyphKit const &in_kit) const |
void | Set (GlyphKit const &in_kit) |
GlyphKit & | SetElement (GlyphElement const &in_element) |
GlyphKit & | SetElements (GlyphElementArray const &in_def) |
GlyphKit & | SetElements (size_t in_count, GlyphElement const in_def[]) |
GlyphKit & | SetOffset (GlyphPoint const &in_point) |
GlyphKit & | SetOrdered (bool in_ordered) |
GlyphKit & | SetRadius (sbyte in_radius) |
void | Show (GlyphKit &out_kit) const |
bool | ShowElements (GlyphElementArray &out_def) const |
bool | ShowOffset (GlyphPoint &out_point) const |
bool | ShowOrdered (bool &out_ordered) const |
bool | ShowRadius (sbyte &out_radius) const |
GlyphKit & | UnsetElements () |
GlyphKit & | UnsetEverything () |
GlyphKit & | UnsetOffset () |
GlyphKit & | UnsetOrdered () |
GlyphKit & | UnsetRadius () |
![]() | |
virtual HPS::Type | Type () const |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Static Public Member Functions | |
static HPS::GlyphKit | GetDefault (Glyph::Default in_default_glyph) |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::GlyphKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The GlyphKit class is a user space object. It is used when defining a glyph.
Constructor & Destructor Documentation
HPS::GlyphKit::GlyphKit | ( | ) |
The default constructor creates an empty GlyphKit object.
HPS::GlyphKit::GlyphKit | ( | GlyphKit const & | in_kit | ) |
HPS::GlyphKit::GlyphKit | ( | GlyphKit && | in_that | ) |
Member Function Documentation
|
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.
bool HPS::GlyphKit::Equals | ( | GlyphKit const & | in_kit | ) | const |
|
static |
|
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.
bool HPS::GlyphKit::operator!= | ( | GlyphKit const & | in_kit | ) | const |
bool HPS::GlyphKit::operator== | ( | GlyphKit const & | in_kit | ) | const |
void HPS::GlyphKit::Set | ( | GlyphKit const & | in_kit | ) |
GlyphKit& HPS::GlyphKit::SetElement | ( | GlyphElement const & | in_element | ) |
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.
GlyphKit& HPS::GlyphKit::SetElements | ( | GlyphElementArray const & | in_def | ) |
GlyphKit& HPS::GlyphKit::SetElements | ( | size_t | in_count, |
GlyphElement const | in_def[] | ||
) |
GlyphKit& HPS::GlyphKit::SetOffset | ( | GlyphPoint const & | in_point | ) |
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.
GlyphKit& HPS::GlyphKit::SetRadius | ( | sbyte | in_radius | ) |
void HPS::GlyphKit::Show | ( | GlyphKit & | out_kit | ) | const |
bool HPS::GlyphKit::ShowElements | ( | GlyphElementArray & | out_def | ) | const |
Shows the elements for this GlyphKit.
- Parameters
-
out_def The elements for the glyph.
- Returns
- true if elements were set, false otherwise.
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.
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.
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.
GlyphKit& HPS::GlyphKit::UnsetElements | ( | ) |
Removes the elements for the glyph.
- Returns
- A reference to this GlyphKit.
GlyphKit& HPS::GlyphKit::UnsetEverything | ( | ) |
GlyphKit& HPS::GlyphKit::UnsetOffset | ( | ) |
Removes the offset for the glyph.
- Returns
- A reference to this GlyphKit.
GlyphKit& HPS::GlyphKit::UnsetOrdered | ( | ) |
Removes the ordering requirement for the glyph.
- Returns
- A reference to this GlyphKit.
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:
- include/hps.h