MarkerKit

class HPS::MarkerKit : public HPS::Kit 

The MarkerKit class is a user space object. It is a kit analog to a MarkerKey.

Public Functions

void Consume(MarkerKit &in_kit)

Copies the source MarkerKit into this MarkerKit and resets the source kit.

Parameters: in_kit – The source LineKit to consume.

virtual bool Empty() const

Indicates whether this MarkerKit has any values set on it.

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

bool Equals(MarkerKit const &in_kit) const

Check if the source MarkerKit is equivalent to this MarkerKit.

Parameters: in_kit – The source MarkerKit to compare to this MarkerKit.
Returns: true if the objects are equivalent, false otherwise.

MarkerKit(): The default constructor creates an empty MarkerKit object.

MarkerKit(MarkerKit &&in_that)

The move constructor creates a MarkerKit by transferring the underlying impl of the rvalue reference to this MarkerKit thereby avoiding a copy and allocation.

Parameters: in_that – An rvalue reference to a MarkerKit to take the impl from.

MarkerKit(MarkerKit const &in_kit)

The copy constructor creates a new MarkerKit object that contains the same settings as the source MarkerKit.

Parameters: in_kit – The source MarkerKit 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!=(MarkerKit const &in_kit) const

Check if the source MarkerKit is not equivalent to this MarkerKit.

Parameters: in_kit – The source MarkerKit to compare to this MarkerKit.
Returns: true if the objects are not equivalent, false otherwise.

MarkerKit &operator=(MarkerKit &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this MarkerKit thereby avoiding a copy.

Parameters: in_that – An rvalue reference to a MarkerKit to take the impl from.
Returns: A reference to this MarkerKit.

MarkerKit &operator=(MarkerKit const &in_kit)

Copies the source MarkerKit into this MarkerKit.

Parameters: in_kit – The source MarkerKit to copy.
Returns: A reference to this MarkerKit.

bool operator==(MarkerKit const &in_kit) const

Check if the source MarkerKit is equivalent to this MarkerKit.

Parameters: in_kit – The source MarkerKit to compare to this MarkerKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(MarkerKit const &in_kit)

Copies the source MarkerKit into this MarkerKit.

Parameters: in_kit – The source MarkerKit to copy.

MarkerKit &SetPoint(Point const &in_point)

Sets the point for this MarkerKit.

Parameters: in_point – The point for this MarkerKit.
Returns: A reference to this MarkerKit.

MarkerKit &SetPriority(int in_priority)

Assigns a specific drawing priority value to the MarkerKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.

See: SubwindowKit::SetPriority()
See: SubwindowKit::SetRenderingAlgorithm()

Parameters: in_priority – The drawing priority, higher priority items are drawn on top of lower priority items.
Returns: A reference to this object.

MarkerKit &SetUserData(intptr_t in_index, ByteArray const &in_data)

Sets user data on this kit.

Parameters

in_index – The index of the user data to set.
in_data – The bytes of user data to set.

Returns

A reference to this kit.

MarkerKit &SetUserData(intptr_t in_index, size_t in_bytes, byte const in_data[])

Sets user data on this kit.

Parameters

in_index – The index of the user data to set.
in_bytes – The number of bytes of user data to set.
in_data – The bytes of user data to set.

Returns

A reference to this kit.

MarkerKit &SetUserData(IntPtrTArray const &in_indices, ByteArrayArray const &in_data)

Sets user data on this kit.

Parameters

in_indices – An array of user data indices to set.
in_data – An array of bytes of user data to set.

Returns

A reference to this kit.

void Show(MarkerKit &out_kit) const

Copies this MarkerKit into the given MarkerKit.

Parameters: out_kit – The MarkerKit to populate with the contents of this MarkerKit.

bool ShowPoint(HPS::Point &out_point) const

Shows the point for this MarkerKit.

Parameters: out_point – The point for this MarkerKit.
Returns: true if a point was set, false otherwise.

bool ShowPriority(int &out_priority) const

Shows the drawing priority.

Parameters: out_priority – The drawing priority, higher priority items are drawn on top of lower priority items.
Returns: true if the setting is valid, false otherwise.

bool ShowUserData(intptr_t in_index, ByteArray &out_data) const

Shows the user data at a given index for this kit.

Parameters

in_index – The index of the user data to show.
out_data – The user data at the given index.

Returns

true if there is user data at the given index, false otherwise.

bool ShowUserData(IntPtrTArray &out_indices, ByteArrayArray &out_data) const

Shows all user data for this kit.

Parameters

out_indices – An array of all user data indices set on this kit.
out_data – An array of all user data set on this kit.

Returns

true if there is user data on this kit, false otherwise.

size_t ShowUserDataCount() const: Get the number of user data indices set on this kit.

bool ShowUserDataIndices(IntPtrTArray &out_indices) const

Shows the indices of all user data set on this kit.

Parameters: out_indices – The user data indices set on this kit.
Returns: The number of user data indices set on this kit.

MarkerKit &UnsetAllUserData()

Removes all user data from this kit.

Returns: A reference to this kit.

MarkerKit &UnsetEverything()

Removes all settings from the MarkerKit.

Returns: A reference to this MarkerKit.

MarkerKit &UnsetPoint()

Removes the point for the MarkerKit.

Returns: A reference to this MarkerKit.

MarkerKit &UnsetPriority()

Removes a drawing priority setting.

Returns: A reference to this object.

MarkerKit &UnsetUserData(intptr_t in_index)

Removes the user data at the given index from this kit.

Parameters: in_index – The index of the user data to remove.
Returns: A reference to this kit.

MarkerKit &UnsetUserData(IntPtrTArray const &in_indices)

Removes the user data at the given indices from this kit.

Parameters: in_indices – The indices of the user data to remove.
Returns: A reference to this kit.

MarkerKit &UnsetUserData(size_t in_count, intptr_t const in_indices[])

Removes the user data at the given indices from this kit.

Parameters

in_count – The size of the following array.
in_indices – The indices of the user data to remove.

Returns

A reference to this kit.

virtual ~MarkerKit()

Public Static Attributes

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