HPS.ImageGlyphElement Class Reference
Inheritance diagram for HPS.ImageGlyphElement:
HPS.GlyphElement HPS.Object

Public Member Functions

override void Dispose ()
 
 ImageGlyphElement ()
 
 ImageGlyphElement (HPS.GlyphElement in_that)
 
 ImageGlyphElement (HPS.ImageGlyphElement in_that)
 
override HPS.Type ObjectType ()
 
void SetDecimationFilter (bool in_filter)
 
void SetFixedColoring (bool in_fixed_color)
 
void SetFixedScaling (bool in_fixed_scale)
 
void SetInterpolationFilter (bool in_filter)
 
void SetOffset (float in_x_offset, float in_y_offset)
 
void SetRotation (float in_rotation)
 
void SetScaling (float in_x_scale, float in_y_scale)
 
void SetSource (string in_name)
 
bool ShowDecimationFilter (out bool out_filter)
 
bool ShowFixedColoring (out bool out_fixed_color)
 
bool ShowFixedScaling (out bool out_fixed_scale)
 
bool ShowInterpolationFilter (out bool out_filter)
 
bool ShowOffset (out float out_x_offset, out float out_y_offset)
 
bool ShowRotation (out float out_rotation)
 
bool ShowScaling (out float out_x_scale, out float out_y_scale)
 
bool ShowSource (out string out_name)
 
- Public Member Functions inherited from HPS.GlyphElement
override bool Equals (System.Object obj)
 
bool Equals (HPS.GlyphElement in_that)
 
override int GetHashCode ()
 
 GlyphElement ()
 
 GlyphElement (HPS.GlyphElement in_that)
 
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)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.GlyphElement
static bool operator!= (HPS.GlyphElement a, HPS.GlyphElement b)
 
static bool operator== (HPS.GlyphElement a, HPS.GlyphElement b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The ImageGlyphElement class is a user space object.

Constructor & Destructor Documentation

◆ ImageGlyphElement() [1/3]

HPS.ImageGlyphElement.ImageGlyphElement ( )
inline

The default constructor creates an empty ImageGlyphElement object.

◆ ImageGlyphElement() [2/3]

HPS.ImageGlyphElement.ImageGlyphElement ( HPS.GlyphElement  in_that)
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_thatThe source GlyphElement to copy.

◆ ImageGlyphElement() [3/3]

HPS.ImageGlyphElement.ImageGlyphElement ( HPS.ImageGlyphElement  in_that)
inline

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

Parameters
in_thatThe source ImageGlyphElement to copy.

Member Function Documentation

◆ 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_filterIf 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_colorIf 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_scaleIf 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_filterIf 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_offsetThe x offset of the source image. The default is 0.5.
in_y_offsetThe 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_rotationThe 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_scaleThe x scaling of the source image. The default is 1.0.
in_y_scaleThe 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_nameThe 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_filterIf 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_colorIf 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_scaleIf 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_filterIf 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_offsetThe x offset of the source image.
out_y_offsetThe 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_rotationThe 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_scaleThe x scaling of the source image.
out_y_scaleThe 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_nameUTF8-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