
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) |
![]() | |
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 IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
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]
|
inline |
The default constructor creates an empty GlyphElement object.
◆ GlyphElement() [2/2]
|
inline |
The copy constructor creates a new GlyphElement object that contains the same settings as the source GlyphElement.
- Parameters
-
in_that The source GlyphElement to copy.
Member Function Documentation
◆ Equals()
|
inline |
Check if the source GlyphElement is equivalent to this GlyphElement.
- Parameters
-
in_that The source GlyphElement to compare to this GlyphElement.
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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()
|
inline |
Copies the source GlyphElement into this GlyphElement.
- Parameters
-
in_that The source GlyphElement to copy.
◆ SetExplicitColor()
|
inline |
Sets the RGBA color for this GlyphElement.
- Parameters
-
in_color The color for this GlyphElement.
◆ SetFill()
|
inline |
Sets the fill mode for this GlyphElement.
- Parameters
-
in_fill The fill mode for this GlyphElement.
◆ SetIndexedColor()
|
inline |
Sets the color index for this GlyphElement.
- Parameters
-
in_index The color index for this GlyphElement.
◆ SetNormalColor()
|
inline |
Sets that this GlyphElement should inherit the color of the owning geometry which uses the glyph.
◆ ShowColor()
|
inline |
Shows the color for this GlyphElement.
- Parameters
-
out_source The color source for this GlyphElement. out_index The color index for this GlyphElement. This is only valid if out_source is Glyph.ColorSource.Indexed. out_color The 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()
|
inline |
Shows the fill mode for this GlyphElement.
- Parameters
-
out_fill The 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