ImageGlyphElement

class HPS.ImageGlyphElement : public HPS.GlyphElement 

The ImageGlyphElement class is a user space object.

Public Functions

override void Dispose ()

ImageGlyphElement (): The default constructor creates an empty ImageGlyphElement object.

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.

Param in_that: The source GlyphElement to copy.

ImageGlyphElement (HPS.ImageGlyphElement in_that)

The copy constructor creates a new ImageGlyphElement object that contains the same settings as the source ImageGlyphElement.

Param in_that: The source ImageGlyphElement to copy.

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).

Return: The declared type of the object in question, which may differ from the true, underlying type.

void SetDecimationFilter (bool in_filter)

Sets if decimation filtering is use for this ImageGlyphElement.

Param in_filter: If the glyph should use decimation filtering. The default is true.

void SetFixedColoring (bool in_fixed_color)

Sets if fixed color is used for this ImageGlyphElement.

Param in_fixed_color: If the glyph should use the image colors or the effective marker color. The default is true.

void SetFixedScaling (bool in_fixed_scale)

Sets if fixed scaling is used for this ImageGlyphElement.

Param in_fixed_scale: If the glyph should use the image size for scaling or the effective marker size. The default is true.

void SetInterpolationFilter (bool in_filter)

Sets if interpolation filtering is use for this ImageGlyphElement.

Param in_filter: If the glyph should use interpolation filtering. The default is true.

void SetOffset (float in_x_offset, float in_y_offset)

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.

Param in_x_offset: The x offset of the source image. The default is 0.5.
Param in_y_offset: The y offset of the source image. The default is 0.5.

void SetRotation (float in_rotation)

Sets a rotation this ImageGlyphElement.

Param in_rotation: The rotation in degrees for the source image. The default is 0.0.

void SetScaling (float in_x_scale, float in_y_scale)

Sets extra scaling for this ImageGlyphElement.

Param in_x_scale: The x scaling of the source image. The default is 1.0.
Param in_y_scale: The y scaling of the source image. The default is 1.0.

void SetSource (string in_name)

Sets the source image by name for this ImageGlyphElement.

Param in_name: The name of the source image.

bool ShowDecimationFilter (out bool out_filter)

Shows if decimation filtering is use for this ImageGlyphElement.

Param out_filter: If the glyph should use decimation filtering.
Return: true if a decimation filtering was set, false otherwise.

bool ShowFixedColoring (out bool out_fixed_color)

Shows if fixed color is used for this ImageGlyphElement.

Param out_fixed_color: If the glyph should use the image colors or the effective marker color.
Return: true if a fixed color was set, false otherwise.

bool ShowFixedScaling (out bool out_fixed_scale)

Shows if fixed scaling is used for this ImageGlyphElement.

Param out_fixed_scale: If the glyph should use the image size for scaling or the effective marker size.
Return: true if a fixed scaling was set, false otherwise.

bool ShowInterpolationFilter (out bool out_filter)

Shows if interpolation filtering is use for this ImageGlyphElement.

Param out_filter: If the glyph should use interpolation filtering.
Return: true if a interpolation filtering was set, false otherwise.

bool ShowOffset (out float out_x_offset, out float out_y_offset)

Shows an offset for the center of this ImageGlyphElement.

Param out_x_offset: The x offset of the source image.
Param out_y_offset: The y offset of the source image.
Return: true if an offset was set, false otherwise.

bool ShowRotation (out float out_rotation)

Shows a rotation this ImageGlyphElement.

Param out_rotation: The rotation in degrees for the source image.
Return: true if a rotation was set, false otherwise.

bool ShowScaling (out float out_x_scale, out float out_y_scale)

Shows extra scaling for this ImageGlyphElement.

Param out_x_scale: The x scaling of the source image.
Param out_y_scale: The y scaling of the source image.
Return: true if a scaling was set, false otherwise.

bool ShowSource (out string out_name)

Shows the source image by name for this ImageGlyphElement.

Param out_name: UTF8-encoded name of the source image.
Return: true if a source image name was set, false otherwise.