GlyphKit

class HPS::GlyphKit : public HPS::Kit 

The GlyphKit class is a user space object. It is used when defining a glyph.

Public Functions

virtual bool Empty() const

Indicates whether this GlyphKit has any values set on it.

Returns: true if no values are set on this GlyphKit, false otherwise.

bool Equals(GlyphKit const &in_kit) const

Check if the source GlyphKit is equivalent to this GlyphKit.

Parameters: in_kit – The source GlyphKit to compare to this GlyphKit.
Returns: true if the objects are equivalent, false otherwise.

GlyphKit(): The default constructor creates an empty GlyphKit object.

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.

GlyphKit(GlyphKit const &in_kit)

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

Parameters: in_kit – The source GlyphKit to copy.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(GlyphKit const &in_kit) const

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

Parameters: in_kit – The source GlyphKit to compare to this GlyphKit.
Returns: true if the objects are not equivalent, false otherwise.

GlyphKit &operator=(GlyphKit &&in_that)

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.

GlyphKit &operator=(GlyphKit const &in_kit)

Copies the source GlyphKit into this GlyphKit.

Parameters: in_kit – The source GlyphKit to copy.
Returns: A reference to this GlyphKit.

bool operator==(GlyphKit const &in_kit) const

Check if the source GlyphKit is equivalent to this GlyphKit.

Parameters: in_kit – The source GlyphKit to compare to this GlyphKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(GlyphKit const &in_kit)

Copies the source GlyphKit into this GlyphKit.

Parameters: in_kit – The source GlyphKit to copy.

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 &SetElements(GlyphElementArray const &in_def)

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.

GlyphKit &SetElements(size_t in_count, GlyphElement const in_def[])

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.

GlyphKit &SetOffset(GlyphPoint const &in_point)

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.

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 &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.

void Show(GlyphKit &out_kit) const

Copies this GlyphKit into the given GlyphKit.

Parameters: out_kit – The GlyphKit to populate with the contents of this GlyphKit.

bool 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 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 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 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 &UnsetElements()

Removes the elements for the glyph.

Returns: A reference to this GlyphKit.

GlyphKit &UnsetEverything()

Removes all settings from this GlyphKit.

Returns: A reference to this GlyphKit.

GlyphKit &UnsetOffset()

Removes the offset for the glyph.

Returns: A reference to this GlyphKit.

GlyphKit &UnsetOrdered()

Removes the ordering requirement for the glyph.

Returns: A reference to this GlyphKit.

GlyphKit &UnsetRadius()

Removes the radius for the glyph.

Returns: A reference to this GlyphKit.

virtual ~GlyphKit()

Public Static Functions

static HPS::GlyphKit GetDefault(Glyph::Default in_default_glyph)

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.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::GlyphKit