The HPS::MarkerAttributeKit class is a user space object, useful for carrying a group attribute settings. More...

#include <hps.h>

Inheritance diagram for HPS::MarkerAttributeKit:

Collaboration diagram for HPS::MarkerAttributeKit:

Public Member Functions
	MarkerAttributeKit ()
	Initializes an empty kit. More...

	MarkerAttributeKit (MarkerAttributeKit const &in_kit)
	The copy constructor creates a new MarkerAttributeKit object that contains the same settings as the source object. More...

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

MarkerAttributeKit &	operator= (MarkerAttributeKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this MarkerAttributeKit thereby avoiding a copy. More...

virtual	~MarkerAttributeKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

void	Set (MarkerAttributeKit const &in_kit)
	Copies all settings from the source MarkerAttributeKit into this object. More...

void	Show (MarkerAttributeKit &out_kit) const
	Copies all settings from this MarkerAttributeKit into the given MarkerAttributeKit. More...

MarkerAttributeKit &	operator= (MarkerAttributeKit const &in_kit)
	Copies the source MarkerAttributeKit into this object. More...

bool	Empty () const
	Indicates whether this object has any values set on it. More...

bool	Equals (MarkerAttributeKit const &in_kit) const
	Check if the source MarkerAttributeKit is equivalent to this object. More...

bool	operator== (MarkerAttributeKit const &in_kit) const
	Check if the source MarkerAttributeKit is equivalent to this object. More...

bool	operator!= (MarkerAttributeKit const &in_kit) const
	Check if the source MarkerAttributeKit is not equivalent to this object. More...

MarkerAttributeKit &	SetSymbol (char const *in_glyph_name)
	Sets the glyph used to represent markers. More...

MarkerAttributeKit &	SetSize (float in_size, Marker::SizeUnits in_units=Marker::SizeUnits::ScaleFactor)
	Sets the size of markers. More...

MarkerAttributeKit &	SetDrawingPreference (Marker::DrawingPreference in_preference)
	Sets the drawing method for markers. More...

MarkerAttributeKit &	UnsetSymbol ()
	Removes the marker symbol setting. More...

MarkerAttributeKit &	UnsetSize ()
	Removes the marker size setting. More...

MarkerAttributeKit &	UnsetDrawingPreference ()
	Removes the drawing preference setting. More...

MarkerAttributeKit &	UnsetEverything ()
	Removes all settings from this object. More...

bool	ShowSymbol (UTF8 &out_glyph_name) const
	Shows the glyph that should be used to draw markers. More...

bool	ShowSize (float &out_size, Marker::SizeUnits &out_units) const
	Shows the size of markers. More...

bool	ShowDrawingPreference (Marker::DrawingPreference &out_preference) const
	Shows the drawing method for markers. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static MarkerAttributeKit	GetDefault ()
	Creates a MarkerAttributeKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::MarkerAttributeKit

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_kit The 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_that An rvalue reference to a MarkerAttributeKit to take the impl from.

◆ ~MarkerAttributeKit()

virtual HPS::MarkerAttributeKit::~MarkerAttributeKit ( )

virtual

Destroy this kit.

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ 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_kit The source MarkerAttributeKit to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

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

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::MarkerAttributeKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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.

◆ 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_that An 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_kit The 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_kit The source MarkerAttributeKit to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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.

◆ 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_preference The preferred drawing style.

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_size	The size for markers.
in_units	The 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_name A 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_kit The 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_preference The preferred drawing style. 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.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

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

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

Member Data Documentation

◆ staticType

const HPS::Type HPS::MarkerAttributeKit::staticType = HPS::Type::MarkerAttributeKit

static

The documentation for this class was generated from the following file:

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MarkerAttributeKit() [1/3]

◆ MarkerAttributeKit() [2/3]

◆ MarkerAttributeKit() [3/3]

◆ ~MarkerAttributeKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetDrawingPreference()

◆ SetSize()

◆ SetSymbol()

◆ Show()

◆ ShowDrawingPreference()

◆ ShowSize()

◆ ShowSymbol()

◆ Type()

◆ UnsetDrawingPreference()

◆ UnsetEverything()

◆ UnsetSize()

◆ UnsetSymbol()

Member Data Documentation

◆ staticType