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

Public Member Functions

void Consume (HPS.PolygonKit in_kit)
 
override void Dispose ()
 
HPS.PolygonKit EditPointsByDeletion (ulong in_offset, ulong in_count)
 
HPS.PolygonKit EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points)
 
HPS.PolygonKit EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.PolygonKit in_kit)
 
override int GetHashCode ()
 
ulong GetPointCount ()
 
override HPS.Type ObjectType ()
 
 PolygonKit ()
 
 PolygonKit (HPS.PolygonKit in_kit)
 
void Set (HPS.PolygonKit in_kit)
 
HPS.PolygonKit SetPoints (HPS.Point[] in_points)
 
HPS.PolygonKit SetPriority (int in_priority)
 
HPS.PolygonKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.PolygonKit SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.PolygonKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
void Show (out HPS.PolygonKit out_kit)
 
bool ShowPoints (out HPS.Point[] out_points)
 
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.PolygonKit UnsetAllUserData ()
 
HPS.PolygonKit UnsetEverything ()
 
HPS.PolygonKit UnsetPoints ()
 
HPS.PolygonKit UnsetPriority ()
 
HPS.PolygonKit UnsetUserData (IntPtr in_index)
 
HPS.PolygonKit 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.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
 

Detailed Description

The PolygonKit class is a user space object. It is a kit analog to a PolygonKey.

Constructor & Destructor Documentation

◆ PolygonKit() [1/2]

HPS.PolygonKit.PolygonKit ( )
inline

The default constructor creates an empty PolygonKit object.

◆ PolygonKit() [2/2]

HPS.PolygonKit.PolygonKit ( HPS.PolygonKit  in_kit)
inline

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

Parameters
in_kitThe source PolygonKit to copy.

Member Function Documentation

◆ Consume()

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

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

Parameters
in_kitThe source PolygonKit to consume.

◆ EditPointsByDeletion()

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

Remove the specified number of points from this PolygonKit at the specified offset.

Parameters
in_offsetThe offset into the points for PolygonKit at which to remove points.
in_countThe number of points to remove.
Returns
A reference to this PolygonKit.

◆ EditPointsByInsertion()

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

Add points to this PolygonKit at the specified offset.

Parameters
in_offsetThe offset into the points for PolygonKit at which to add points.
in_pointsThe points to add to this PolygonKit.
Returns
A reference to this PolygonKit.

◆ EditPointsByReplacement()

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

Replace the specified number of points for this PolygonKit at the specified offset.

Parameters
in_offsetThe offset into the points for PolygonKit at which to start replacing points.
in_pointsThe points to use to replace those on this PolygonKit.
Returns
A reference to this PolygonKit.

◆ Empty()

override bool HPS.PolygonKit.Empty ( )
inlinevirtual

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.

◆ Equals()

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

Check if the source PolygonKit is equivalent to this PolygonKit.

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

◆ GetPointCount()

ulong HPS.PolygonKit.GetPointCount ( )
inline

Retrieves the number of points in this polygon.

Returns
The number of points in this polygon.

◆ ObjectType()

override HPS.Type HPS.PolygonKit.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.PolygonKit.Set ( HPS.PolygonKit  in_kit)
inline

Copies the source PolygonKit into this PolygonKit.

Parameters
in_kitThe source PolygonKit to copy.

◆ SetPoints()

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

Sets the points for this PolygonKit.

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

◆ SetPriority()

HPS.PolygonKit HPS.PolygonKit.SetPriority ( int  in_priority)
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.

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

Copies this PolygonKit into the given PolygonKit.

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

◆ ShowPoints()

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

Shows the points for this PolygonKit.

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

◆ ShowPointsByList()

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

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

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

◆ ShowPointsByRange()

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

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

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

◆ ShowPriority()

bool HPS.PolygonKit.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.PolygonKit.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.PolygonKit.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.PolygonKit.ShowUserDataCount ( )
inline

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

◆ ShowUserDataIndices()

bool HPS.PolygonKit.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.PolygonKit HPS.PolygonKit.UnsetAllUserData ( )
inline

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetEverything()

HPS.PolygonKit HPS.PolygonKit.UnsetEverything ( )
inline

Removes all settings from this PolygonKit.

Returns
A reference to this PolygonKit.

◆ UnsetPoints()

HPS.PolygonKit HPS.PolygonKit.UnsetPoints ( )
inline

Removes the points for this PolygonKit.

Returns
A reference to this PolygonKit.

◆ UnsetPriority()

HPS.PolygonKit HPS.PolygonKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetUserData() [1/2]

HPS.PolygonKit HPS.PolygonKit.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.PolygonKit HPS.PolygonKit.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.PolygonKit.cs