|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
The ImageGlyphElement class is a user space object.
◆ ImageGlyphElement() [1/3]
HPS.ImageGlyphElement.ImageGlyphElement |
( |
| ) |
|
|
inline |
◆ ImageGlyphElement() [2/3]
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
-
◆ ImageGlyphElement() [3/3]
◆ ObjectType()
override HPS.Type HPS.ImageGlyphElement.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()
void HPS.ImageGlyphElement.SetDecimationFilter |
( |
bool |
in_filter | ) |
|
|
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()
void HPS.ImageGlyphElement.SetFixedColoring |
( |
bool |
in_fixed_color | ) |
|
|
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()
void HPS.ImageGlyphElement.SetFixedScaling |
( |
bool |
in_fixed_scale | ) |
|
|
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()
void HPS.ImageGlyphElement.SetInterpolationFilter |
( |
bool |
in_filter | ) |
|
|
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()
void HPS.ImageGlyphElement.SetOffset |
( |
float |
in_x_offset, |
|
|
float |
in_y_offset |
|
) |
| |
|
inline |
Sets an offset for the center of this ImageGlyphElement. The expected range of offset values is [0, 1]. This locates the origin of the glyph coordinate system relative to the center of the glyph.
- 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()
void HPS.ImageGlyphElement.SetRotation |
( |
float |
in_rotation | ) |
|
|
inline |
Sets a rotation this ImageGlyphElement.
- Parameters
-
in_rotation | The rotation in degrees for the source image. The default is 0.0. |
◆ SetScaling()
void HPS.ImageGlyphElement.SetScaling |
( |
float |
in_x_scale, |
|
|
float |
in_y_scale |
|
) |
| |
|
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()
void HPS.ImageGlyphElement.SetSource |
( |
string |
in_name | ) |
|
|
inline |
Sets the source image by name for this ImageGlyphElement.
- Parameters
-
in_name | The name of the source image. |
◆ ShowDecimationFilter()
bool HPS.ImageGlyphElement.ShowDecimationFilter |
( |
out bool |
out_filter | ) |
|
|
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()
bool HPS.ImageGlyphElement.ShowFixedColoring |
( |
out bool |
out_fixed_color | ) |
|
|
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()
bool HPS.ImageGlyphElement.ShowFixedScaling |
( |
out bool |
out_fixed_scale | ) |
|
|
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()
bool HPS.ImageGlyphElement.ShowInterpolationFilter |
( |
out bool |
out_filter | ) |
|
|
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()
bool HPS.ImageGlyphElement.ShowOffset |
( |
out float |
out_x_offset, |
|
|
out float |
out_y_offset |
|
) |
| |
|
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()
bool HPS.ImageGlyphElement.ShowRotation |
( |
out float |
out_rotation | ) |
|
|
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()
bool HPS.ImageGlyphElement.ShowScaling |
( |
out float |
out_x_scale, |
|
|
out float |
out_y_scale |
|
) |
| |
|
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()
bool HPS.ImageGlyphElement.ShowSource |
( |
out string |
out_name | ) |
|
|
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