#include <hps.h>

Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::LineAttributeControl |
![]() | |
static const HPS::Type | staticType = HPS::Type::Control |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
Detailed Description
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.
Constructor & Destructor Documentation
◆ LineAttributeControl() [1/3]
|
explicit |
Initializes a control tied to the segment in_seg.
◆ LineAttributeControl() [2/3]
HPS::LineAttributeControl::LineAttributeControl | ( | LineAttributeControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
◆ LineAttributeControl() [3/3]
HPS::LineAttributeControl::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()
HPS::LineAttributeControl::~LineAttributeControl | ( | ) |
Releases a reference to the database object this control is tied to.
Member Function Documentation
◆ ObjectType()
|
inlinevirtual |
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.
Reimplemented from HPS::Control.
◆ operator=() [1/2]
LineAttributeControl& HPS::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.
◆ operator=() [2/2]
LineAttributeControl& HPS::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.
◆ SetPattern() [1/2]
LineAttributeControl& HPS::LineAttributeControl::SetPattern | ( | char const * | in_pattern | ) |
Specifies the pattern of lines.
- Parameters
-
in_pattern The name of a line pattern, defined in a portfolio that is accessible.
- Returns
- A reference to this object.
- See also
- Programming Guide: Line Patterns
◆ SetPattern() [2/2]
LineAttributeControl& HPS::LineAttributeControl::SetPattern | ( | char const * | in_pattern, |
LinePatternOptionsKit const & | in_options | ||
) |
Specifies the pattern of lines.
- 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.
- See also
- Programming Guide: Line Patterns
◆ SetWeight()
LineAttributeControl& HPS::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.
◆ ShowPattern()
bool HPS::LineAttributeControl::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.
◆ ShowWeight()
bool HPS::LineAttributeControl::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.
◆ Type()
|
inlinevirtual |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.
- Warning
- This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
- Returns
- The true type of the object in question.
Reimplemented from HPS::Control.
◆ UnsetEverything()
LineAttributeControl& HPS::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.
◆ UnsetPattern()
LineAttributeControl& HPS::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.
◆ UnsetWeight()
LineAttributeControl& HPS::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.
The documentation for this class was generated from the following file:
- include/hps.h