Inheritance diagram for HPS.LineKit:
HPS.Kit HPS.Object

Public Member Functions

void Consume (HPS.LineKit in_kit)
 
override void Dispose ()
 
HPS.LineKit EditPointsByDeletion (ulong in_offset, ulong in_count)
 
HPS.LineKit EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points)
 
HPS.LineKit EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.LineKit in_kit)
 
override int GetHashCode ()
 
ulong GetPointCount ()
 
 LineKit ()
 
 LineKit (HPS.LineKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.LineKit in_kit)
 
HPS.LineKit SetPointCoordinateSpace (ulong[] in_indices, HPS.Line.CoordinateSpace[] in_spaces)
 
HPS.LineKit SetPointCoordinateSpace (HPS.Line.CoordinateSpace[] in_spaces)
 
HPS.LineKit SetPoints (HPS.Point[] in_points)
 
HPS.LineKit SetPoints (HPS.Point[] in_points, HPS.Line.CoordinateSpace[] in_spaces)
 
HPS.LineKit SetPriority (int in_priority)
 
HPS.LineKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.LineKit SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.LineKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
void Show (out HPS.LineKit out_kit)
 
bool ShowPointCoordinateSpace (ulong[] in_indices, out HPS.Line.CoordinateSpace[] out_spaces)
 
bool ShowPointCoordinateSpace (out HPS.Line.CoordinateSpace[] out_spaces)
 
bool ShowPoints (out HPS.Point[] out_points)
 
bool ShowPoints (out HPS.Point[] out_points, out HPS.Line.CoordinateSpace[] out_coordinate_spaces)
 
bool ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points)
 
bool ShowPointsByRange (ulong in_start_index, ulong in_count, out HPS.Point[] out_points)
 
bool ShowPriority (out int out_priority)
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 
ulong ShowUserDataCount ()
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 
HPS.LineKit UnsetAllUserData ()
 
HPS.LineKit UnsetEverything ()
 
HPS.LineKit UnsetPointCoordinateSpace (ulong[] in_indices)
 
HPS.LineKit UnsetPointCoordinateSpace ()
 
HPS.LineKit UnsetPoints ()
 
HPS.LineKit UnsetPriority ()
 
HPS.LineKit UnsetUserData (IntPtr in_index)
 
HPS.LineKit UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static bool operator!= (HPS.LineKit a, HPS.LineKit b)
 
static bool operator== (HPS.LineKit a, HPS.LineKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

◆ LineKit() [1/2]

HPS.LineKit.LineKit ( )
inline

The default constructor creates an empty LineKit object.

◆ LineKit() [2/2]

HPS.LineKit.LineKit ( HPS.LineKit  in_kit)
inline

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

Parameters
in_kitThe source LineKit to copy.

Member Function Documentation

◆ Consume()

void HPS.LineKit.Consume ( HPS.LineKit  in_kit)
inline

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

Parameters
in_kitThe source LineKit to consume.

◆ EditPointsByDeletion()

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

Removes points from the point list for this LineKit.

Parameters
in_offsetThe 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_countThe 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.

◆ EditPointsByInsertion()

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

Adds points to the point list for this LineKit.

Parameters
in_offsetThe 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_pointsThe points to insert into the point list at the specified offset.
Returns
A reference to this LineKit.

◆ EditPointsByReplacement()

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

Replaces points in the point list for this LineKit.

Parameters
in_offsetThe 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_pointsThe 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.

◆ Empty()

override bool HPS.LineKit.Empty ( )
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.

◆ Equals()

bool HPS.LineKit.Equals ( HPS.LineKit  in_kit)
inline

Check if the source LineKit is equivalent to this LineKit.

Parameters
in_kitThe source LineKit to compare to this LineKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetPointCount()

ulong HPS.LineKit.GetPointCount ( )
inline

Retrieves the number of points in this line.

Returns
The number of points in this line.

◆ ObjectType()

override HPS.Type HPS.LineKit.ObjectType ( )
inlinevirtual

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).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Kit.

◆ Set()

void HPS.LineKit.Set ( HPS.LineKit  in_kit)
inline

Copies the source LineKit into this LineKit.

Parameters
in_kitThe source LineKit to copy.

◆ SetPointCoordinateSpace() [1/2]

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

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

Parameters
in_indicesThe list of point indices to unset.
in_spacesThe coordinate spaces for each point in the line.
Returns
A reference to this LineKit.

◆ SetPointCoordinateSpace() [2/2]

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

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

Parameters
in_spacesThe coordinate spaces for each point in the line.
Returns
A reference to this LineKit.

◆ SetPoints() [1/2]

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

Sets the points for this LineKit.

Parameters
in_pointsThe points for this LineKit.
Returns
A reference to this LineKit.

◆ SetPoints() [2/2]

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

Sets the points for this LineKit.

Parameters
in_pointsThe points for this LineKit.
in_spacesThe coordinate spaces for each point in the line.
Returns
A reference to this LineKit.

◆ SetPriority()

HPS.LineKit HPS.LineKit.SetPriority ( int  in_priority)
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_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.
See also
SubwindowKit.SetPriority()
SubwindowKit.SetRenderingAlgorithm()

◆ SetUserData() [1/3]

HPS.LineKit HPS.LineKit.SetUserData ( IntPtr  in_index,
ulong  in_bytes,
byte []  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [2/3]

HPS.LineKit HPS.LineKit.SetUserData ( IntPtr  in_index,
byte []  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [3/3]

HPS.LineKit HPS.LineKit.SetUserData ( IntPtr []  in_indices,
byte  in_data[][] 
)
inline

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.

◆ Show()

void HPS.LineKit.Show ( out HPS.LineKit  out_kit)
inline

Copies this LineKit into the given LineKit.

Parameters
out_kitThe LineKit to populate with the contents of this LineKit.

◆ ShowPointCoordinateSpace() [1/2]

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

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

Parameters
in_indicesThe list of point indices to show.
out_spacesThe coordinate spaces for each index specified.
Returns
true if line coordinates could be retrieved for this line false otherwise.

◆ ShowPointCoordinateSpace() [2/2]

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

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

Parameters
out_spacesThe coordinate spaces for each all points on this line.
Returns
true if line coordinates could be retrieved for this line false otherwise.

◆ ShowPoints() [1/2]

bool HPS.LineKit.ShowPoints ( out HPS.Point []  out_points)
inline

Shows the points for this LineKit.

Parameters
out_pointsThe points for this LineKit.
Returns
true if points were set, false otherwise.

◆ ShowPoints() [2/2]

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

Shows the points for this LineKit.

Parameters
out_pointsThe points for this LineKit.
out_coordinate_spacesThe coordinate spaces for each point in this line.
Returns
true if points were set, false otherwise.

◆ ShowPointsByList()

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

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

Parameters
in_indicesThe list of point indices to show.
out_pointsThe requested points for this LineKit.
Returns
true if all requested points were set, false otherwise.

◆ ShowPointsByRange()

bool HPS.LineKit.ShowPointsByRange ( ulong  in_start_index,
ulong  in_count,
out HPS.Point []  out_points 
)
inline

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

Parameters
in_start_indexThe first point to show.
in_countThe number of points to show.
out_pointsThe requested points for this LineKit.
Returns
true if all requested points were set, false otherwise.

◆ ShowPriority()

bool HPS.LineKit.ShowPriority ( out int  out_priority)
inline

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if the setting is valid, false otherwise.

◆ ShowUserData() [1/2]

bool HPS.LineKit.ShowUserData ( IntPtr  in_index,
out byte []  out_data 
)
inline

Shows the user data at a given index for this kit.

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.

◆ ShowUserData() [2/2]

bool HPS.LineKit.ShowUserData ( out IntPtr []  out_indices,
out byte  out_data[][] 
)
inline

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn array of all user data set on this kit.
Returns
true if there is user data on this kit, false otherwise.

◆ ShowUserDataCount()

ulong HPS.LineKit.ShowUserDataCount ( )
inline

Get the number of user data indices set on this kit.

◆ ShowUserDataIndices()

bool HPS.LineKit.ShowUserDataIndices ( out IntPtr []  out_indices)
inline

Shows the indices of all user data set on this kit.

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.

◆ UnsetAllUserData()

HPS.LineKit HPS.LineKit.UnsetAllUserData ( )
inline

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetEverything()

HPS.LineKit HPS.LineKit.UnsetEverything ( )
inline

Removes all settings from the LineKit.

Returns
A reference to this LineKit.

◆ UnsetPointCoordinateSpace() [1/2]

HPS.LineKit HPS.LineKit.UnsetPointCoordinateSpace ( ulong []  in_indices)
inline

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

Parameters
in_indicesThe list of point indices to unset.
Returns
A reference to this LineKit.

◆ UnsetPointCoordinateSpace() [2/2]

HPS.LineKit HPS.LineKit.UnsetPointCoordinateSpace ( )
inline

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

Returns
A reference to this LineKit.

◆ UnsetPoints()

HPS.LineKit HPS.LineKit.UnsetPoints ( )
inline

Removes the points for this LineKit.

Returns
A reference to this LineKit.

◆ UnsetPriority()

HPS.LineKit HPS.LineKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetUserData() [1/2]

HPS.LineKit HPS.LineKit.UnsetUserData ( IntPtr  in_index)
inline

Removes the user data at the given index from this kit.

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [2/2]

HPS.LineKit HPS.LineKit.UnsetUserData ( IntPtr []  in_indices)
inline

Removes the user data at the given indices from this kit.

Parameters
in_indicesThe 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