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

Public Member Functions | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.GlyphElement in_that) |
Check if the source GlyphElement is equivalent to this GlyphElement. More... | |
override int | GetHashCode () |
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... | |
void | SetExplicitColor (HPS.RGBAColor in_color) |
Sets the RGBA color for 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... | |
bool | ShowColor (out HPS.Glyph.ColorSource out_source, out byte out_index, out HPS.RGBAColor out_color) |
Shows the color for this GlyphElement. More... | |
bool | ShowFill (out HPS.Glyph.Fill out_fill) |
Shows the fill mode for this GlyphElement. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
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... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. 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... | |
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
|
inline |
The default constructor creates an empty GlyphElement object.
|
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
|
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.
|
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, HPS.LineGlyphElement, and HPS.SphereGlyphElement.
|
inline |
Copies the source GlyphElement into this GlyphElement.
- Parameters
-
in_that The source GlyphElement to copy.
|
inline |
Sets the RGBA color for this GlyphElement.
- Parameters
-
in_color The color for this GlyphElement.
|
inline |
Sets the fill mode for this GlyphElement.
- Parameters
-
in_fill The fill mode for this GlyphElement.
|
inline |
Sets the color index for this GlyphElement.
- Parameters
-
in_index The color index for this GlyphElement.
|
inline |
Sets that this GlyphElement should inherit the color of the owning geometry which uses the glyph.
|
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.
|
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