REFERENCE MANUAL
#include <hps.h>
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
The 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 LineAttributeControl.
|
explicit |
Initializes a control tied to the segment in_seg.
LineAttributeControl::LineAttributeControl | ( | LineAttributeControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
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.
in_that | An rvalue reference to a LineAttributeControl to take the impl from. |
LineAttributeControl::~LineAttributeControl | ( | ) |
Releases a reference to the database object this control is tied to.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Control.
LineAttributeControl& LineAttributeControl::operator= | ( | LineAttributeControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this LineAttributeControl thereby avoiding a copy.
in_that | An rvalue reference to a LineAttributeControl to take the impl from. |
LineAttributeControl& LineAttributeControl::operator= | ( | LineAttributeControl const & | in_that | ) |
Share the smart-pointer.
LineAttributeControl& LineAttributeControl::SetPattern | ( | char const * | in_pattern | ) |
Specifies the pattern of lines.
in_pattern | The name of a line pattern, defined in a portfolio that is accessible. |
LineAttributeControl& LineAttributeControl::SetPattern | ( | char const * | in_pattern, |
LinePatternOptionsKit const & | in_options | ||
) |
Specifies the pattern of lines.
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. |
LineAttributeControl& LineAttributeControl::SetWeight | ( | float | in_weight, |
Line::SizeUnits | in_units = Line::SizeUnits::ScaleFactor |
||
) |
Sets the weight of lines.
in_weight | The weight value for lines. |
in_units | The units applied to in_weight. |
bool LineAttributeControl::ShowPattern | ( | UTF8 & | out_pattern, |
LinePatternOptionsKit & | out_options | ||
) | const |
Shows the pattern used to draw lines.
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. |
bool LineAttributeControl::ShowWeight | ( | float & | out_weight, |
Line::SizeUnits & | out_units | ||
) | const |
Shows the weight of lines.
out_weight | The weight value for lines. |
out_units | The units applied to in_weight. |
LineAttributeControl& LineAttributeControl::UnsetEverything | ( | ) |
Removes all settings from this object.
LineAttributeControl& LineAttributeControl::UnsetPattern | ( | ) |
Removes the line pattern setting for lines.
LineAttributeControl& LineAttributeControl::UnsetWeight | ( | ) |
Removes the weight setting for lines.