LineKit

class HPS.LineKit : public HPS.Kit 

The LineKit class is a user space object. It is a kit analog to a LineKey.

Public Functions

void Consume (HPS.LineKit in_kit)

Copies the source LineKit into this LineKit and resets the source kit.

Param in_kit: The source LineKit to consume.

override void Dispose ()

HPS.LineKit EditPointsByDeletion (ulong in_offset, ulong in_count)

Removes points from the point list for this LineKit.

Param 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.
Param 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.
Return: A reference to this LineKit.

HPS.LineKit EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points)

Adds points to the point list for this LineKit.

Param 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.
Param in_points: The points to insert into the point list at the specified offset.
Return: A reference to this LineKit.

HPS.LineKit EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)

Replaces points in the point list for this LineKit.

Param 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.
Param 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.
Return: A reference to this LineKit.

override bool Empty ()

Indicates whether this LineKit has any values set on it.

Return: true if no values are set on this LineKit, false otherwise.

bool Equals (HPS.LineKit in_kit)

Check if the source LineKit is equivalent to this LineKit.

Param in_kit: The source LineKit to compare to this LineKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

ulong GetPointCount ()

Retrieves the number of points in this line.

Return: The number of points in this line.

LineKit (): The default constructor creates an empty LineKit object.

LineKit (HPS.LineKit in_kit)

The copy constructor creates a new LineKit object that contains the same settings as the source LineKit.

Param in_kit: The source LineKit 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.LineKit in_kit)

Copies the source LineKit into this LineKit.

Param in_kit: The source LineKit to copy.

HPS.LineKit SetPointCoordinateSpace (HPS.Line.CoordinateSpace[] in_spaces)

Sets the coordinate space to use for each point of this line. The default is Line.CoordinateSpace.Object.

Param in_spaces: The coordinate spaces for each point in the line.
Return: A reference to this LineKit.

HPS.LineKit SetPointCoordinateSpace (ulong[] in_indices, HPS.Line.CoordinateSpace[] in_spaces)

Sets the coordinate space to use for each point of this line. The default is Line.CoordinateSpace.Object.

Param in_indices: The list of point indices to unset.
Param in_spaces: The coordinate spaces for each point in the line.
Return: A reference to this LineKit.

HPS.LineKit SetPoints (HPS.Point[] in_points)

Sets the points for this LineKit.

Param in_points: The points for this LineKit.
Return: A reference to this LineKit.

HPS.LineKit SetPoints (HPS.Point[] in_points, HPS.Line.CoordinateSpace[] in_spaces)

Sets the points for this LineKit.

Param in_points: The points for this LineKit.
Param in_spaces: The coordinate spaces for each point in the line.
Return: A reference to this 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.

See: SubwindowKit.SetPriority()
See: SubwindowKit.SetRenderingAlgorithm()

Param in_priority: The drawing priority, higher priority items are drawn on top of lower priority items.
Return: A reference to this object.

HPS.LineKit 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.LineKit 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.LineKit 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.LineKit out_kit)

Copies this LineKit into the given LineKit.

Param out_kit: The LineKit to populate with the contents of this LineKit.

bool ShowPointCoordinateSpace (out HPS.Line.CoordinateSpace[] out_spaces)

Shows the coordinate space that is being used for the points at the specified indices.

Param out_spaces: The coordinate spaces for each all points on this line.
Return: true if line coordinates could be retrieved for this line false otherwise.

bool ShowPointCoordinateSpace (ulong[] in_indices, out HPS.Line.CoordinateSpace[] out_spaces)

Shows the coordinate space that is being used for the points at the specified indices.

Param in_indices: The list of point indices to show.
Param out_spaces: The coordinate spaces for each index specified.
Return: true if line coordinates could be retrieved for this line false otherwise.

bool ShowPoints (out HPS.Point[] out_points)

Shows the points for this LineKit.

Param out_points: The points for this LineKit.
Return: true if points were set, false otherwise.

bool ShowPoints (out HPS.Point[] out_points, out HPS.Line.CoordinateSpace[] out_coordinate_spaces)

Shows the points for this LineKit.

Param out_points: The points for this LineKit.
Param out_coordinate_spaces: The coordinate spaces for each point in this line.
Return: true if points were set, false otherwise.

bool ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points)

Show a subset of the points for this LineKit by list.

Param in_indices: The list of point indices to show.
Param out_points: The requested points for this LineKit.
Return: true if all requested points were set, false otherwise.

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.

Param in_start_index: The first point to show.
Param in_count: The number of points to show.
Param out_points: The requested points for this LineKit.
Return: true if all requested points were 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.LineKit UnsetAllUserData ()

Removes all user data from this kit.

Return: A reference to this kit.

HPS.LineKit UnsetEverything ()

Removes all settings from the LineKit.

Return: A reference to this LineKit.

HPS.LineKit UnsetPointCoordinateSpace ()

Unsets the coordinate space for all points on this line back to Coordinate.Space.Object.

Return: A reference to this LineKit.

HPS.LineKit UnsetPointCoordinateSpace (ulong[] in_indices)

Unsets the coordinate space for specified points on this line back to Coordinate.Space.Object.

Param in_indices: The list of point indices to unset.
Return: A reference to this LineKit.

HPS.LineKit UnsetPoints ()

Removes the points for this LineKit.

Return: A reference to this LineKit.

HPS.LineKit UnsetPriority ()

Removes a drawing priority setting.

Return: A reference to this object.

HPS.LineKit 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.LineKit 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.LineKit a, HPS.LineKit b)

bool operator== (HPS.LineKit a, HPS.LineKit b)