Inheritance diagram for HPS.GlyphElement:
HPS.Object HPS.CircularArcGlyphElement HPS.DotGlyphElement HPS.EllipseGlyphElement HPS.ImageGlyphElement HPS.InfiniteLineGlyphElement HPS.LineGlyphElement HPS.SphereGlyphElement

Public Member Functions

override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.GlyphElement in_that)
 
override int GetHashCode ()
 
 GlyphElement ()
 
 GlyphElement (HPS.GlyphElement in_that)
 
override HPS.Type ObjectType ()
 
void Set (HPS.GlyphElement in_that)
 
void SetExplicitColor (HPS.RGBAColor in_color)
 
void SetFill (HPS.Glyph.Fill in_fill)
 
void SetIndexedColor (byte in_index)
 
void SetNormalColor ()
 
bool ShowColor (out HPS.Glyph.ColorSource out_source, out byte out_index, out HPS.RGBAColor out_color)
 
bool ShowFill (out HPS.Glyph.Fill out_fill)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static bool operator!= (HPS.GlyphElement a, HPS.GlyphElement b)
 
static bool operator== (HPS.GlyphElement a, HPS.GlyphElement 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.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

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

Detailed Description

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

Constructor & Destructor Documentation

◆ GlyphElement() [1/2]

HPS.GlyphElement.GlyphElement ( )
inline

The default constructor creates an empty GlyphElement object.

◆ GlyphElement() [2/2]

HPS.GlyphElement.GlyphElement ( HPS.GlyphElement  in_that)
inline

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

Parameters
in_thatThe source GlyphElement to copy.

Member Function Documentation

◆ Equals()

bool HPS.GlyphElement.Equals ( HPS.GlyphElement  in_that)
inline

Check if the source GlyphElement is equivalent to this GlyphElement.

Parameters
in_thatThe source GlyphElement to compare to this GlyphElement.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

override HPS.Type HPS.GlyphElement.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.

Reimplemented in HPS.InfiniteLineGlyphElement, HPS.LineGlyphElement, HPS.ImageGlyphElement, and HPS.SphereGlyphElement.

◆ Set()

void HPS.GlyphElement.Set ( HPS.GlyphElement  in_that)
inline

Copies the source GlyphElement into this GlyphElement.

Parameters
in_thatThe source GlyphElement to copy.

◆ SetExplicitColor()

void HPS.GlyphElement.SetExplicitColor ( HPS.RGBAColor  in_color)
inline

Sets the RGBA color for this GlyphElement.

Parameters
in_colorThe color for this GlyphElement.

◆ SetFill()

void HPS.GlyphElement.SetFill ( HPS.Glyph.Fill  in_fill)
inline

Sets the fill mode for this GlyphElement.

Parameters
in_fillThe fill mode for this GlyphElement.

◆ SetIndexedColor()

void HPS.GlyphElement.SetIndexedColor ( byte  in_index)
inline

Sets the color index for this GlyphElement.

Parameters
in_indexThe color index for this GlyphElement.

◆ SetNormalColor()

void HPS.GlyphElement.SetNormalColor ( )
inline

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

◆ ShowColor()

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

Shows the color for this GlyphElement.

Parameters
out_sourceThe color source for this GlyphElement.
out_indexThe color index for this GlyphElement. This is only valid if out_source is Glyph.ColorSource.Indexed.
out_colorThe color for this GlyphElement. This is only valid if out_source is Glyph.ColorSource.Explicit.
Returns
true if a color was set, false otherwise.

◆ ShowFill()

bool HPS.GlyphElement.ShowFill ( out HPS.Glyph.Fill  out_fill)
inline

Shows the fill mode for this GlyphElement.

Parameters
out_fillThe fill mode for this GlyphElement.
Returns
true if a fill mode was set, false otherwise.

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