EllipticalArcShapeElement

class HPS::EllipticalArcShapeElement : public HPS::ShapeElement

The EllipticalArcShapeElement class is a user space object. It is used to define elliptical arc elements to make up shapes for text backgrounds.

Public Functions

EllipticalArcShapeElement()

The default constructor creates an empty EllipticalArcShapeElement object.

EllipticalArcShapeElement(EllipticalArcShapeElement &&in_that)

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

Parameters

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

EllipticalArcShapeElement(EllipticalArcShapeElement const &in_that)

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

Parameters

in_that – The source EllipticalArcShapeElement to copy.

EllipticalArcShapeElement(ShapeElement const &in_that)

This constructor creates a EllipticalArcShapeElement 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 elliptical arc shape element. Otherwise the copy will fail and the resulting EllipticalArcShapeElement will be invalid.

Parameters

in_that – The source ShapeElement to copy.

explicit EllipticalArcShapeElement(ShapePoint const &in_center, ShapePoint const &in_major_axis_point, ShapePoint const &in_minor_axis_point, float in_start = 0.0f, float in_end = 360.0f)

This constructor creates a EllipticalArcShapeElement with the specified parameters.

Parameters

  • in_center – The center point of the arc.

  • in_major_axis_point – A point defining the major axis of the arc.

  • in_minor_axis_point – A point defining the minor axis of the arc.

  • in_start – The start of the arc, in degrees.

  • in_end – The end of the arc, in degrees.

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.

EllipticalArcShapeElement &operator=(EllipticalArcShapeElement &&in_that)

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

Parameters

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

Returns

A reference to this EllipticalArcShapeElement.

EllipticalArcShapeElement &SetCenter(ShapePoint const &in_center)

Sets the center point for this EllipticalArcShapeElement.

Parameters

in_center – The center point of the arc.

EllipticalArcShapeElement &SetEnd(float in_end)

Sets the end for this EllipticalArcShapeElement.

Parameters

in_end – The ending point of this arc, expressed in degrees

EllipticalArcShapeElement &SetMajorAxisPoint(ShapePoint const &in_major_axis_point)

Sets the major axis point for this EllipticalArcShapeElement.

Parameters

in_major_axis_point – A point defining the major axis of the arc.

EllipticalArcShapeElement &SetMinorAxisPoint(ShapePoint const &in_minor_axis_point)

Sets the minor axis point for this EllipticalArcShapeElement.

Parameters

in_minor_axis_point – A point defining the minor axis of the arc.

EllipticalArcShapeElement &SetStart(float in_start)

Sets the start for this EllipticalArcShapeElement.

Parameters

in_start – The starting point of this arc, expressed in degrees

bool ShowCenter(ShapePoint &out_center) const

Shows the center point for this EllipticalArcShapeElement.

Parameters

out_center – The center point for the arc.

Returns

true if a center point was set, false otherwise.

bool ShowEnd(float &out_end) const

Shows the end point for this EllipticalArcShapeElement.

Parameters

out_end – The ending point of this arc, expressed in degrees

Returns

true if an end point was set, false otherwise.

bool ShowMajorAxisPoint(ShapePoint &out_major_axis_point) const

Shows the major axis point for this EllipticalArcShapeElement.

Parameters

out_major_axis_point – A point defining the major axis of the arc.

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

Parameters

out_minor_axis_point – A point defining the minor axis of the arc.

Returns

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

bool ShowStart(float &out_start) const

Shows the start point for this EllipticalArcShapeElement.

Parameters

out_start – The starting point of this arc, expressed in degrees

Returns

true if a start point was set, false otherwise.

~EllipticalArcShapeElement()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::EllipticalArcShapeElement