
Public Member Functions | |
override void | Dispose () |
ImageGlyphElement () | |
The default constructor creates an empty ImageGlyphElement object. More... | |
ImageGlyphElement (HPS.GlyphElement in_that) | |
This constructor creates a ImageGlyphElement object that contains the same settings as the source GlyphElement. The copy will only be successful if the source glyph element is really an upcast of a line glyph element. Otherwise the copy will fail and the resulting LineGlyphElement will be invalid. More... | |
ImageGlyphElement (HPS.ImageGlyphElement in_that) | |
The copy constructor creates a new ImageGlyphElement object that contains the same settings as the source ImageGlyphElement. More... | |
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). More... | |
void | SetDecimationFilter (bool in_filter) |
Sets if decimation filtering is use for this ImageGlyphElement. More... | |
void | SetFixedColoring (bool in_fixed_color) |
Sets if fixed color is used for this ImageGlyphElement. More... | |
void | SetFixedScaling (bool in_fixed_scale) |
Sets if fixed scaling is used for this ImageGlyphElement. More... | |
void | SetInterpolationFilter (bool in_filter) |
Sets if interpolation filtering is use for this ImageGlyphElement. More... | |
void | SetOffset (float in_x_offset, float in_y_offset) |
Sets an offset for the center of this ImageGlyphElement. More... | |
void | SetRotation (float in_rotation) |
Sets a rotation this ImageGlyphElement. More... | |
void | SetScaling (float in_x_scale, float in_y_scale) |
Sets extra scaling for this ImageGlyphElement. More... | |
void | SetSource (string in_name) |
Sets the source image by name for this ImageGlyphElement. More... | |
bool | ShowDecimationFilter (out bool out_filter) |
Shows if decimation filtering is use for this ImageGlyphElement. More... | |
bool | ShowFixedColoring (out bool out_fixed_color) |
Shows if fixed color is used for this ImageGlyphElement. More... | |
bool | ShowFixedScaling (out bool out_fixed_scale) |
Shows if fixed scaling is used for this ImageGlyphElement. More... | |
bool | ShowInterpolationFilter (out bool out_filter) |
Shows if interpolation filtering is use for this ImageGlyphElement. More... | |
bool | ShowOffset (out float out_x_offset, out float out_y_offset) |
Shows an offset for the center of this ImageGlyphElement. More... | |
bool | ShowRotation (out float out_rotation) |
Shows a rotation this ImageGlyphElement. More... | |
bool | ShowScaling (out float out_x_scale, out float out_y_scale) |
Shows extra scaling for this ImageGlyphElement. More... | |
bool | ShowSource (out string out_name) |
Shows the source image by name for this ImageGlyphElement. More... | |
![]() | |
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... | |
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 the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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... | |
virtual 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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.GlyphElement a, HPS.GlyphElement b) |
static bool | operator== (HPS.GlyphElement a, HPS.GlyphElement b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The ImageGlyphElement class is a user space object.
Constructor & Destructor Documentation
◆ ImageGlyphElement() [1/3]
|
inline |
The default constructor creates an empty ImageGlyphElement object.
◆ ImageGlyphElement() [2/3]
|
inline |
This constructor creates a ImageGlyphElement object that contains the same settings as the source GlyphElement. The copy will only be successful if the source glyph element is really an upcast of a line glyph element. Otherwise the copy will fail and the resulting LineGlyphElement will be invalid.
- Parameters
-
in_that The source GlyphElement to copy.
◆ ImageGlyphElement() [3/3]
|
inline |
The copy constructor creates a new ImageGlyphElement object that contains the same settings as the source ImageGlyphElement.
- Parameters
-
in_that The source ImageGlyphElement to copy.
Member Function Documentation
◆ 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.GlyphElement.
◆ SetDecimationFilter()
|
inline |
Sets if decimation filtering is use for this ImageGlyphElement.
- Parameters
-
in_filter If the glyph should use decimation filtering. The default is true.
◆ SetFixedColoring()
|
inline |
Sets if fixed color is used for this ImageGlyphElement.
- Parameters
-
in_fixed_color If the glyph should use the image colors or the effective marker color. The default is true.
◆ SetFixedScaling()
|
inline |
Sets if fixed scaling is used for this ImageGlyphElement.
- Parameters
-
in_fixed_scale If the glyph should use the image size for scaling or the effective marker size. The default is true.
◆ SetInterpolationFilter()
|
inline |
Sets if interpolation filtering is use for this ImageGlyphElement.
- Parameters
-
in_filter If the glyph should use interpolation filtering. The default is true.
◆ SetOffset()
|
inline |
Sets an offset for the center of this ImageGlyphElement.
- Parameters
-
in_x_offset The x offset of the source image. The default is 0.5. in_y_offset The y offset of the source image. The default is 0.5.
◆ SetRotation()
|
inline |
Sets a rotation this ImageGlyphElement.
- Parameters
-
in_rotation The rotation in degrees for the source image. The default is 0.0.
◆ SetScaling()
|
inline |
Sets extra scaling for this ImageGlyphElement.
- Parameters
-
in_x_scale The x scaling of the source image. The default is 1.0. in_y_scale The y scaling of the source image. The default is 1.0.
◆ SetSource()
|
inline |
Sets the source image by name for this ImageGlyphElement.
- Parameters
-
in_name The name of the source image.
◆ ShowDecimationFilter()
|
inline |
Shows if decimation filtering is use for this ImageGlyphElement.
- Parameters
-
out_filter If the glyph should use decimation filtering.
- Returns
- true if a decimation filtering was set, false otherwise.
◆ ShowFixedColoring()
|
inline |
Shows if fixed color is used for this ImageGlyphElement.
- Parameters
-
out_fixed_color If the glyph should use the image colors or the effective marker color.
- Returns
- true if a fixed color was set, false otherwise.
◆ ShowFixedScaling()
|
inline |
Shows if fixed scaling is used for this ImageGlyphElement.
- Parameters
-
out_fixed_scale If the glyph should use the image size for scaling or the effective marker size.
- Returns
- true if a fixed scaling was set, false otherwise.
◆ ShowInterpolationFilter()
|
inline |
Shows if interpolation filtering is use for this ImageGlyphElement.
- Parameters
-
out_filter If the glyph should use interpolation filtering.
- Returns
- true if a interpolation filtering was set, false otherwise.
◆ ShowOffset()
|
inline |
Shows an offset for the center of this ImageGlyphElement.
- Parameters
-
out_x_offset The x offset of the source image. out_y_offset The y offset of the source image.
- Returns
- true if an offset was set, false otherwise.
◆ ShowRotation()
|
inline |
Shows a rotation this ImageGlyphElement.
- Parameters
-
out_rotation The rotation in degrees for the source image.
- Returns
- true if a rotation was set, false otherwise.
◆ ShowScaling()
|
inline |
Shows extra scaling for this ImageGlyphElement.
- Parameters
-
out_x_scale The x scaling of the source image. out_y_scale The y scaling of the source image.
- Returns
- true if a scaling was set, false otherwise.
◆ ShowSource()
|
inline |
Shows the source image by name for this ImageGlyphElement.
- Parameters
-
out_name UTF8-encoded name of the source image.
- Returns
- true if a source image name was set, false otherwise.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.ImageGlyphElement.cs