PolygonShapeElement

class PolygonShapeElement : public HPS::ShapeElement

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

Public Functions

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.

PolygonShapeElement &operator=(PolygonShapeElement &&in_that)

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

Parameters:

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

Returns:

A reference to this PolygonShapeElement.

PolygonShapeElement()

The default constructor creates an empty PolygonShapeElement object.

PolygonShapeElement(PolygonShapeElement &&in_that)

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

Parameters:

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

PolygonShapeElement(PolygonShapeElement const &in_that)

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

Parameters:

in_that – The source PolygonShapeElement to copy.

PolygonShapeElement(ShapeElement const &in_that)

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

Parameters:

in_that – The source ShapeElement to copy.

explicit PolygonShapeElement(ShapePointArray const &in_points)

This constructor creates a PolygonShapeElement with the specified point array.

Parameters:

in_points – The points for the polygon.

PolygonShapeElement(size_t in_count, ShapePoint const in_points[])

This constructor creates a PolygonShapeElement with the specified point array.

Parameters:

  • in_count – Size of the following array.

  • in_points – The points for the line.

PolygonShapeElement &SetPoints(ShapePointArray const &in_points)

Sets the points for this PolygonShapeElement.

Parameters:

in_points – The points for the polygon.

PolygonShapeElement &SetPoints(size_t in_count, ShapePoint const in_points[])

Sets the points for this PolygonShapeElement.

Parameters:

  • in_count – Size of the following array.

  • in_points – The points for the polygon.

bool ShowPoints(ShapePointArray &out_points) const

Shows the points for this PolygonShapeElement.

Parameters:

out_points – The points for the polygon.

Returns:

true if points were set, false otherwise.

~PolygonShapeElement()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::PolygonShapeElement