CircleShapeElement

class HPS::CircleShapeElement : public HPS::ShapeElement

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

Public Functions

CircleShapeElement()

The default constructor creates an empty CircleShapeElement object.

CircleShapeElement(CircleShapeElement &&in_that)

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

Parameters

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

CircleShapeElement(CircleShapeElement const &in_that)

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

Parameters

in_that – The source CircleShapeElement to copy.

CircleShapeElement(ShapeElement const &in_that)

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

Parameters

in_that – The source ShapeElement to copy.

explicit CircleShapeElement(ShapePoint const &in_center, ShapePoint const &in_radius)

This constructor creates a CircleShapeElement with the specified center and radius points.

Parameters

  • in_center – The center point of the circle.

  • in_radius – The radius of the circle.

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.

CircleShapeElement &operator=(CircleShapeElement &&in_that)

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

Parameters

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

Returns

A reference to this CircleShapeElement.

CircleShapeElement &SetCenter(ShapePoint const &in_center)

Sets the center point for this CircleShapeElement.

Parameters

in_center – The center point of the circle.

CircleShapeElement &SetRadius(ShapePoint const &in_radius)

Sets the radius point for this CircleShapeElement.

Parameters

in_radius – The radius point of the circle.

bool ShowCenter(ShapePoint &out_center) const

Shows the center point for this CircleShapeElement.

Parameters

out_center – The center point for the circle.

Returns

true if a center point was set, false otherwise.

bool ShowRadius(ShapePoint &out_radius) const

Shows the radius point for this CircleShapeElement.

Parameters

out_radius – The radius point for the circle.

Returns

true if a radius was set, false otherwise.

~CircleShapeElement()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::CircleShapeElement