Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.GlyphElement Class Reference

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

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

Public Member Functions

override void Dispose ()
 
 GlyphElement ()
 The default constructor creates an empty GlyphElement object. More...
 
 GlyphElement (HPS.GlyphElement in_that)
 The copy constructor creates a new GlyphElement object that contains the same settings as the source GlyphElement. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.GlyphElement in_that)
 Copies the source GlyphElement into this GlyphElement. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.GlyphElement in_that)
 Check if the source GlyphElement is equivalent to this GlyphElement. More...
 
void SetFill (HPS.Glyph.Fill in_fill)
 Sets the fill mode for this GlyphElement. More...
 
void SetIndexedColor (byte in_index)
 Sets the color index for this GlyphElement. More...
 
void SetNormalColor ()
 Sets that this GlyphElement should inherit the color of the owning geometry which uses the glyph. More...
 
void SetExplicitColor (HPS.RGBAColor in_color)
 Sets the RGBA color for this GlyphElement. More...
 
bool ShowFill (out HPS.Glyph.Fill out_fill)
 Shows the fill mode for this GlyphElement. More...
 
bool ShowColor (out HPS.Glyph.ColorSource out_source, out byte out_index, out HPS.RGBAColor out_color)
 Shows the color for this GlyphElement. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

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

Constructor & Destructor Documentation

HPS.GlyphElement.GlyphElement ( )
inline

The default constructor creates an empty GlyphElement object.

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 <ref refid="class_h_p_s_1_1_glyph_element" kindref="compound">GlyphElement</ref> to copy.

Member Function Documentation

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

Check if the source GlyphElement is equivalent to this GlyphElement.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_glyph_element" kindref="compound">GlyphElement</ref> to compare to this <ref refid="class_h_p_s_1_1_glyph_element" kindref="compound">GlyphElement</ref>.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.GlyphElement.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying 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, and HPS.LineGlyphElement.

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

Copies the source GlyphElement into this GlyphElement.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_glyph_element" kindref="compound">GlyphElement</ref> to copy.
void HPS.GlyphElement.SetExplicitColor ( HPS.RGBAColor  in_color)
inline

Sets the RGBA color for this GlyphElement.

Parameters
in_colorThe color for this <ref refid="class_h_p_s_1_1_glyph_element" kindref="compound">GlyphElement</ref>.
void HPS.GlyphElement.SetFill ( HPS.Glyph.Fill  in_fill)
inline

Sets the fill mode for this GlyphElement.

Parameters
in_fillThe fill mode for this <ref refid="class_h_p_s_1_1_glyph_element" kindref="compound">GlyphElement</ref>.
void HPS.GlyphElement.SetIndexedColor ( byte  in_index)
inline

Sets the color index for this GlyphElement.

Parameters
in_indexThe color index for this <ref refid="class_h_p_s_1_1_glyph_element" kindref="compound">GlyphElement</ref>.
void HPS.GlyphElement.SetNormalColor ( )
inline

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

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 <ref refid="class_h_p_s_1_1_glyph_element" kindref="compound">GlyphElement</ref>.
out_indexThe color index for this <ref refid="class_h_p_s_1_1_glyph_element" kindref="compound">GlyphElement</ref>. This is only valid if out_source is <ref refid="class_h_p_s_1_1_glyph_1abadc652d6f7223ce25aeeddb9b74656dacccd5fd8c8f59fe9373c56b1b951780c" kindref="member">Glyph::ColorSource::Indexed</ref>.
out_colorThe color for this <ref refid="class_h_p_s_1_1_glyph_element" kindref="compound">GlyphElement</ref>. This is only valid if out_source is <ref refid="class_h_p_s_1_1_glyph_1abadc652d6f7223ce25aeeddb9b74656da9d71760e2dd451db2df354d0fd29cd7f" kindref="member">Glyph::ColorSource::Explicit</ref>.
Returns
true if a color was set, false otherwise.
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 <ref refid="class_h_p_s_1_1_glyph_element" kindref="compound">GlyphElement</ref>.
Returns
true if a fill mode was set, false otherwise.

The documentation for this class was generated from the following file: