MarkerAttributeKit

class HPS::MarkerAttributeKit : public HPS::Kit 

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.

Public Functions

virtual bool Empty() const

Indicates whether this object has any values set on it.

Returns: true if no values are set on this object, false otherwise.

bool 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.

MarkerAttributeKit(): Initializes an empty kit.

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.

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.

inline virtual HPS::Type ObjectType() const

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.

bool 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 &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 &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 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 Set(MarkerAttributeKit const &in_kit)

Copies all settings from the source MarkerAttributeKit into this object.

Parameters: in_kit – The source MarkerAttributeKit to copy.

MarkerAttributeKit &SetDrawingPreference(Marker::DrawingPreference in_preference)

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.

MarkerAttributeKit &SetGlyphRotation(float in_rotation)

Sets the glyph rotation option.

Parameters: in_rotation – The rotation for glyphs.
Returns: A reference to this object.

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 &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 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 ShowDrawingPreference(Marker::DrawingPreference &out_preference) const

Shows the drawing method for markers.

Parameters: out_preference – The preferred drawing style. return true if the setting is valid, false otherwise.

bool 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.

bool 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 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 &UnsetDrawingPreference()

Removes the drawing preference setting

Returns: A reference to this object.

MarkerAttributeKit &UnsetEverything()

Removes all settings from this object.

Returns: A reference to this object.

MarkerAttributeKit &UnsetGlyphRotation()

Removes the glyph rotation setting

Returns: A reference to this object.

MarkerAttributeKit &UnsetSize()

Removes the marker size setting.

Returns: A reference to this object.

MarkerAttributeKit &UnsetSymbol()

Removes the marker symbol setting.

Returns: A reference to this object.

virtual ~MarkerAttributeKit(): Destroy this kit.

Public Static Functions

static MarkerAttributeKit 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.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::MarkerAttributeKit