The MarkerKit class is a user space object. It is a kit analog to a MarkerKey. More...
Public Member Functions | |
override void | Dispose () |
MarkerKit () | |
The default constructor creates an empty MarkerKit object. More... | |
MarkerKit (HPS.MarkerKit in_kit) | |
The copy constructor creates a new MarkerKit object that contains the same settings as the source MarkerKit. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Consume (HPS.MarkerKit in_kit) |
Copies the source MarkerKit into this MarkerKit and resets the source kit. More... | |
void | Set (HPS.MarkerKit in_kit) |
Copies the source MarkerKit into this MarkerKit. More... | |
void | Show (out HPS.MarkerKit out_kit) |
Copies this MarkerKit into the given MarkerKit. More... | |
override bool | Empty () |
Indicates whether this MarkerKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.MarkerKit in_kit) |
Check if the source MarkerKit is equivalent to this MarkerKit. More... | |
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. More... | |
HPS.MarkerKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
HPS.MarkerKit | SetPoint (HPS.Point in_point) |
Sets the point for this MarkerKit. More... | |
HPS.MarkerKit | UnsetPoint () |
Removes the point for the MarkerKit. More... | |
HPS.MarkerKit | UnsetEverything () |
Removes all settings from the MarkerKit. More... | |
bool | ShowPoint (out HPS.Point out_point) |
Shows the point for this MarkerKit. More... | |
HPS.MarkerKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.MarkerKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.MarkerKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
HPS.MarkerKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.MarkerKit | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this kit. More... | |
HPS.MarkerKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
ulong | ShowUserDataCount () |
Get the number of user data indices set on this kit. More... | |
bool | ShowUserDataIndices (out IntPtr[] out_indices) |
Shows the indices of all user data set on this kit. More... | |
bool | ShowUserData (IntPtr in_index, out byte[] out_data) |
Shows the user data at a given index for this kit. More... | |
bool | ShowUserData (out IntPtr[] out_indices, out byte[][] out_data) |
Shows all user data for this kit. More... | |
![]() | |
IntPtr | GetClassID () |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
HPS.Type | Type () |
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. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
IntPtr | GetInstanceID () |
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. More... | |
Static Public Member Functions | |
static bool | operator== (HPS.MarkerKit a, HPS.MarkerKit b) |
static bool | operator!= (HPS.MarkerKit a, HPS.MarkerKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
|
inline |
The default constructor creates an empty MarkerKit object.
|
inline |
|
inline |
|
inlinevirtual |
Indicates whether this MarkerKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source MarkerKit is equivalent to this MarkerKit.
in_kit | The source <ref refid="class_h_p_s_1_1_marker_kit" kindref="compound">MarkerKit</ref> to compare to this <ref refid="class_h_p_s_1_1_marker_kit" kindref="compound">MarkerKit</ref>. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
|
inline |
|
inline |
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.
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
SubwindowKit::SetPriority()
|
inline |
Sets user data on this kit.
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. |
|
inline |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
|
inline |
Sets user data on this kit.
in_indices | An array of user data indices to set. |
in_data | An array of bytes of user data to set. |
|
inline |
|
inline |
|
inline |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
|
inline |
Shows the user data at a given index for this kit.
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
|
inline |
Shows all user data for this kit.
out_indices | An array of all user data indices set on this kit. |
|
inline |
Get the number of user data indices set on this kit.
|
inline |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
|
inline |
Removes all user data from this kit.
|
inline |
|
inline |
|
inline |
Removes a drawing priority setting.
|
inline |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
|
inline |
Removes the user data at the given indices from this kit.
in_count | The size of the following array. |
in_indices | The indices of the user data to remove. |