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 (HPS.MarkerKit in_kit)
Copies the source MarkerKit into this MarkerKit and resets the source kit.
- Param in_kit
The source LineKit to consume.
- override void Dispose ()
- override bool Empty ()
Indicates whether this MarkerKit has any values set on it.
- Return
true if no values are set on this MarkerKit, false otherwise.
- bool Equals (HPS.MarkerKit in_kit)
Check if the source MarkerKit is equivalent to this MarkerKit.
- override bool Equals (Object obj)
- override int GetHashCode ()
- MarkerKit (HPS.MarkerKit in_kit)
The copy constructor creates a new MarkerKit object that contains the same settings as the source MarkerKit.
- Param in_kit
The source MarkerKit to copy.
- override HPS.Type ObjectType ()
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).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- void Set (HPS.MarkerKit in_kit)
Copies the source MarkerKit into this MarkerKit.
- Param in_kit
The source MarkerKit to copy.
- HPS.MarkerKit SetPoint (HPS.Point in_point)
Sets the point for this 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.
- See
SubwindowKit.SetPriority()
- See
- Param in_priority
The drawing priority, higher priority items are drawn on top of lower priority items.
- Return
A reference to this object.
- HPS.MarkerKit SetUserData (IntPtr in_index, byte[] in_data)
Sets user data on this kit.
- Param in_index
The index of the user data to set.
- Param in_data
The bytes of user data to set.
- Return
A reference to this kit.
- HPS.MarkerKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
Sets user data on this kit.
- Param in_index
The index of the user data to set.
- Param in_bytes
The number of bytes of user data to set.
- Param in_data
The bytes of user data to set.
- Return
A reference to this kit.
- HPS.MarkerKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
Sets user data on this kit.
- Param in_indices
An array of user data indices to set.
- Param in_data
An array of bytes of user data to set.
- Return
A reference to this kit.
- void Show (out HPS.MarkerKit out_kit)
- bool ShowPoint (out HPS.Point out_point)
Shows the point for this MarkerKit.
- Param out_point
The point for this MarkerKit.
- Return
true if a point was set, false otherwise.
- bool ShowPriority (out int out_priority)
Shows the drawing priority.
- Param out_priority
The drawing priority, higher priority items are drawn on top of lower priority items.
- Return
true if the setting is valid, false otherwise.
- bool ShowUserData (IntPtr in_index, out byte[] out_data)
Shows the user data at a given index for this kit.
- Param in_index
The index of the user data to show.
- Param out_data
The user data at the given index.
- Return
true if there is user data at the given index, false otherwise.
- bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
Shows all user data for this kit.
- Param out_indices
An array of all user data indices set on this kit.
- Param out_data
An array of all user data set on this kit.
- Return
true if there is user data on this kit, false otherwise.
- ulong ShowUserDataCount ()
Get the number of user data indices set on this kit.
- bool ShowUserDataIndices (out IntPtr[] out_indices)
Shows the indices of all user data set on this kit.
- Param out_indices
The user data indices set on this kit.
- Return
The number of user data indices set on this kit.
- HPS.MarkerKit UnsetAllUserData ()
Removes all user data from this kit.
- Return
A reference to this kit.
- HPS.MarkerKit UnsetEverything ()
Removes all settings from the MarkerKit.
- Return
A reference to this MarkerKit.
- HPS.MarkerKit UnsetPoint ()
Removes the point for the MarkerKit.
- Return
A reference to this MarkerKit.
- HPS.MarkerKit UnsetPriority ()
Removes a drawing priority setting.
- Return
A reference to this object.
- HPS.MarkerKit UnsetUserData (IntPtr in_index)
Removes the user data at the given index from this kit.
- Param in_index
The index of the user data to remove.
- Return
A reference to this kit.
- HPS.MarkerKit UnsetUserData (IntPtr[] in_indices)
Removes the user data at the given indices from this kit.
- Param in_indices
The indices of the user data to remove.
- Return
A reference to this kit.
Public Static Functions
- bool operator!= (HPS.MarkerKit a, HPS.MarkerKit b)
- bool operator== (HPS.MarkerKit a, HPS.MarkerKit b)