GlyphDefinition

class HPS::GlyphDefinition : public HPS::Definition 

The GlyphDefinition class is a smart pointer to a database object. It is a handler to a glyph defined within a portfolio.

Public Functions

GlyphDefinition(): The default constructor creates an uninitialized GlyphDefinition object. The Type() function will return Type::None.

GlyphDefinition(Definition const &in_that)

This constructor creates an GlyphDefinition object that shares the underlying smart-pointer of the source Definition. The copy will only be successful if the source definition is really an upcast of a glyph definition. Otherwise the copy will fail and the resulting GlyphDefinition will be invalid.

Parameters: in_that – The source Definition to copy.

GlyphDefinition(GlyphDefinition &&in_that)

The move constructor creates a GlyphDefinition by transferring the underlying impl of the rvalue reference to this GlyphDefinition thereby avoiding a copy and allocation.

Parameters: in_that – An rvalue reference to a GlyphDefinition to take the impl from.

GlyphDefinition(GlyphDefinition const &in_that)

The copy constructor creates an GlyphDefinition object that shares the underlying smart-pointer of the source GlyphDefinition.

Parameters: in_that – The source GlyphDefinition 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.

GlyphDefinition &operator=(GlyphDefinition &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this GlyphDefinition thereby avoiding a copy.

Parameters: in_that – An rvalue reference to a GlyphDefinition to take the impl from.
Returns: A reference to this GlyphDefinition.

GlyphDefinition &operator=(GlyphDefinition const &in_that)

Associate this GlyphDefinition with the same underlying impl as the source GlyphDefinition.

Parameters: in_that – The source GlyphDefinition for the assignment.
Returns: A reference to this GlyphDefinition.

void Set(GlyphKit const &in_kit)

Redefine the glyph for this GlyphDefinition.

Parameters: in_kit – The new glyph for this GlyphDefinition.

void Show(GlyphKit &out_kit) const

Shows the glyph for this GlyphDefinition.

Parameters: out_kit – The glyph for this GlyphDefinition.

~GlyphDefinition()

Public Static Attributes

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