The PolygonKit class is a user space object. It is a kit analog to a PolygonKey. 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. This does not necessarily give the true type of the underlying object. 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. 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.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 | ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points) |
Show a subset of the points for this PolygonKit 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 PolygonKit 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.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. 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.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.
|
inline |
The default constructor creates an empty PolygonKit object.
|
inline |
The copy constructor creates a new PolygonKit object that contains the same settings as the source PolygonKit.
in_kit | The source PolygonKit to copy. |
|
inline |
Copies the source PolygonKit into this LineKit and resets the source kit.
in_kit | The source PolygonKit to consume. |
|
inline |
Remove the specified number of points from this PolygonKit at the specified offset.
in_offset | The offset into the points for PolygonKit at which to remove points. |
in_count | The number of points to remove. |
|
inline |
Add points to this PolygonKit at the specified offset.
in_offset | The offset into the points for PolygonKit at which to add points. |
in_points | The points to add to this PolygonKit. |
|
inline |
Replace the specified number of points for this PolygonKit at the specified offset.
in_offset | The offset into the points for PolygonKit at which to start replacing points. |
in_points | The points to use to replace those on this PolygonKit. |
|
inlinevirtual |
Indicates whether this PolygonKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source PolygonKit is equivalent to this PolygonKit.
in_kit | The source PolygonKit to compare to this PolygonKit. |
|
inline |
Retrieves the number of points in this polygon.
|
inlinevirtual |
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.
|
inline |
Copies the source PolygonKit into this PolygonKit.
in_kit | The source PolygonKit to copy. |
|
inline |
Sets the points for this PolygonKit.
in_points | The points for this PolygonKit. |
|
inline |
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()
|
inline |
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. |
|
inline |
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. |
|
inline |
Sets user data on this kit.
in_indices | An array of user data indices to set. |
in_data | An array of bytes of user data to set. |
|
inline |
Copies this PolygonKit into the given PolygonKit.
out_kit | The PolygonKit to populate with the contents of this PolygonKit. |
|
inline |
Shows the points for this PolygonKit.
out_points | The points for this PolygonKit. |
|
inline |
Show a subset of the points for this PolygonKit by list.
in_indices | The list of point indices to show. |
out_points | The requested points for this PolygonKit. |
|
inline |
Show a subset of the points for this PolygonKit by range.
in_start_index | The first point to show. |
in_count | The number of points to show. |
out_points | The requested points for this PolygonKit. |
|
inline |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
|
inline |
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. |
|
inline |
Shows all user data for this kit.
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. |
|
inline |
Get the number of user data indices set on this kit.
|
inline |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
|
inline |
Removes all user data from this kit.
|
inline |
Removes all settings from this PolygonKit.
|
inline |
Removes the points for this PolygonKit.
|
inline |
Removes a drawing priority setting.
|
inline |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
|
inline |
Removes the user data at the given indices from this kit.
in_indices | The indices of the user data to remove. |