#include <hps.h>

Inheritance diagram for HPS::MarkerAttributeKit:
HPS::Kit HPS::Object

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
 
MarkerAttributeKitoperator= (MarkerAttributeKit &&in_that)
 
MarkerAttributeKitoperator= (MarkerAttributeKit const &in_kit)
 
bool operator== (MarkerAttributeKit const &in_kit) const
 
void Set (MarkerAttributeKit const &in_kit)
 
MarkerAttributeKitSetDrawingPreference (Marker::DrawingPreference in_preference)
 
MarkerAttributeKitSetGlyphRotation (float in_rotation)
 
MarkerAttributeKitSetSize (float in_size, Marker::SizeUnits in_units=Marker::SizeUnits::ScaleFactor)
 
MarkerAttributeKitSetSymbol (char const *in_glyph_name)
 
void Show (MarkerAttributeKit &out_kit) const
 
bool ShowDrawingPreference (Marker::DrawingPreference &out_preference) const
 
bool ShowGlyphRotation (float &out_rotation) const
 
bool ShowSize (float &out_size, Marker::SizeUnits &out_units) const
 
bool ShowSymbol (UTF8 &out_glyph_name) const
 
MarkerAttributeKitUnsetDrawingPreference ()
 
MarkerAttributeKitUnsetEverything ()
 
MarkerAttributeKitUnsetGlyphRotation ()
 
MarkerAttributeKitUnsetSize ()
 
MarkerAttributeKitUnsetSymbol ()
 
virtual ~MarkerAttributeKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static MarkerAttributeKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::MarkerAttributeKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

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

◆ MarkerAttributeKit() [1/3]

HPS::MarkerAttributeKit::MarkerAttributeKit ( )

Initializes an empty kit.

◆ MarkerAttributeKit() [2/3]

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_kitThe source object to copy.

◆ MarkerAttributeKit() [3/3]

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_thatAn rvalue reference to a MarkerAttributeKit to take the impl from.

◆ ~MarkerAttributeKit()

virtual HPS::MarkerAttributeKit::~MarkerAttributeKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ 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()

bool HPS::MarkerAttributeKit::Equals ( MarkerAttributeKit const &  in_kit) const

Check if the source MarkerAttributeKit is equivalent to this object.

Parameters
in_kitThe source MarkerAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static MarkerAttributeKit HPS::MarkerAttributeKit::GetDefault ( )
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.

◆ 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!=()

bool HPS::MarkerAttributeKit::operator!= ( MarkerAttributeKit const &  in_kit) const

Check if the source MarkerAttributeKit is not equivalent to this object.

Parameters
in_kitThe source MarkerAttributeKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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_thatAn rvalue reference to a MarkerAttributeKit to take the impl from.
Returns
A reference to this MarkerAttributeKit.

◆ operator=() [2/2]

MarkerAttributeKit& HPS::MarkerAttributeKit::operator= ( MarkerAttributeKit const &  in_kit)

Copies the source MarkerAttributeKit into this object.

Parameters
in_kitThe source MarkerAttributeKit to copy.
Returns
A reference to this object.

◆ operator==()

bool HPS::MarkerAttributeKit::operator== ( MarkerAttributeKit const &  in_kit) const

Check if the source MarkerAttributeKit is equivalent to this object.

Parameters
in_kitThe source MarkerAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::MarkerAttributeKit::Set ( MarkerAttributeKit const &  in_kit)

Copies all settings from the source MarkerAttributeKit into this object.

Parameters
in_kitThe source MarkerAttributeKit to copy.

◆ SetDrawingPreference()

MarkerAttributeKit& HPS::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_preferenceThe preferred drawing style.
Returns
A reference to this object.

◆ SetGlyphRotation()

MarkerAttributeKit& HPS::MarkerAttributeKit::SetGlyphRotation ( float  in_rotation)

Sets the glyph rotation option.

Parameters
in_rotationThe rotation for glyphs.
Returns
A reference to this object.

◆ SetSize()

MarkerAttributeKit& HPS::MarkerAttributeKit::SetSize ( float  in_size,
Marker::SizeUnits  in_units = Marker::SizeUnits::ScaleFactor 
)

Sets the size of markers.

Parameters
in_sizeThe size for markers.
in_unitsThe units of the size for markers.
Returns
A reference to this object.

◆ SetSymbol()

MarkerAttributeKit& HPS::MarkerAttributeKit::SetSymbol ( char const *  in_glyph_name)

Sets the glyph used to represent markers.

Parameters
in_glyph_nameA UTF8 encoded name of a glyph, defined in an accessible portfolio.
Returns
A reference to this object.

◆ Show()

void HPS::MarkerAttributeKit::Show ( MarkerAttributeKit out_kit) const

Copies all settings from this MarkerAttributeKit into the given MarkerAttributeKit.

Parameters
out_kitThe MarkerAttributeKit to populate with the contents of this object.

◆ ShowDrawingPreference()

bool HPS::MarkerAttributeKit::ShowDrawingPreference ( Marker::DrawingPreference out_preference) const

Shows the drawing method for markers.

Parameters
out_preferenceThe 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_rotationThe 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_sizeThe size for markers.
out_unitsThe 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_nameA UTF8 encoded name of a glyph, defined in an accessible portfolio.
Returns
true if the setting is valid, false otherwise.

◆ UnsetDrawingPreference()

MarkerAttributeKit& HPS::MarkerAttributeKit::UnsetDrawingPreference ( )

Removes the drawing preference setting

Returns
A reference to this object.

◆ UnsetEverything()

MarkerAttributeKit& HPS::MarkerAttributeKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetGlyphRotation()

MarkerAttributeKit& HPS::MarkerAttributeKit::UnsetGlyphRotation ( )

Removes the glyph rotation setting

Returns
A reference to this object.

◆ UnsetSize()

MarkerAttributeKit& HPS::MarkerAttributeKit::UnsetSize ( )

Removes the marker size setting.

Returns
A reference to this object.

◆ UnsetSymbol()

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: