EllipseShapeElement

class HPS::EllipseShapeElement : public HPS::ShapeElement

The EllipseShapeElement class is a user space object. It is used to define ellipse elements to make up shapes for text backgrounds.

Public Functions

EllipseShapeElement()

The default constructor creates an empty EllipseShapeElement object.

EllipseShapeElement(EllipseShapeElement &&in_that)

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

Parameters

in_that – An rvalue reference to a EllipseShapeElement to take the impl from.

EllipseShapeElement(EllipseShapeElement const &in_that)

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

Parameters

in_that – The source EllipseShapeElement to copy.

EllipseShapeElement(ShapeElement const &in_that)

This constructor creates a EllipseShapeElement object that contains the same settings as the source ShapeElement. The copy will only be successful if the source shape element is really an upcast of an ellipse shape element. Otherwise the copy will fail and the resulting EllipseShapeElement will be invalid.

Parameters

in_that – The source ShapeElement to copy.

explicit EllipseShapeElement(ShapePoint const &in_center, ShapePoint const &in_major_axis_point, ShapePoint const &in_minor_axis_point)

This constructor creates a EllipseShapeElement with the specified point array.

Parameters

• in_center – The center of the ellipse.

• in_major_axis_point – A point defining the major axis of the ellipse

• in_minor_axis_point – A point defining the minor axis of 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.

EllipseShapeElement &operator=(EllipseShapeElement &&in_that)

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

Parameters

in_that – An rvalue reference to a EllipseShapeElement to take the impl from.

Returns

A reference to this EllipseShapeElement.

EllipseShapeElement &SetCenter(ShapePoint const &in_center)

Sets the points for this EllipseShapeElement.

Parameters

in_center – The center point of the ellipse.

EllipseShapeElement &SetMajorAxisPoint(ShapePoint const &in_major_axis_point)

Sets a point on the major axis for this EllipseShapeElement.

Parameters

in_major_axis_point – The point on the major axis of the ellipse.

EllipseShapeElement &SetMinorAxisPoint(ShapePoint const &in_minor_axis_point)

Sets a point on the minor axis for this EllipseShapeElement.

Parameters

in_minor_axis_point – The point on the minor axis of the ellipse.

bool ShowCenter(ShapePoint &out_center) const

Shows the center point for this EllipseShapeElement.

Parameters

out_center – The center point for the ellipse.

Returns

true if a center point was set, false otherwise.

bool ShowMajorAxisPoint(ShapePoint &out_major_axis_point) const

Shows the major axis point for this EllipseShapeElement.

Parameters

out_major_axis_point – The major axis point for the ellipse.

Returns

true if a major axis point was set, false otherwise.

bool ShowMinorAxisPoint(ShapePoint &out_minor_axis_point) const

Shows the minor axis point for this EllipseShapeElement.

Parameters

out_minor_axis_point – The minor axis point for the ellipse.

Returns

true if a minor axis point was set, false otherwise.

~EllipseShapeElement()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::EllipseShapeElement