REFERENCE MANUAL
The LineKit class is a user space object. More...
Public Member Functions | |
void | Consume (HPS.LineKit in_kit) |
Copies the source LineKit into this LineKit and resets the source kit. More... | |
override void | Dispose () |
HPS.LineKit | EditPointsByDeletion (ulong in_offset, ulong in_count) |
Removes points from the point list for this LineKit. More... | |
HPS.LineKit | EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points) |
Adds points to 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... | |
override bool | Empty () |
Indicates whether this LineKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.LineKit in_kit) |
Check if the source LineKit is equivalent to this LineKit. More... | |
override int | GetHashCode () |
ulong | GetPointCount () |
Retrieves the number of points in this line. More... | |
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. More... | |
void | Set (HPS.LineKit in_kit) |
Copies the source LineKit into this LineKit. More... | |
HPS.LineKit | SetPoints (HPS.Point[] in_points) |
Sets the points for this LineKit. More... | |
HPS.LineKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the 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... | |
void | Show (out HPS.LineKit out_kit) |
Copies this LineKit into the given LineKit. More... | |
bool | ShowPoints (out HPS.Point[] out_points) |
Shows the points for this LineKit. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. 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... | |
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... | |
HPS.LineKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
HPS.LineKit | UnsetEverything () |
Removes all settings from the LineKit. More... | |
HPS.LineKit | UnsetPoints () |
Removes the points for this LineKit. More... | |
HPS.LineKit | UnsetPriority () |
Removes a drawing priority setting. 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... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
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... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. 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 | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
HPS.LineKit.LineKit | ( | ) |
The default constructor creates an empty LineKit object.
HPS.LineKit.LineKit | ( | HPS.LineKit | in_kit | ) |
void HPS.LineKit.Consume | ( | HPS.LineKit | in_kit | ) |
HPS.LineKit HPS.LineKit.EditPointsByDeletion | ( | ulong | in_offset, |
ulong | in_count | ||
) |
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. |
HPS.LineKit HPS.LineKit.EditPointsByInsertion | ( | ulong | in_offset, |
HPS.Point[] | in_points | ||
) |
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. |
HPS.LineKit HPS.LineKit.EditPointsByReplacement | ( | ulong | in_offset, |
HPS.Point[] | in_points | ||
) |
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. |
|
virtual |
Indicates whether this LineKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.LineKit.Equals | ( | HPS.LineKit | in_kit | ) |
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>. |
ulong HPS.LineKit.GetPointCount | ( | ) |
Retrieves the number of points in this line.
|
virtual |
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.
void HPS.LineKit.Set | ( | HPS.LineKit | in_kit | ) |
HPS.LineKit HPS.LineKit.SetPoints | ( | HPS.Point[] | in_points | ) |
HPS.LineKit 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.
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
SubwindowKit::SetPriority()
HPS.LineKit HPS.LineKit.SetUserData | ( | IntPtr | in_index, |
ulong | in_bytes, | ||
byte[] | in_data | ||
) |
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. |
HPS.LineKit HPS.LineKit.SetUserData | ( | IntPtr | in_index, |
byte[] | in_data | ||
) |
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. |
HPS.LineKit HPS.LineKit.SetUserData | ( | IntPtr[] | in_indices, |
byte | in_data[][] | ||
) |
Sets user data on this kit.
in_data | An array of bytes of user data to set. |
void HPS.LineKit.Show | ( | out HPS.LineKit | out_kit | ) |
bool HPS.LineKit.ShowPoints | ( | out HPS.Point[] | out_points | ) |
Shows the points for this LineKit.
bool HPS.LineKit.ShowPriority | ( | out int | out_priority | ) |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
bool HPS.LineKit.ShowUserData | ( | IntPtr | in_index, |
out byte[] | out_data | ||
) |
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. |
bool HPS.LineKit.ShowUserData | ( | out IntPtr[] | out_indices, |
out byte | out_data[][] | ||
) |
Shows all user data for this kit.
out_indices | An array of all user data indices set on this kit. |
ulong HPS.LineKit.ShowUserDataCount | ( | ) |
Get the number of user data indices set on this kit.
bool HPS.LineKit.ShowUserDataIndices | ( | out IntPtr[] | out_indices | ) |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
HPS.LineKit HPS.LineKit.UnsetAllUserData | ( | ) |
Removes all user data from this kit.
HPS.LineKit HPS.LineKit.UnsetEverything | ( | ) |
HPS.LineKit HPS.LineKit.UnsetPoints | ( | ) |
HPS.LineKit HPS.LineKit.UnsetPriority | ( | ) |
Removes a drawing priority setting.
HPS.LineKit HPS.LineKit.UnsetUserData | ( | IntPtr | in_index | ) |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
HPS.LineKit HPS.LineKit.UnsetUserData | ( | IntPtr[] | in_indices | ) |
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. |