< Home

< Table of Contents

REFERENCE MANUAL

HPS.PolygonKit Class Reference

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

Inheritance diagram for HPS.PolygonKit:
HPS.Object

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...
 
- 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.PolygonKit a, HPS.PolygonKit b)
 
static bool operator== (HPS.PolygonKit a, HPS.PolygonKit 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 PolygonKit class is a user space object.

It is a kit analog to a PolygonKey.

Constructor & Destructor Documentation

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.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref> to copy.

Member Function Documentation

void HPS.PolygonKit.Consume ( HPS.PolygonKit  in_kit)

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

Parameters
in_kitThe 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.

Parameters
in_offsetThe 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_countThe number of points to remove.
Returns
A reference to this PolygonKit.
HPS.PolygonKit HPS.PolygonKit.EditPointsByInsertion ( ulong  in_offset,
HPS.Point[]  in_points 
)

Add points to this PolygonKit at the specified offset.

Parameters
in_offsetThe 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_countSize of the following array.
in_pointsThe points to add to this <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref>.
Returns
A reference to this PolygonKit.
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.

Parameters
in_offsetThe 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_countSize of the following array.
in_pointsThe points to use to replace those on this <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref>.
Returns
A reference to this PolygonKit.
override bool HPS.PolygonKit.Empty ( )
virtual

Indicates whether this PolygonKit has any values set on it.

Returns
true if no values are set on this PolygonKit, false otherwise.

Reimplemented from HPS.Object.

bool HPS.PolygonKit.Equals ( HPS.PolygonKit  in_kit)

Check if the source PolygonKit is equivalent to this PolygonKit.

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

Retrieves the number of points in this polygon.

Returns
The number of points in this polygon.
override HPS.Type HPS.PolygonKit.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.PolygonKit.Set ( HPS.PolygonKit  in_kit)

Copies the source PolygonKit into this PolygonKit.

Parameters
in_kitThe 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.

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

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.PolygonKit HPS.PolygonKit.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.PolygonKit HPS.PolygonKit.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.PolygonKit HPS.PolygonKit.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.PolygonKit.Show ( out HPS.PolygonKit  out_kit)

Copies this PolygonKit into the given PolygonKit.

Parameters
out_kitThe <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.

Parameters
out_pointsThe points for this <ref refid="class_h_p_s_1_1_polygon_kit" kindref="compound">PolygonKit</ref>.
Returns
true if points were set, false otherwise.
bool HPS.PolygonKit.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.PolygonKit.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.PolygonKit.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.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.

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

Removes all user data from this kit.

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

Removes all settings from this PolygonKit.

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

Removes the points for this PolygonKit.

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

Removes a drawing priority setting.

Returns
A reference to this object.
HPS.PolygonKit HPS.PolygonKit.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.PolygonKit HPS.PolygonKit.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: