#include <hps.h>
The MarkerAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling MarkerAttributeKit::GetDefault() will return a kit with values found in this table.
MarkerAttributeKit::MarkerAttributeKit |
( |
| ) |
|
Initializes an empty 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. |
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
-
virtual MarkerAttributeKit::~MarkerAttributeKit |
( |
| ) |
|
|
virtual |
bool 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 Object.
Check if the source MarkerAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
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.
Type MarkerAttributeKit::ObjectType |
( |
| ) |
const |
|
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 Object.
Check if the source MarkerAttributeKit is not equivalent to this object.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
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.
Copies the source MarkerAttributeKit into this object.
- Parameters
-
- Returns
- A reference to this object.
Check if the source MarkerAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
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.
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.
bool 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 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.
Removes all settings from this object.
- Returns
- A reference to this object.
Removes the marker size setting.
- Returns
- A reference to this object.
Removes the marker symbol setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: