The GlyphKit class is a user space object. More...

#include <hps.h>

Inheritance diagram for HPS::GlyphKit:

Collaboration diagram for HPS::GlyphKit:

Public Member Functions
	GlyphKit ()
	The default constructor creates an empty GlyphKit object. More...

	GlyphKit (GlyphKit const &in_kit)
	The copy constructor creates a new GlyphKit object that contains the same settings as the source GlyphKit. More...

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

GlyphKit &	operator= (GlyphKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this GlyphKit thereby avoiding a copy. More...

virtual	~GlyphKit ()

HPS::Type	ObjectType () const

void	Set (GlyphKit const &in_kit)
	Copies the source GlyphKit into this GlyphKit. More...

void	Show (GlyphKit &out_kit) const
	Copies this GlyphKit into the given GlyphKit. More...

GlyphKit &	operator= (GlyphKit const &in_kit)
	Copies the source GlyphKit into this GlyphKit. More...

bool	Empty () const
	Indicates whether this GlyphKit has any values set on it. More...

bool	Equals (GlyphKit const &in_kit) const
	Check if the source GlyphKit is equivalent to this GlyphKit. More...

bool	operator== (GlyphKit const &in_kit) const
	Check if the source GlyphKit is equivalent to this GlyphKit. More...

bool	operator!= (GlyphKit const &in_kit) const
	Check if the source GlyphKit is not equivalent to this GlyphKit. More...

GlyphKit &	SetRadius (sbyte in_radius)
	Sets the radius of this GlyphKit. More...

GlyphKit &	SetOffset (GlyphPoint const &in_point)
	Sets the offset for this GlyphKit. More...

GlyphKit &	SetElements (GlyphElementArray const &in_def)
	Sets the elements for this GlyphKit. More...

GlyphKit &	SetElements (size_t in_count, GlyphElement const in_def [])
	Sets the elements for this GlyphKit. More...

GlyphKit &	SetElement (GlyphElement const &in_element)
	Set a single element for this GlyphKit. More...

GlyphKit &	UnsetRadius ()
	Removes the radius for the glyph. More...

GlyphKit &	UnsetOffset ()
	Removes the offset for the glyph. More...

GlyphKit &	UnsetElements ()
	Removes the elements for the glyph. More...

GlyphKit &	UnsetEverything ()
	Removes all settings from this GlyphKit. More...

bool	ShowRadius (sbyte &out_radius) const
	Shows the radius for this GlyphKit. More...

bool	ShowOffset (GlyphPoint &out_point) const
	Shows the offset for this GlyphKit. More...

bool	ShowElements (GlyphElementArray &out_def) const
	Shows the elements for this GlyphKit. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static HPS::GlyphKit	GetDefault (Glyph::Default in_default_glyph)
	Creates a GlyphKit which contains the definition of the specified default glyph. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::GlyphKit

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_kit The 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_that An rvalue reference to a GlyphKit to take the impl from.

◆ ~GlyphKit()

virtual HPS::GlyphKit::~GlyphKit ( )

virtual

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ 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_kit The source GlyphKit to compare to this GlyphKit.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ 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_glyph The default glyph for which to get the corresponding GlyphKit.

Returns: A GlyphKit which contains the definition of the specified default glyph.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::GlyphKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::GlyphKit::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.

◆ 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_that An 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_kit The 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_kit The source GlyphKit to compare to this GlyphKit.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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

Copies the source GlyphKit into this GlyphKit.

Parameters

in_kit The 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_element A 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_def The 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_count	Size of the following array.
in_def	The 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_point The offset 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

Copies this GlyphKit into the given GlyphKit.

Parameters

out_kit The 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_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.

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

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

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

◆ UnsetRadius()

GlyphKit& HPS::GlyphKit::UnsetRadius ( )

Removes the radius for the glyph.

Returns: A reference to this GlyphKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::GlyphKit::staticType = HPS::Type::GlyphKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GlyphKit() [1/3]

◆ GlyphKit() [2/3]

◆ GlyphKit() [3/3]

◆ ~GlyphKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetElement()

◆ SetElements() [1/2]

◆ SetElements() [2/2]

◆ SetOffset()

◆ SetRadius()

◆ Show()

◆ ShowElements()

◆ ShowOffset()

◆ ShowRadius()

◆ Type()

◆ UnsetElements()

◆ UnsetEverything()

◆ UnsetOffset()

◆ UnsetRadius()

Member Data Documentation

◆ staticType