EllipseGlyphElement

class EllipseGlyphElement : public HPS::GlyphElement

The EllipseGlyphElement class is a user space object. It is used to add ellipse elements to glyphs.

Public Functions

EllipseGlyphElement()

The default constructor creates an empty EllipseGlyphElement object.

EllipseGlyphElement(EllipseGlyphElement &&in_that)

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

Parameters:

in_that – An rvalue reference to an EllipseGlyphElement to take the impl from.

EllipseGlyphElement(EllipseGlyphElement const &in_that)

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

Parameters:

in_that – The source EllipseGlyphElement to copy.

EllipseGlyphElement(GlyphElement const &in_that)

This constructor creates a EllipseGlyphElement 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 an ellipse glyph element. Otherwise the copy will fail and the resulting EllipseGlyphElement will be invalid.

Parameters:

in_that – The source GlyphElement to copy.

EllipseGlyphElement(GlyphPoint const &in_lower_left, GlyphPoint const &in_upper_right)

This constructor creates a EllipseGlyphElement with the lower left and upper right points for the bounding box which circumscribes the ellipse.

Parameters:

• in_lower_left – The lower left point for the bounding box which circumscribes the ellipse.

• in_upper_right – The upper right point for the bounding box which circumscribes the ellipse.

inline virtual HPS::Type ObjectType() const

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.

EllipseGlyphElement &operator=(EllipseGlyphElement &&in_that)

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

Parameters:

in_that – An rvalue reference to an EllipseGlyphElement to take the impl from.

Returns:

A reference to this EllipseGlyphElement.

void SetLowerLeft(GlyphPoint const &in_point)

Sets the lower left point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters:

in_point – The lower left point for the bounding box which circumscribes the ellipse.

void SetPoints(GlyphPoint const &in_lower_left, GlyphPoint const &in_upper_right)

Sets the lower left and upper right points for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters:

• in_lower_left – The lower left point for the bounding box which circumscribes the ellipse.

• in_upper_right – The upper right point for the bounding box which circumscribes the ellipse.

void SetUpperRight(GlyphPoint const &in_point)

Sets the upper right point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters:

in_point – The upper right point for the bounding box which circumscribes the ellipse.

bool ShowLowerLeft(GlyphPoint &out_point) const

Shows the lower left point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters:

out_point – The lower left point for the bounding box which circumscribes the ellipse.

Returns:

true if a lower left point was set, false otherwise.

bool ShowUpperRight(GlyphPoint &out_point) const

Shows the upper right point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters:

out_point – The upper right point for the bounding box which circumscribes the ellipse.

Returns:

true if an upper right point was set, false otherwise.

~EllipseGlyphElement()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::EllipseGlyphElement