#include <hps.h>
The MarkerKit class is a user space object. It is a kit analog to a MarkerKey.
HPS::MarkerKit::MarkerKit |
( |
| ) |
|
The default constructor creates an empty MarkerKit object.
HPS::MarkerKit::MarkerKit |
( |
MarkerKit const & |
in_kit | ) |
|
The copy constructor creates a new MarkerKit object that contains the same settings as the source MarkerKit.
- Parameters
-
HPS::MarkerKit::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. |
void HPS::MarkerKit::Consume |
( |
MarkerKit & |
in_kit | ) |
|
bool HPS::MarkerKit::Empty |
( |
| ) |
const |
|
virtual |
Indicates whether this MarkerKit has any values set on it.
- Returns
- true if no values are set on this MarkerKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::MarkerKit::Equals |
( |
MarkerKit const & |
in_kit | ) |
const |
Check if the source MarkerKit is equivalent to this MarkerKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
HPS::Type HPS::MarkerKit::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 HPS::Kit.
bool HPS::MarkerKit::operator!= |
( |
MarkerKit const & |
in_kit | ) |
const |
Check if the source MarkerKit is not equivalent to this MarkerKit.
- 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 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.
bool HPS::MarkerKit::operator== |
( |
MarkerKit const & |
in_kit | ) |
const |
Check if the source MarkerKit is equivalent to this MarkerKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::MarkerKit::Set |
( |
MarkerKit const & |
in_kit | ) |
|
MarkerKit& HPS::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.
- Parameters
-
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
- Returns
- A reference to this object.
- See also
- SubwindowKit::SetPriority()
-
SubwindowKit::SetRenderingAlgorithm()
MarkerKit& HPS::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.
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.
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 HPS::MarkerKit::Show |
( |
MarkerKit & |
out_kit | ) |
const |
bool HPS::MarkerKit::ShowPoint |
( |
HPS::Point & |
out_point | ) |
const |
Shows the point for this MarkerKit.
- Parameters
-
- Returns
- true if a point was set, false otherwise.
bool HPS::MarkerKit::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 HPS::MarkerKit::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.
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 HPS::MarkerKit::ShowUserDataCount |
( |
| ) |
const |
Get the number of user data indices set on this kit.
bool HPS::MarkerKit::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& HPS::MarkerKit::UnsetAllUserData |
( |
| ) |
|
Removes all user data from this kit.
- Returns
- A reference to this kit.
MarkerKit& HPS::MarkerKit::UnsetEverything |
( |
| ) |
|
Removes a drawing priority setting.
- Returns
- A reference to this object.
MarkerKit& HPS::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& HPS::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.
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.
The documentation for this class was generated from the following file: