The LineKit class is a user space object. It is a kit analog to a LineKey. 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. This does not necessarily give the true type of the underlying object. 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. 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 | 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 | ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points) |
Show a subset of the points for this LineKit by list. 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 | 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. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
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. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. 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 |
Detailed Description
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty LineKit object.
|
inline |
Member Function Documentation
|
inline |
|
inline |
Removes points from the point list for this LineKit.
- Parameters
-
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.
- Returns
- A reference to this LineKit.
|
inline |
Adds points to the point list for this LineKit.
- Parameters
-
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_points The points to insert into the point list at the specified offset.
- Returns
- A reference to this LineKit.
|
inline |
Replaces points in the point list for this LineKit.
- Parameters
-
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_points The points to use to replace those in the point list at the specified offset. This size of the array must be such that in_offset+in_points.size()<=point_count for the replacement to succeed.
- Returns
- A reference to this LineKit.
|
inlinevirtual |
Indicates whether this LineKit has any values set on it.
- Returns
- true if no values are set on this LineKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
|
inline |
Retrieves the number of points in this line.
- Returns
- 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.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
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.
- Parameters
-
in_priority The drawing priority, higher priority items are drawn on top of lower priority items.
- Returns
- A reference to this object.
SubwindowKit::SetPriority()
|
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.
|
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.
|
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.
|
inline |
|
inline |
|
inline |
|
inline |
|
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.
|
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.
|
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.
|
inline |
Get the number of user data indices set on this kit.
|
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.
|
inline |
Removes all user data from this kit.
- Returns
- A reference to this kit.
|
inline |
|
inline |
|
inline |
Removes a drawing priority setting.
- Returns
- A reference to this object.
|
inline |
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.
|
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.LineKit.cs