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 MarkerAttributeControl class is a smart pointer that is tied to a database object. This control allows you to manipulate the marker size and symbol at the segment level.
This table lists default values for the various segment attributes accessible from MarkerAttributeControl.
|
explicit |
Initializes a control tied to the segment in_seg.
MarkerAttributeControl::MarkerAttributeControl | ( | MarkerAttributeControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
MarkerAttributeControl::MarkerAttributeControl | ( | MarkerAttributeControl && | in_that | ) |
The move constructor creates a MarkerAttributeControl by transferring the underlying impl of the rvalue reference to this MarkerAttributeControl thereby avoiding a copy and allocation.
in_that | An rvalue reference to a MarkerAttributeControl to take the impl from. |
MarkerAttributeControl::~MarkerAttributeControl | ( | ) |
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.
MarkerAttributeControl& MarkerAttributeControl::operator= | ( | MarkerAttributeControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this MarkerAttributeControl thereby avoiding a copy.
in_that | An rvalue reference to a MarkerAttributeControl to take the impl from. |
MarkerAttributeControl& MarkerAttributeControl::operator= | ( | MarkerAttributeControl const & | in_that | ) |
Share the smart-pointer.
MarkerAttributeControl& MarkerAttributeControl::SetSize | ( | float | in_size, |
Marker::SizeUnits | in_units = Marker::SizeUnits::ScaleFactor |
||
) |
Sets the size of markers.
in_size | The size for markers. |
in_units | The units of the size for markers. |
MarkerAttributeControl& MarkerAttributeControl::SetSymbol | ( | char const * | in_glyph_name | ) |
Sets the glyph that should be used to draw markers.
in_glyph_name | A UTF8 encoded name of a glyph, defined in an accessible portfolio. |
bool MarkerAttributeControl::ShowSize | ( | float & | out_size, |
Marker::SizeUnits & | out_units | ||
) | const |
Shows the size of markers.
out_size | The size for markers. |
out_units | The units of the size for markers. |
bool MarkerAttributeControl::ShowSymbol | ( | UTF8 & | out_glyph_name | ) | const |
Shows the glyph that should be used to draw markers.
out_glyph_name | A UTF8 encoded name of a glyph, defined in an accessible portfolio. |
MarkerAttributeControl& MarkerAttributeControl::UnsetEverything | ( | ) |
Removes all settings from this object.
MarkerAttributeControl& MarkerAttributeControl::UnsetSize | ( | ) |
Removes the marker size setting.
MarkerAttributeControl& MarkerAttributeControl::UnsetSymbol | ( | ) |
Removes the marker symbol setting.