GlyphElement

class HPS.GlyphElement : public HPS.Object

The GlyphElement class is a user space object. It is the base class for all glyph elements.

Subclassed by HPS.CircularArcGlyphElement, HPS.DotGlyphElement, HPS.EllipseGlyphElement, HPS.ImageGlyphElement, HPS.InfiniteLineGlyphElement, HPS.LineGlyphElement, HPS.SphereGlyphElement

Public Functions

override void Dispose ()
bool Equals (HPS.GlyphElement in_that)

Check if the source GlyphElement is equivalent to this GlyphElement.

Param in_that

The source GlyphElement to compare to this GlyphElement.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)
override int GetHashCode ()
GlyphElement ()

The default constructor creates an empty GlyphElement object.

GlyphElement (HPS.GlyphElement in_that)

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

Param in_that

The source GlyphElement 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.GlyphElement in_that)

Copies the source GlyphElement into this GlyphElement.

Param in_that

The source GlyphElement to copy.

void SetExplicitColor (HPS.RGBAColor in_color)

Sets the RGBA color for this GlyphElement.

Param in_color

The color for this GlyphElement.

void SetFill (HPS.Glyph.Fill in_fill)

Sets the fill mode for this GlyphElement.

Param in_fill

The fill mode for this GlyphElement.

void SetIndexedColor (byte in_index)

Sets the color index for this GlyphElement.

Param in_index

The color index for this GlyphElement.

void SetNormalColor ()

Sets that this GlyphElement should inherit the color of the owning geometry which uses the glyph.

bool ShowColor (out HPS.Glyph.ColorSource out_source, out byte out_index, out HPS.RGBAColor out_color)

Shows the color for this GlyphElement.

Param out_source

The color source for this GlyphElement.

Param out_index

The color index for this GlyphElement. This is only valid if out_source is Glyph.ColorSource.Indexed.

Param out_color

The color for this GlyphElement. This is only valid if out_source is Glyph.ColorSource.Explicit.

Return

true if a color was set, false otherwise.

bool ShowFill (out HPS.Glyph.Fill out_fill)

Shows the fill mode for this GlyphElement.

Param out_fill

The fill mode for this GlyphElement.

Return

true if a fill mode was set, false otherwise.

Public Static Functions

bool operator!= (HPS.GlyphElement a, HPS.GlyphElement b)
bool operator== (HPS.GlyphElement a, HPS.GlyphElement b)