#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::MarkerAttributeKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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.
◆ MarkerAttributeKit() [1/3]
HPS::MarkerAttributeKit::MarkerAttributeKit |
( |
| ) |
|
Initializes an empty kit.
◆ MarkerAttributeKit() [2/3]
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. |
◆ MarkerAttributeKit() [3/3]
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
-
◆ ~MarkerAttributeKit()
virtual HPS::MarkerAttributeKit::~MarkerAttributeKit |
( |
| ) |
|
|
virtual |
◆ Empty()
bool HPS::MarkerAttributeKit::Empty |
( |
| ) |
const |
|
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.
◆ Equals()
Check if the source MarkerAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
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.
◆ ObjectType()
HPS::Type HPS::MarkerAttributeKit::ObjectType |
( |
| ) |
const |
|
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::Kit.
◆ operator!=()
Check if the source MarkerAttributeKit is not equivalent to this object.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this MarkerAttributeKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this MarkerAttributeKit.
◆ operator=() [2/2]
Copies the source MarkerAttributeKit into this object.
- Parameters
-
- Returns
- A reference to this object.
◆ operator==()
Check if the source MarkerAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
◆ SetDrawingPreference()
Sets the drawing method for markers. Fastest will draw at requested size, unless that would incur performance cost. Nicest will anyway.
- Parameters
-
in_preference | The preferred drawing style. |
- Returns
- A reference to this object.
◆ SetGlyphRotation()
Sets the glyph rotation option.
- Parameters
-
in_rotation | The rotation for glyphs. |
- Returns
- A reference to this object.
◆ SetSize()
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.
◆ SetSymbol()
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.
◆ Show()
◆ ShowDrawingPreference()
Shows the drawing method for markers.
- Parameters
-
out_preference | The preferred drawing style. return true if the setting is valid, false otherwise. |
◆ ShowGlyphRotation()
bool HPS::MarkerAttributeKit::ShowGlyphRotation |
( |
float & |
out_rotation | ) |
const |
Shows the glyph rotation option.
- Parameters
-
out_rotation | The glyph rotation option in degrees. return true if the setting is valid, false otherwise. |
◆ ShowSize()
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.
◆ ShowSymbol()
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.
◆ UnsetDrawingPreference()
Removes the drawing preference setting
- Returns
- A reference to this object.
◆ UnsetEverything()
Removes all settings from this object.
- Returns
- A reference to this object.
◆ UnsetGlyphRotation()
Removes the glyph rotation setting
- Returns
- A reference to this object.
◆ UnsetSize()
Removes the marker size setting.
- Returns
- A reference to this object.
◆ UnsetSymbol()
Removes the marker symbol setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: