|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The MarkerKit class is a user space object. It is a kit analog to a MarkerKey.
◆ MarkerKit() [1/2]
HPS.MarkerKit.MarkerKit |
( |
| ) |
|
|
inline |
The default constructor creates an empty MarkerKit object.
◆ MarkerKit() [2/2]
The copy constructor creates a new MarkerKit object that contains the same settings as the source MarkerKit.
- Parameters
-
◆ Consume()
◆ Empty()
override bool HPS.MarkerKit.Empty |
( |
| ) |
|
|
inlinevirtual |
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.
◆ Equals()
Check if the source MarkerKit is equivalent to this MarkerKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ ObjectType()
override HPS.Type HPS.MarkerKit.ObjectType |
( |
| ) |
|
|
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.
◆ Set()
◆ SetPoint()
◆ SetPriority()
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()
◆ SetUserData() [1/3]
HPS.MarkerKit HPS.MarkerKit.SetUserData |
( |
IntPtr |
in_index, |
|
|
ulong |
in_bytes, |
|
|
byte [] |
in_data |
|
) |
| |
|
inline |
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.
◆ SetUserData() [2/3]
HPS.MarkerKit HPS.MarkerKit.SetUserData |
( |
IntPtr |
in_index, |
|
|
byte [] |
in_data |
|
) |
| |
|
inline |
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.
◆ SetUserData() [3/3]
HPS.MarkerKit HPS.MarkerKit.SetUserData |
( |
IntPtr [] |
in_indices, |
|
|
byte |
in_data[][] |
|
) |
| |
|
inline |
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.
◆ Show()
◆ ShowPoint()
bool HPS.MarkerKit.ShowPoint |
( |
out HPS.Point |
out_point | ) |
|
|
inline |
Shows the point for this MarkerKit.
- Parameters
-
- Returns
- true if a point was set, false otherwise.
◆ ShowPriority()
bool HPS.MarkerKit.ShowPriority |
( |
out int |
out_priority | ) |
|
|
inline |
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.
◆ ShowUserData() [1/2]
bool HPS.MarkerKit.ShowUserData |
( |
IntPtr |
in_index, |
|
|
out byte [] |
out_data |
|
) |
| |
|
inline |
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.
◆ ShowUserData() [2/2]
bool HPS.MarkerKit.ShowUserData |
( |
out IntPtr [] |
out_indices, |
|
|
out byte |
out_data[][] |
|
) |
| |
|
inline |
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.
◆ ShowUserDataCount()
ulong HPS.MarkerKit.ShowUserDataCount |
( |
| ) |
|
|
inline |
Get the number of user data indices set on this kit.
◆ ShowUserDataIndices()
bool HPS.MarkerKit.ShowUserDataIndices |
( |
out IntPtr [] |
out_indices | ) |
|
|
inline |
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.
◆ UnsetAllUserData()
Removes all user data from this kit.
- Returns
- A reference to this kit.
◆ UnsetEverything()
◆ UnsetPoint()
◆ UnsetPriority()
Removes a drawing priority setting.
- Returns
- A reference to this object.
◆ UnsetUserData() [1/2]
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.
◆ UnsetUserData() [2/2]
HPS.MarkerKit HPS.MarkerKit.UnsetUserData |
( |
IntPtr [] |
in_indices | ) |
|
|
inline |
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:
- internals/hps_core/source/cs/HPS.MarkerKit.cs