#include <hps.h>

Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
Detailed Description
The HPS::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 HPS::MarkerAttributeControl.
Constructor & Destructor Documentation
|
explicit |
Initializes a control tied to the segment in_seg.
HPS::MarkerAttributeControl::MarkerAttributeControl | ( | MarkerAttributeControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS::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.
- Parameters
-
in_that An rvalue reference to a MarkerAttributeControl to take the impl from.
HPS::MarkerAttributeControl::~MarkerAttributeControl | ( | ) |
Releases a reference to the database object this control is tied to.
Member Function Documentation
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Control.
MarkerAttributeControl& HPS::MarkerAttributeControl::operator= | ( | MarkerAttributeControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this MarkerAttributeControl thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a MarkerAttributeControl to take the impl from.
- Returns
- A reference to this MarkerAttributeControl.
MarkerAttributeControl& HPS::MarkerAttributeControl::operator= | ( | MarkerAttributeControl const & | in_that | ) |
Share the underlying smart-pointer of the MarkerAttributeControl source.
- Parameters
-
in_that The MarkerAttributeControl source of the assignment.
- Returns
- A reference to this MarkerAttributeControl.
MarkerAttributeControl& HPS::MarkerAttributeControl::SetSize | ( | float | in_size, |
Marker::SizeUnits | in_units = Marker::SizeUnits::ScaleFactor |
||
) |
Sets the size of markers.
- Parameters
-
in_size The size for markers. in_units The units of the size for markers.
- Returns
- A reference to this object.
MarkerAttributeControl& HPS::MarkerAttributeControl::SetSymbol | ( | char const * | in_glyph_name | ) |
Sets the glyph that should be used to draw markers.
- Parameters
-
in_glyph_name A UTF8 encoded name of a glyph, defined in an accessible portfolio.
- Returns
- A reference to this object.
bool HPS::MarkerAttributeControl::ShowSize | ( | float & | out_size, |
Marker::SizeUnits & | out_units | ||
) | const |
Shows the size of markers.
- Parameters
-
out_size The size for markers. out_units The units of the size for markers.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::MarkerAttributeControl::ShowSymbol | ( | UTF8 & | out_glyph_name | ) | const |
Shows the glyph that should be used to draw markers.
- Parameters
-
out_glyph_name A UTF8 encoded name of a glyph, defined in an accessible portfolio.
- Returns
- true if the setting is valid, false otherwise.
|
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS::Control.
MarkerAttributeControl& HPS::MarkerAttributeControl::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 MarkerAttributeKit::GetDefault().
- Returns
- A reference to this object.
MarkerAttributeControl& HPS::MarkerAttributeControl::UnsetSize | ( | ) |
Removes the marker size setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MarkerAttributeKit::GetDefault().
- Returns
- A reference to this object.
MarkerAttributeControl& HPS::MarkerAttributeControl::UnsetSymbol | ( | ) |
Removes the marker symbol setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MarkerAttributeKit::GetDefault().
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/hps.h