REFERENCE MANUAL
The PolygonKit class is a user space object. More...
Public Member Functions | |
void | Consume (HPS.PolygonKit in_kit) |
Copies the source PolygonKit into this LineKit and resets the source kit. More... | |
override void | Dispose () |
HPS.PolygonKit | EditPointsByDeletion (ulong in_offset, ulong in_count) |
Remove the specified number of points from this PolygonKit at the specified offset. More... | |
HPS.PolygonKit | EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points) |
Add points to this PolygonKit at the specified offset. More... | |
HPS.PolygonKit | EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points) |
Replace the specified number of points for this PolygonKit at the specified offset. More... | |
override bool | Empty () |
Indicates whether this PolygonKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.PolygonKit in_kit) |
Check if the source PolygonKit is equivalent to this PolygonKit. More... | |
override int | GetHashCode () |
ulong | GetPointCount () |
Retrieves the number of points in this polygon. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
PolygonKit () | |
The default constructor creates an empty PolygonKit object. More... | |
PolygonKit (HPS.PolygonKit in_kit) | |
The copy constructor creates a new PolygonKit object that contains the same settings as the source PolygonKit. More... | |
void | Set (HPS.PolygonKit in_kit) |
Copies the source PolygonKit into this PolygonKit. More... | |
HPS.PolygonKit | SetPoints (HPS.Point[] in_points) |
Sets the points for this PolygonKit. More... | |
HPS.PolygonKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the PolygonKit. More... | |
HPS.PolygonKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.PolygonKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.PolygonKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
void | Show (out HPS.PolygonKit out_kit) |
Copies this PolygonKit into the given PolygonKit. More... | |
bool | ShowPoints (out HPS.Point[] out_points) |
Shows the points for this PolygonKit. 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.PolygonKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
HPS.PolygonKit | UnsetEverything () |
Removes all settings from this PolygonKit. More... | |
HPS.PolygonKit | UnsetPoints () |
Removes the points for this PolygonKit. More... | |
HPS.PolygonKit | UnsetPriority () |
Removes a drawing priority setting. More... | |
HPS.PolygonKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.PolygonKit | 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.PolygonKit a, HPS.PolygonKit b) |
static bool | operator== (HPS.PolygonKit a, HPS.PolygonKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The PolygonKit class is a user space object.
It is a kit analog to a PolygonKey.
HPS.PolygonKit.PolygonKit | ( | ) |
The default constructor creates an empty PolygonKit object.
HPS.PolygonKit.PolygonKit | ( | HPS.PolygonKit | in_kit | ) |
The copy constructor creates a new PolygonKit object that contains the same settings as the source PolygonKit.
in_kit | The source <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref> to copy. |
void HPS.PolygonKit.Consume | ( | HPS.PolygonKit | in_kit | ) |
Copies the source PolygonKit into this LineKit and resets the source kit.
in_kit | The source <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref> to consume. |
HPS.PolygonKit HPS.PolygonKit.EditPointsByDeletion | ( | ulong | in_offset, |
ulong | in_count | ||
) |
Remove the specified number of points from this PolygonKit at the specified offset.
in_offset | The offset into the points for <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref> at which to remove points. |
in_count | The number of points to remove. |
HPS.PolygonKit HPS.PolygonKit.EditPointsByInsertion | ( | ulong | in_offset, |
HPS.Point[] | in_points | ||
) |
Add points to this PolygonKit at the specified offset.
in_offset | The offset into the points for <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref> at which to add points. |
in_count | Size of the following array. |
in_points | The points to add to this <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref>. |
HPS.PolygonKit HPS.PolygonKit.EditPointsByReplacement | ( | ulong | in_offset, |
HPS.Point[] | in_points | ||
) |
Replace the specified number of points for this PolygonKit at the specified offset.
in_offset | The offset into the points for <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref> at which to start replacing points. |
in_count | Size of the following array. |
in_points | The points to use to replace those on this <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref>. |
|
virtual |
Indicates whether this PolygonKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.PolygonKit.Equals | ( | HPS.PolygonKit | in_kit | ) |
Check if the source PolygonKit is equivalent to this PolygonKit.
in_kit | The source <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref> to compare to this <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref>. |
ulong HPS.PolygonKit.GetPointCount | ( | ) |
Retrieves the number of points in this polygon.
|
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.PolygonKit.Set | ( | HPS.PolygonKit | in_kit | ) |
Copies the source PolygonKit into this PolygonKit.
in_kit | The source <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref> to copy. |
HPS.PolygonKit HPS.PolygonKit.SetPoints | ( | HPS.Point[] | in_points | ) |
Sets the points for this PolygonKit.
in_count | Size of the following array. |
in_points | The points for this <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref>. |
HPS.PolygonKit HPS.PolygonKit.SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the PolygonKit.
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.PolygonKit HPS.PolygonKit.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.PolygonKit HPS.PolygonKit.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.PolygonKit HPS.PolygonKit.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.PolygonKit.Show | ( | out HPS.PolygonKit | out_kit | ) |
Copies this PolygonKit into the given PolygonKit.
out_kit | The <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref>. |
bool HPS.PolygonKit.ShowPoints | ( | out HPS.Point[] | out_points | ) |
Shows the points for this PolygonKit.
out_points | The points for this <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref>. |
bool HPS.PolygonKit.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.PolygonKit.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.PolygonKit.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.PolygonKit.ShowUserDataCount | ( | ) |
Get the number of user data indices set on this kit.
bool HPS.PolygonKit.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.PolygonKit HPS.PolygonKit.UnsetAllUserData | ( | ) |
Removes all user data from this kit.
HPS.PolygonKit HPS.PolygonKit.UnsetEverything | ( | ) |
Removes all settings from this PolygonKit.
HPS.PolygonKit HPS.PolygonKit.UnsetPoints | ( | ) |
Removes the points for this PolygonKit.
HPS.PolygonKit HPS.PolygonKit.UnsetPriority | ( | ) |
Removes a drawing priority setting.
HPS.PolygonKit HPS.PolygonKit.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.PolygonKit HPS.PolygonKit.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. |