# LineAttributeControl

class LineAttributeControl : public HPS::Control

  The HPS::LineAttributeControl class is a smart pointer that is tied to a database object. This control allows you to manipulate the weight and pattern of lines and polylines.

  This table lists default values for the various segment attributes accessible from HPS::LineAttributeControl.

  Public Functions

  LineAttributeControl(LineAttributeControl &&in_that)

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

    Parameters:

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

  LineAttributeControl(LineAttributeControl const &in_that)

    Initializes a control tied to the same object as in_that.

  explicit LineAttributeControl(SegmentKey &in_seg)

    Initializes a control tied to the segment in_seg.

  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.

  LineAttributeControl &operator=(LineAttributeControl &&in_that)

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

    Parameters:

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

    Returns:

      A reference to this LineAttributeControl.

  LineAttributeControl &operator=(LineAttributeControl const &in_that)

    Share the underlying smart-pointer of the LineAttributeControl source.

    Parameters:

      in_that – The LineAttributeControl source of the assignment.

    Returns:

      A reference to this LineAttributeControl.

  LineAttributeControl &SetPattern(char const *in_pattern)

    Specifies the pattern of lines.

    See also

    Programming Guide: Line Patterns

    Parameters:

      in_pattern – The name of a line pattern, defined in a portfolio that is accessible.

    Returns:

      A reference to this object.

  LineAttributeControl &SetPattern(char const *in_pattern, LinePatternOptionsKit const &in_options)

    Specifies the pattern of lines.

    See also

    Programming Guide: Line Patterns

    Parameters:

      - in_pattern – The name of a line pattern, defined in a portfolio that is accessible.

      - in_options – A set of options that modify how the named line pattern is applied.

    Returns:

      A reference to this object.

  LineAttributeControl &SetWeight(float in_weight, Line::SizeUnits in_units = Line::SizeUnits::ScaleFactor)

    Sets the weight of lines.

    Parameters:

      - in_weight – The weight value for lines.

      - in_units – The units applied to in_weight.

    Returns:

      A reference to this object.

  bool ShowPattern(UTF8 &out_pattern, LinePatternOptionsKit &out_options) const

    Shows the pattern used to draw lines.

    Parameters:

      - out_pattern – The name of a line pattern, defined in a portfolio that is accessible.

      - out_options – A set of options that modify how the named line pattern is applied.

    Returns:

      true if the setting is valid, false otherwise.

  bool ShowWeight(float &out_weight, Line::SizeUnits &out_units) const

    Shows the weight of lines.

    Parameters:

      - out_weight – The weight value for lines.

      - out_units – The units applied to in_weight.

    Returns:

      true if the setting is valid, false otherwise.

  LineAttributeControl &UnsetEverything()

    Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by LineAttributeKit::GetDefault().

    Returns:

      A reference to this object.

  LineAttributeControl &UnsetPattern()

    Removes the line pattern setting for lines. If the control is attached to a WindowKey this function restores the default value of this setting as specified by LineAttributeKit::GetDefault().

    Returns:

      A reference to this object.

  LineAttributeControl &UnsetWeight()

    Removes the weight setting for lines. If the control is attached to a WindowKey this function restores the default value of this setting as specified by LineAttributeKit::GetDefault().

    Returns:

      A reference to this object.

  ~LineAttributeControl()

    Releases a reference to the database object this control is tied to.

  Public Static Attributes

  static const HPS::Type staticType = HPS::Type::LineAttributeControl

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