< Home

< Table of Contents

REFERENCE MANUAL

HPS.LineKit Class Reference

The LineKit class is a user space object. More...

Inheritance diagram for HPS.LineKit:
HPS.Object

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...
 
- Public Member Functions inherited from HPS.Object
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 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
 
HandleRef scptr
 

Detailed Description

The LineKit class is a user space object.

It is a kit analog to a LineKey.

Constructor & Destructor Documentation

HPS.LineKit.LineKit ( )

The default constructor creates an empty LineKit object.

HPS.LineKit.LineKit ( HPS.LineKit  in_kit)

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref> to copy.

Member Function Documentation

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

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref> to consume.
HPS.LineKit HPS.LineKit.EditPointsByDeletion ( ulong  in_offset,
ulong  in_count 
)

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.
HPS.LineKit HPS.LineKit.EditPointsByInsertion ( ulong  in_offset,
HPS.Point[]  in_points 
)

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_countSize of the following array.
in_pointsThe points to insert into the point list at the specified offset.
Returns
A reference to this LineKit.
HPS.LineKit HPS.LineKit.EditPointsByReplacement ( ulong  in_offset,
HPS.Point[]  in_points 
)

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_countSize of the following array. This value must be such that in_offset+in_count<=point_count for the replacement to succeed.
in_pointsThe points to use to replace those in the point list at the specified offset.
Returns
A reference to this LineKit.
override bool HPS.LineKit.Empty ( )
virtual

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.

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

Check if the source LineKit is equivalent to this LineKit.

Parameters
in_kitThe 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>.
Returns
true if the objects are equivalent, false otherwise.
ulong HPS.LineKit.GetPointCount ( )

Retrieves the number of points in this line.

Returns
The number of points in this line.
override HPS.Type HPS.LineKit.ObjectType ( )
virtual

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.

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

Copies the source LineKit into this LineKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref> to copy.
HPS.LineKit HPS.LineKit.SetPoints ( HPS.Point[]  in_points)

Sets the points for this LineKit.

Parameters
in_countSize of the following array.
in_pointsThe points for this <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref>.
Returns
A reference to this LineKit.
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.

Parameters
in_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.

SubwindowKit::SetPriority()

SubwindowKit::SetRenderingAlgorithm()

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

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.
HPS.LineKit HPS.LineKit.SetUserData ( IntPtr  in_index,
byte[]  in_data 
)

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.
HPS.LineKit HPS.LineKit.SetUserData ( IntPtr[]  in_indices,
byte  in_data[][] 
)

Sets user data on this kit.

Parameters
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.
void HPS.LineKit.Show ( out HPS.LineKit  out_kit)

Copies this LineKit into the given LineKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref>.
bool HPS.LineKit.ShowPoints ( out HPS.Point[]  out_points)

Shows the points for this LineKit.

Returns
true if points were set, false otherwise.
bool HPS.LineKit.ShowPriority ( out int  out_priority)

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.
bool HPS.LineKit.ShowUserData ( IntPtr  in_index,
out byte[]  out_data 
)

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.
bool HPS.LineKit.ShowUserData ( out IntPtr[]  out_indices,
out byte  out_data[][] 
)

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
Returns
true if there is user data on this kit, false otherwise.
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.

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.
HPS.LineKit HPS.LineKit.UnsetAllUserData ( )

Removes all user data from this kit.

Returns
A reference to this kit.
HPS.LineKit HPS.LineKit.UnsetEverything ( )

Removes all settings from the LineKit.

Returns
A reference to this LineKit.
HPS.LineKit HPS.LineKit.UnsetPoints ( )

Removes the points for this LineKit.

Returns
A reference to this LineKit.
HPS.LineKit HPS.LineKit.UnsetPriority ( )

Removes a drawing priority setting.

Returns
A reference to this object.
HPS.LineKit HPS.LineKit.UnsetUserData ( IntPtr  in_index)

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.
HPS.LineKit HPS.LineKit.UnsetUserData ( IntPtr[]  in_indices)

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

Parameters
in_countThe size of the following array.
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: