HPS::ImageGlyphElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::ImageGlyphElement:
HPS::GlyphElement HPS::Object

Public Member Functions

 ImageGlyphElement ()
 
 ImageGlyphElement (GlyphElement const &in_that)
 
 ImageGlyphElement (ImageGlyphElement const &in_that)
 
 ImageGlyphElement (ImageGlyphElement &&in_that)
 
HPS::Type ObjectType () const
 
ImageGlyphElementoperator= (ImageGlyphElement &&in_that)
 
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 (char const *in_name)
 
bool ShowDecimationFilter (bool &out_filter) const
 
bool ShowFixedColoring (bool &out_fixed_color) const
 
bool ShowFixedScaling (bool &out_fixed_scale) const
 
bool ShowInterpolationFilter (bool &out_filter) const
 
bool ShowOffset (float &out_x_offset, float &out_y_offset) const
 
bool ShowRotation (float &out_rotation) const
 
bool ShowScaling (float &out_x_scale, float &out_y_scale) const
 
bool ShowSource (UTF8 &out_name) const
 
- Public Member Functions inherited from HPS::GlyphElement
bool Equals (GlyphElement const &in_that) const
 
 GlyphElement ()
 
 GlyphElement (GlyphElement const &in_that)
 
 GlyphElement (GlyphElement &&in_that)
 
bool operator!= (GlyphElement const &in_that) const
 
GlyphElementoperator= (GlyphElement &&in_that)
 
GlyphElementoperator= (GlyphElement const &in_that)
 
bool operator== (GlyphElement const &in_that) const
 
void Set (GlyphElement const &in_that)
 
void SetExplicitColor (RGBAColor const &in_color)
 
void SetFill (Glyph::Fill in_fill)
 
void SetIndexedColor (byte in_index)
 
void SetNormalColor ()
 
bool ShowColor (Glyph::ColorSource &out_source, byte &out_index, RGBAColor &out_color) const
 
bool ShowFill (Glyph::Fill &out_fill) const
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ImageGlyphElement
 
- Static Public Attributes inherited from HPS::GlyphElement
static const HPS::Type staticType = HPS::Type::GlyphElement
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The ImageGlyphElement class is a user space object.

Constructor & Destructor Documentation

◆ ImageGlyphElement() [1/4]

HPS::ImageGlyphElement::ImageGlyphElement ( )

The default constructor creates an empty ImageGlyphElement object.

◆ ImageGlyphElement() [2/4]

HPS::ImageGlyphElement::ImageGlyphElement ( GlyphElement const &  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.

Parameters
in_thatThe source GlyphElement to copy.

◆ ImageGlyphElement() [3/4]

HPS::ImageGlyphElement::ImageGlyphElement ( ImageGlyphElement const &  in_that)

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

Parameters
in_thatThe source ImageGlyphElement to copy.

◆ ImageGlyphElement() [4/4]

HPS::ImageGlyphElement::ImageGlyphElement ( ImageGlyphElement &&  in_that)

The move constructor creates an ImageGlyphElement by transferring the underlying impl of the rvalue reference to this ImageGlyphElement thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a ImageGlyphElement to take the impl from.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::ImageGlyphElement::ObjectType ( ) const
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.

◆ operator=()

ImageGlyphElement& HPS::ImageGlyphElement::operator= ( ImageGlyphElement &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this ImageGlyphElement thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a ImageGlyphElement to take the impl from.
Returns
A reference to this LineGlyphElement.

◆ SetDecimationFilter()

void HPS::ImageGlyphElement::SetDecimationFilter ( bool  in_filter)

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)

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)

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)

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 
)

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)

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 
)

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 ( char const *  in_name)

Sets the source image by name for this ImageGlyphElement.

Parameters
in_nameThe name of the source image.

◆ ShowDecimationFilter()

bool HPS::ImageGlyphElement::ShowDecimationFilter ( bool &  out_filter) const

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 ( bool &  out_fixed_color) const

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 ( bool &  out_fixed_scale) const

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 ( bool &  out_filter) const

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 ( float &  out_x_offset,
float &  out_y_offset 
) const

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 ( float &  out_rotation) const

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 ( float &  out_x_scale,
float &  out_y_scale 
) const

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 ( UTF8 out_name) const

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: