#include <hps.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (MarkerAttributeKit const &in_kit) const |
MarkerAttributeKit () | |
MarkerAttributeKit (MarkerAttributeKit const &in_kit) | |
MarkerAttributeKit (MarkerAttributeKit &&in_that) | |
HPS::Type | ObjectType () const |
bool | operator!= (MarkerAttributeKit const &in_kit) const |
MarkerAttributeKit & | operator= (MarkerAttributeKit &&in_that) |
MarkerAttributeKit & | operator= (MarkerAttributeKit const &in_kit) |
bool | operator== (MarkerAttributeKit const &in_kit) const |
void | Set (MarkerAttributeKit const &in_kit) |
MarkerAttributeKit & | SetSize (float in_size, Marker::SizeUnits in_units=Marker::SizeUnits::ScaleFactor) |
MarkerAttributeKit & | SetSymbol (char const *in_glyph_name) |
void | Show (MarkerAttributeKit &out_kit) const |
bool | ShowSize (float &out_size, Marker::SizeUnits &out_units) const |
bool | ShowSymbol (UTF8 &out_glyph_name) const |
MarkerAttributeKit & | UnsetEverything () |
MarkerAttributeKit & | UnsetSize () |
MarkerAttributeKit & | UnsetSymbol () |
virtual | ~MarkerAttributeKit () |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
HPS::Type | Type () const |
Static Public Member Functions | |
static MarkerAttributeKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The HPS::MarkerAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::MarkerAttributeKit::GetDefault() will return a kit with values found in this table.
Constructor & Destructor Documentation
HPS::MarkerAttributeKit::MarkerAttributeKit | ( | ) |
Initializes an empty kit.
HPS::MarkerAttributeKit::MarkerAttributeKit | ( | MarkerAttributeKit const & | in_kit | ) |
The copy constructor creates a new MarkerAttributeKit object that contains the same settings as the source object.
- Parameters
-
in_kit The source object to copy.
HPS::MarkerAttributeKit::MarkerAttributeKit | ( | MarkerAttributeKit && | in_that | ) |
The move constructor creates a MarkerAttributeKit by transferring the underlying impl of the rvalue reference to this MarkerAttributeKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a MarkerAttributeKit to take the impl from.
|
virtual |
Destroy this kit.
Member Function Documentation
|
virtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS::Object.
bool HPS::MarkerAttributeKit::Equals | ( | MarkerAttributeKit const & | in_kit | ) | const |
Check if the source MarkerAttributeKit is equivalent to this object.
- Parameters
-
in_kit The source MarkerAttributeKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
static |
Creates a MarkerAttributeKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A MarkerAttributeKit with the default settings.
|
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::Object.
bool HPS::MarkerAttributeKit::operator!= | ( | MarkerAttributeKit const & | in_kit | ) | const |
Check if the source MarkerAttributeKit is not equivalent to this object.
- Parameters
-
in_kit The source MarkerAttributeKit to compare to this object.
- Returns
- true if the objects are not equivalent, false otherwise.
MarkerAttributeKit& HPS::MarkerAttributeKit::operator= | ( | MarkerAttributeKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this MarkerAttributeKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a MarkerAttributeKit to take the impl from.
- Returns
- A reference to this MarkerAttributeKit.
MarkerAttributeKit& HPS::MarkerAttributeKit::operator= | ( | MarkerAttributeKit const & | in_kit | ) |
Copies the source MarkerAttributeKit into this object.
- Parameters
-
in_kit The source MarkerAttributeKit to copy.
- Returns
- A reference to this object.
bool HPS::MarkerAttributeKit::operator== | ( | MarkerAttributeKit const & | in_kit | ) | const |
Check if the source MarkerAttributeKit is equivalent to this object.
- Parameters
-
in_kit The source MarkerAttributeKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::MarkerAttributeKit::Set | ( | MarkerAttributeKit const & | in_kit | ) |
Copies all settings from the source MarkerAttributeKit into this object.
- Parameters
-
in_kit The source MarkerAttributeKit to copy.
MarkerAttributeKit& HPS::MarkerAttributeKit::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.
MarkerAttributeKit& HPS::MarkerAttributeKit::SetSymbol | ( | char const * | in_glyph_name | ) |
Sets the glyph used to represent markers.
- Parameters
-
in_glyph_name A UTF8 encoded name of a glyph, defined in an accessible portfolio.
- Returns
- A reference to this object.
void HPS::MarkerAttributeKit::Show | ( | MarkerAttributeKit & | out_kit | ) | const |
Copies all settings from this MarkerAttributeKit into the given MarkerAttributeKit.
- Parameters
-
out_kit The MarkerAttributeKit to populate with the contents of this object.
bool HPS::MarkerAttributeKit::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::MarkerAttributeKit::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.
MarkerAttributeKit& HPS::MarkerAttributeKit::UnsetEverything | ( | ) |
Removes all settings from this object.
- Returns
- A reference to this object.
MarkerAttributeKit& HPS::MarkerAttributeKit::UnsetSize | ( | ) |
Removes the marker size setting.
- Returns
- A reference to this object.
MarkerAttributeKit& HPS::MarkerAttributeKit::UnsetSymbol | ( | ) |
Removes the marker symbol setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/hps.h