GlyphKit
- class HPS.GlyphKit : public HPS.Kit
The GlyphKit class is a user space object. It is used when defining a glyph.
Public Functions
- override void Dispose ()
- override bool Empty ()
Indicates whether this GlyphKit has any values set on it.
- Return
true if no values are set on this GlyphKit, false otherwise.
- bool Equals (HPS.GlyphKit in_kit)
Check if the source GlyphKit is equivalent to this GlyphKit.
- override bool Equals (Object obj)
- override int GetHashCode ()
- GlyphKit (HPS.GlyphKit in_kit)
The copy constructor creates a new GlyphKit object that contains the same settings as the source GlyphKit.
- Param in_kit
The source GlyphKit to copy.
- override HPS.Type ObjectType ()
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).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- void Set (HPS.GlyphKit in_kit)
Copies the source GlyphKit into this GlyphKit.
- Param in_kit
The source GlyphKit to copy.
- HPS.GlyphKit SetElement (HPS.GlyphElement in_element)
Set a single element for this GlyphKit. This must be specified when defining a glyph.
- Param in_element
A reference to the GlyphElement to set on this kit.
- Return
A reference to this GlyphKit.
- HPS.GlyphKit SetElements (HPS.GlyphElement[] in_def)
Sets the elements for this GlyphKit. This must be specified when defining a glyph.
- Param in_def
The array of elements for the glyph.
- Return
A reference to this GlyphKit.
- HPS.GlyphKit SetOffset (HPS.GlyphPoint 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.
- Param in_point
The offset for the glyph.
- Return
A reference to this 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.
- Param in_ordered
The ordering requirement for the glyph.
- Return
A reference to this GlyphKit.
- HPS.GlyphKit SetRadius (sbyte in_radius)
Sets the radius of this GlyphKit. This must be specified when defining a glyph.
- Param in_radius
The radius of the glyph. The value must be in the range [0,127].
- Return
A reference to this GlyphKit.
- void Show (out HPS.GlyphKit out_kit)
- bool ShowElements (out HPS.GlyphElement[] out_def)
Shows the elements for this GlyphKit.
- Param out_def
The elements for the glyph.
- Return
true if elements were set, false otherwise.
- bool ShowOffset (out HPS.GlyphPoint out_point)
Shows the offset for this GlyphKit.
- Param out_point
The offset for the glyph.
- Return
true if an offset was set, false otherwise.
- bool ShowOrdered (out bool out_ordered)
Shows the ordering requirement for this GlyphKit.
- Return
true if an offset was set, false otherwise.
- bool ShowRadius (out sbyte out_radius)
Shows the radius for this GlyphKit.
- Param out_radius
The radius for the glyph.
- Return
true if a radius was set, false otherwise.
- HPS.GlyphKit UnsetElements ()
Removes the elements for the glyph.
- Return
A reference to this GlyphKit.
- HPS.GlyphKit UnsetEverything ()
Removes all settings from this GlyphKit.
- Return
A reference to this GlyphKit.
- HPS.GlyphKit UnsetOffset ()
Removes the offset for the glyph.
- Return
A reference to this GlyphKit.
- HPS.GlyphKit UnsetOrdered ()
Removes the ordering requirement for the glyph.
- Return
A reference to this GlyphKit.
- HPS.GlyphKit UnsetRadius ()
Removes the radius for the glyph.
- Return
A reference to this GlyphKit.
Public Static Functions
- HPS.GlyphKit GetDefault (HPS.Glyph.Default in_default_glyph)
Creates a GlyphKit which contains the definition of the specified default glyph.
- bool operator!= (HPS.GlyphKit a, HPS.GlyphKit b)
- bool operator== (HPS.GlyphKit a, HPS.GlyphKit b)
