LineShapeElement

class HPS.LineShapeElement : public HPS.ShapeElement

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

Public Functions

override void Dispose ()

LineShapeElement ()

The default constructor creates an empty LineShapeElement object.

LineShapeElement (HPS.LineShapeElement in_that)

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

Param in_that

The source LineShapeElement to copy.

LineShapeElement (HPS.ShapeElement in_that)

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

Param in_that

The source ShapeElement to copy.

LineShapeElement (HPS.ShapePoint in_start, HPS.ShapePoint in_end)

This constructor creates a two-point LineShapeElement with the specified points.

Param in_start

The start of the line.

Param in_end

The end of the line.

LineShapeElement (HPS.ShapePoint[] in_points)

This constructor creates a LineShapeElement with the specified points.

Param in_points

The points making up the line.

override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

HPS.LineShapeElement SetPoints (HPS.ShapePoint[] in_points)

Sets the points for this LineShapeElement.

Param in_points

The points making up the line.

bool ShowPoints (out HPS.ShapePoint[] out_points)

Shows the points for this LineShapeElement.

Param out_points

The points for this line

Return

true if points were set, false otherwise.