The LineKit class is a user space object. It is a kit analog to a LineKey. More...
Public Member Functions | |
override void | Dispose () |
LineKit () | |
The default constructor creates an empty LineKit object. More... | |
LineKit (HPS.LineKit in_kit) | |
The copy constructor creates a new LineKit object that contains the same settings as the source LineKit. 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.LineKit in_kit) |
Copies the source LineKit into this LineKit and resets the source kit. More... | |
void | Set (HPS.LineKit in_kit) |
Copies the source LineKit into this LineKit. More... | |
void | Show (out HPS.LineKit out_kit) |
Copies this LineKit into the given LineKit. More... | |
override bool | Empty () |
Indicates whether this LineKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.LineKit in_kit) |
Check if the source LineKit is equivalent to this LineKit. More... | |
ulong | GetPointCount () |
Retrieves the number of points in this line. More... | |
HPS.LineKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the LineKit. 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.LineKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
HPS.LineKit | SetPoints (HPS.Point[] in_points) |
Sets the points for this LineKit. More... | |
HPS.LineKit | UnsetPoints () |
Removes the points for this LineKit. More... | |
HPS.LineKit | UnsetEverything () |
Removes all settings from the LineKit. More... | |
bool | ShowPoints (out HPS.Point[] out_points) |
Shows the points for this LineKit. More... | |
bool | ShowPointsByRange (ulong in_start_index, ulong in_count, out HPS.Point[] out_points) |
Show a subset of the points for this LineKit by range. More... | |
bool | ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points) |
Show a subset of the points for this LineKit by list. More... | |
HPS.LineKit | EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points) |
Adds points to the point list for this LineKit. More... | |
HPS.LineKit | EditPointsByDeletion (ulong in_offset, ulong in_count) |
Removes points from the point list for this LineKit. More... | |
HPS.LineKit | EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points) |
Replaces points in the point list for this LineKit. More... | |
HPS.LineKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.LineKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.LineKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
HPS.LineKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.LineKit | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this kit. More... | |
HPS.LineKit | 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.LineKit a, HPS.LineKit b) |
static bool | operator!= (HPS.LineKit a, HPS.LineKit 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 LineKit object.
|
inline |
|
inline |
|
inline |
Removes points from the point list for this LineKit.
in_offset | The offset into the point list for the line at which to start removing points. This value must be such that in_offset<point_count for deletion to succeed. |
in_count | The number of points to delete from the point list for the line. This value must be such that in_offset+in_count<=point_count for the deletion to succeed. |
|
inline |
Adds points to the point list for this LineKit.
in_offset | The offset into the point list for the line at which to insert points. This value must be such that in_offset<point_count for insertion to succeed. |
in_count | Size of the following array. |
in_points | The points to insert into the point list at the specified offset. |
|
inline |
Replaces points in the point list for this LineKit.
in_offset | The offset into the point list for the line at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed. |
in_count | Size of the following array. This value must be such that in_offset+in_count<=point_count for the replacement to succeed. |
in_points | The points to use to replace those in the point list at the specified offset. |
|
inlinevirtual |
Indicates whether this LineKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source LineKit is equivalent to this LineKit.
in_kit | The source <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref> to compare to this <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref>. |
|
inline |
Retrieves the number of points in this line.
|
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 LineKit. 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 |
Show a subset of the points for this LineKit by list.
in_count | The number of points to show. |
in_indices | The list of point indices to show. |
out_points | The requested points for this <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref>. |
|
inline |
Show a subset of the points for this LineKit by range.
in_start_index | The first point to show. |
in_count | The number of points to show. |
out_points | The requested points for this <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref>. |
|
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. |
out_data | An array of all user data 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. |