#include <hps.h>

Inheritance diagram for HPS::GlyphKit:
HPS::Kit HPS::Object

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
 
GlyphKitoperator= (GlyphKit &&in_that)
 
GlyphKitoperator= (GlyphKit const &in_kit)
 
bool operator== (GlyphKit const &in_kit) const
 
void Set (GlyphKit const &in_kit)
 
GlyphKitSetElement (GlyphElement const &in_element)
 
GlyphKitSetElements (GlyphElementArray const &in_def)
 
GlyphKitSetElements (size_t in_count, GlyphElement const in_def [])
 
GlyphKitSetOffset (GlyphPoint const &in_point)
 
GlyphKitSetOrdered (bool in_ordered)
 
GlyphKitSetRadius (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
 
GlyphKitUnsetElements ()
 
GlyphKitUnsetEverything ()
 
GlyphKitUnsetOffset ()
 
GlyphKitUnsetOrdered ()
 
GlyphKitUnsetRadius ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
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 ()
 

Static Public Member Functions

static HPS::GlyphKit GetDefault (Glyph::Default in_default_glyph)
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::GlyphKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ 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
in_kitThe source GlyphKit to copy.

◆ 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_thatAn rvalue reference to a GlyphKit to take the impl from.

Member Function Documentation

◆ 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
in_kitThe source GlyphKit to compare to this GlyphKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

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

Creates a GlyphKit which contains the definition of the specified default glyph.

Parameters
in_default_glyphThe 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
in_kitThe source GlyphKit to compare to this GlyphKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

GlyphKit& HPS::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_thatAn rvalue reference to a GlyphKit to take the impl from.
Returns
A reference to this GlyphKit.

◆ operator=() [2/2]

GlyphKit& HPS::GlyphKit::operator= ( GlyphKit const &  in_kit)

Copies the source GlyphKit into this GlyphKit.

Parameters
in_kitThe source GlyphKit to copy.
Returns
A reference to this GlyphKit.

◆ operator==()

bool HPS::GlyphKit::operator== ( GlyphKit const &  in_kit) const

Check if the source GlyphKit is equivalent to this GlyphKit.

Parameters
in_kitThe source GlyphKit to compare to this GlyphKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::GlyphKit::Set ( GlyphKit const &  in_kit)

Copies the source GlyphKit into this GlyphKit.

Parameters
in_kitThe source GlyphKit to copy.

◆ SetElement()

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_elementA reference to the GlyphElement to set on this kit.
Returns
A reference to this GlyphKit.

◆ SetElements() [1/2]

GlyphKit& HPS::GlyphKit::SetElements ( GlyphElementArray const &  in_def)

Sets the elements for this GlyphKit. This must be specified when defining a glyph.

Parameters
in_defThe array of elements for the glyph.
Returns
A reference to this GlyphKit.

◆ SetElements() [2/2]

GlyphKit& HPS::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_countSize of the following array.
in_defThe array of elements for the glyph.
Returns
A reference to this GlyphKit.

◆ SetOffset()

GlyphKit& HPS::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_pointThe 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_orderedThe 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_radiusThe 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

Copies this GlyphKit into the given GlyphKit.

Parameters
out_kitThe GlyphKit to populate with the contents of this GlyphKit.

◆ ShowElements()

bool HPS::GlyphKit::ShowElements ( GlyphElementArray out_def) const

Shows the elements for this GlyphKit.

Parameters
out_defThe 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_pointThe 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_pointThe 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_radiusThe 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 ( )

Removes all settings from this GlyphKit.

Returns
A reference to this GlyphKit.

◆ 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: