# CircularArcShapeElement

class `CircularArcShapeElement` : public HPS::ShapeElement

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

  Public Functions

  `CircularArcShapeElement`()

    The default constructor creates an empty CircularArcShapeElement object.

  `CircularArcShapeElement`(CircularArcShapeElement &&in_that)

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

    Parameters: | in_that – An rvalue reference to a CircularArcShapeElement to take the impl from.

  `CircularArcShapeElement`(CircularArcShapeElement const &in_that)

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

    Parameters: | in_that – The source CircularArcShapeElement to copy.

  `CircularArcShapeElement`(ShapeElement const &in_that)

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

    Parameters: | in_that – The source ShapeElement to copy.

  explicit `CircularArcShapeElement`(ShapePoint const &in_start_point, ShapePoint const &in_middle_point, ShapePoint const &in_end_point)

    This constructor creates a CircularArcShapeElement with the specified parameters.

    Parameters: | in_start_point – The start of the arc. in_middle_point – A point between the start and the end point, where the arc passes through in_end_point – The end of the arc.

  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.

  CircularArcShapeElement &`operator=`(CircularArcShapeElement &&in_that)

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

    Parameters: | in_that – An rvalue reference to a CircularArcShapeElement to take the impl from.
    Returns: | A reference to this CircularArcShapeElement.

  CircularArcShapeElement &`SetEndPoint`(ShapePoint const &in_end)

    Sets the end point for this CircularArcShapeElement.

    Parameters: | in_end – The end point of the arc.

  CircularArcShapeElement &`SetMiddlePoint`(ShapePoint const &in_middle)

    Sets the minor axis point for this CircularArcShapeElement.

    Parameters: | in_middle – A point between the start and the end point. The arc passes through this point.

  CircularArcShapeElement &`SetStartPoint`(ShapePoint const &in_start)

    Sets the center point for this CircularArcShapeElement.

    Parameters: | in_start – The start of the arc.

  bool `ShowEndPoint`(ShapePoint &out_end) const

    Shows the end point for this CircularArcShapeElement.

    Parameters: | out_end – The end point of the arc
    Returns: | true if an end point was set, false otherwise.

  bool `ShowMiddlePoint`(ShapePoint &out_middle) const

    Shows the middle point for this CircularArcShapeElement.

    Parameters: | out_middle – A point between the start and the end point. The arc passes through this point.
    Returns: | true if a middle point was set, false otherwise.

  bool `ShowStartPoint`(ShapePoint &out_start) const

    Shows the center point for this CircularArcShapeElement.

    Parameters: | out_start – The start for the arc.
    Returns: | true if a star point was set, false otherwise.

  `~CircularArcShapeElement`()

  Public Static Attributes

  static const HPS::Type `staticType` = HPS::Type::CircularArcShapeElement

Hello I'm HOOPSY!

HOOPSY BETA

Hello I am HOOPSY! your Docs generative AI assistant.

Ask me anything about HOOPS Visualize HPS or choose a sample question below to start a conversation:

Additional info

HOOPSY may store chats to provide and maintain the service according to OpenAI's data policy.

This feature is currently experimental. While we are continually enhancing its performance and quality, the underlying AI model may generate inaccurate or fabricated responses, especially if prompted to do so.

New Conversation
Continue generating