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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.GlyphKit in_kit)
 
override int GetHashCode ()
 
 GlyphKit ()
 
 GlyphKit (HPS.GlyphKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.GlyphKit in_kit)
 
HPS.GlyphKit SetElement (HPS.GlyphElement in_element)
 
HPS.GlyphKit SetElements (HPS.GlyphElement[] in_def)
 
HPS.GlyphKit SetOffset (HPS.GlyphPoint in_point)
 
HPS.GlyphKit SetOrdered (bool in_ordered)
 
HPS.GlyphKit SetRadius (sbyte in_radius)
 
void Show (out HPS.GlyphKit out_kit)
 
bool ShowElements (out HPS.GlyphElement[] out_def)
 
bool ShowOffset (out HPS.GlyphPoint out_point)
 
bool ShowOrdered (out bool out_ordered)
 
bool ShowRadius (out sbyte out_radius)
 
HPS.GlyphKit UnsetElements ()
 
HPS.GlyphKit UnsetEverything ()
 
HPS.GlyphKit UnsetOffset ()
 
HPS.GlyphKit UnsetOrdered ()
 
HPS.GlyphKit UnsetRadius ()
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.GlyphKit GetDefault (HPS.Glyph.Default in_default_glyph)
 
static bool operator!= (HPS.GlyphKit a, HPS.GlyphKit b)
 
static bool operator== (HPS.GlyphKit a, HPS.GlyphKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Kit
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

◆ GlyphKit() [1/2]

HPS.GlyphKit.GlyphKit ( )
inline

The default constructor creates an empty GlyphKit object.

◆ GlyphKit() [2/2]

HPS.GlyphKit.GlyphKit ( HPS.GlyphKit  in_kit)
inline

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

Parameters
in_kitThe source GlyphKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.GlyphKit.Empty ( )
inlinevirtual

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 ( HPS.GlyphKit  in_kit)
inline

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 ( HPS.Glyph.Default  in_default_glyph)
inlinestatic

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()

override HPS.Type HPS.GlyphKit.ObjectType ( )
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.Object.

◆ Set()

void HPS.GlyphKit.Set ( HPS.GlyphKit  in_kit)
inline

Copies the source GlyphKit into this GlyphKit.

Parameters
in_kitThe source GlyphKit to copy.

◆ SetElement()

HPS.GlyphKit HPS.GlyphKit.SetElement ( HPS.GlyphElement  in_element)
inline

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()

HPS.GlyphKit HPS.GlyphKit.SetElements ( HPS.GlyphElement []  in_def)
inline

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.

◆ SetOffset()

HPS.GlyphKit HPS.GlyphKit.SetOffset ( HPS.GlyphPoint  in_point)
inline

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()

HPS.GlyphKit HPS.GlyphKit.SetOrdered ( bool  in_ordered)
inline

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()

HPS.GlyphKit HPS.GlyphKit.SetRadius ( sbyte  in_radius)
inline

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 ( out HPS.GlyphKit  out_kit)
inline

Copies this GlyphKit into the given GlyphKit.

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

◆ ShowElements()

bool HPS.GlyphKit.ShowElements ( out HPS.GlyphElement []  out_def)
inline

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 ( out HPS.GlyphPoint  out_point)
inline

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 ( out bool  out_ordered)
inline

Shows the ordering requirement for this GlyphKit.

Returns
true if an offset was set, false otherwise.

◆ ShowRadius()

bool HPS.GlyphKit.ShowRadius ( out sbyte  out_radius)
inline

Shows the radius for this GlyphKit.

Parameters
out_radiusThe radius for the glyph.
Returns
true if a radius was set, false otherwise.

◆ UnsetElements()

HPS.GlyphKit HPS.GlyphKit.UnsetElements ( )
inline

Removes the elements for the glyph.

Returns
A reference to this GlyphKit.

◆ UnsetEverything()

HPS.GlyphKit HPS.GlyphKit.UnsetEverything ( )
inline

Removes all settings from this GlyphKit.

Returns
A reference to this GlyphKit.

◆ UnsetOffset()

HPS.GlyphKit HPS.GlyphKit.UnsetOffset ( )
inline

Removes the offset for the glyph.

Returns
A reference to this GlyphKit.

◆ UnsetOrdered()

HPS.GlyphKit HPS.GlyphKit.UnsetOrdered ( )
inline

Removes the ordering requirement for the glyph.

Returns
A reference to this GlyphKit.

◆ UnsetRadius()

HPS.GlyphKit HPS.GlyphKit.UnsetRadius ( )
inline

Removes the radius for the glyph.

Returns
A reference to this GlyphKit.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.GlyphKit.cs