# CircularArcKey

class CircularArcKey : public HPS::GeometryKey

  The CircularArcKey class is a smart pointer to a database object. It is handle to a circular arc inserted via SegmentKey::InsertCircularArc. A circular arc is the line geometry, as such its visualization will be determined by attributes affecting lines.

  Public Functions

  CircularArcKey()

    The default constructor creates an uninitialized CircularArcKey object. The Type() function will return Type::None.

  CircularArcKey(CircularArcKey &&in_that)

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

    Parameters:

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

  CircularArcKey(CircularArcKey const &in_that)

    The copy constructor creates a CircularArcKey object that shares the underlying smart-pointer of the source CircularArcKey.

    Parameters:

      in_that – The source CircularArcKey to copy.

  explicit CircularArcKey(Key const &in_that)

    This constructor creates a CircularArcKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a CircularArc key. Otherwise the copy will fail and the resulting CircularArcKey will be invalid.

    Parameters:

      in_key – The source Key to copy.

  void Consume(CircularArcKit &in_kit)

    Completely replaces all settings on this CircularArcKey with those set on the specified kit and resets the kit.

    Parameters:

      in_kit – The kit from which to get the settings to replace on this CircularArcKey.

  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.

  CircularArcKey &operator=(CircularArcKey &&in_that)

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

    Parameters:

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

    Returns:

      A reference to this CircularArcKey.

  CircularArcKey &operator=(CircularArcKey const &in_that)

    Associate this CircularArcKey with the same underlying impl as the source CircularArcKey.

    Parameters:

      in_that – The source CircularArcKey for the assignment.

    Returns:

      A reference to this CircularArcKey.

  void Set(CircularArcKit const &in_kit)

    Replace those settings on this CircularArcKey with those set on the specified kit.

    Parameters:

      in_kit – The kit from which to get the settings to replace on this CircularArcKey.

  CircularArcKey &SetEnd(Point const &in_end)

    Sets the end point for this CircularArcKey. This is the point on the circumference of the circle at which the circular arc ends.

    Parameters:

      in_end – The end point for this CircularArcKey.

    Returns:

      A reference to this CircularArcKey.

  CircularArcKey &SetMiddle(Point const &in_middle)

    Sets the middle point for this CircularArcKey. This is a point on the circumference of the circle between the start and end points for the circular arc.

    Parameters:

      in_middle – The middle point for this CircularArcKey.

    Returns:

      A reference to this CircularArcKey.

  CircularArcKey &SetStart(Point const &in_start)

    Sets the start point for this CircularArcKey. This is the point on the circumference of the circle at which the circular arc starts.

    Parameters:

      in_start – The start point for this CircularArcKey.

    Returns:

      A reference to this CircularArcKey.

  void Show(CircularArcKit &out_kit) const

    Copy the contents of this CircularArcKey into the specified kit.

    Parameters:

      out_kit – The kit to populate with the contents of this CircularArcKey.

  bool ShowEnd(Point &out_end) const

    Shows the end point for this CircularArcKey.

    Parameters:

      out_end – The end point for this CircularArcKey.

    Returns:

      true if an end point was set, false otherwise.

  bool ShowMiddle(Point &out_middle) const

    Shows the middle point for this CircularArcKey.

    Parameters:

      out_middle – The middle point for this CircularArcKey.

    Returns:

      true if a middle point was set, false otherwise.

  bool ShowStart(Point &out_start) const

    Shows the start point for this CircularArcKey.

    Parameters:

      out_start – The start point for this CircularArcKey.

    Returns:

      true if a start point was set, false otherwise.

  ~CircularArcKey()

  Public Static Attributes

  static const HPS::Type staticType = HPS::Type::CircularArcKey

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