Inheritance diagram for HPS.PolygonKey:
HPS.GeometryKey HPS.Key HPS.Object

Public Member Functions

void Consume (HPS.PolygonKit in_kit)
 
override void Dispose ()
 
HPS.PolygonKey EditPointsByDeletion (ulong in_offset, ulong in_count)
 
HPS.PolygonKey EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points)
 
HPS.PolygonKey EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)
 
ulong GetPointCount ()
 
override HPS.Type ObjectType ()
 
 PolygonKey ()
 
 PolygonKey (HPS.Key in_that)
 
 PolygonKey (HPS.PolygonKey in_that)
 
void Set (HPS.PolygonKit in_kit)
 
HPS.PolygonKey SetPoints (HPS.Point[] in_points)
 
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)
 
- Public Member Functions inherited from HPS.GeometryKey
 GeometryKey ()
 
 GeometryKey (HPS.Key in_that)
 
 GeometryKey (HPS.GeometryKey in_that)
 
HPS.GeometryKey SetPriority (int in_priority)
 
HPS.GeometryKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
bool ShowBounding (out HPS.BoundingKit out_kit)
 
bool ShowPriority (out int out_priority)
 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 
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.GeometryKey UnsetAllUserData ()
 
HPS.GeometryKey UnsetPriority ()
 
HPS.GeometryKey UnsetUserData (IntPtr in_index)
 
HPS.GeometryKey UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 
void Delete ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 
ulong GetHash ()
 
override int GetHashCode ()
 
bool HasOwner ()
 
 Key ()
 
 Key (HPS.Key in_that)
 
 Key (HPS.Control in_control)
 
void MoveTo (HPS.SegmentKey in_new_owner)
 
HPS.SegmentKey Owner ()
 
HPS.SegmentKey Up ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator!= (HPS.Key a, HPS.Key b)
 
static bool operator== (HPS.Key a, HPS.Key b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The PolygonKey class is a smart pointer to a database object. It is a handle to a polygon created by SegmentKey.InsertPolygon.

Constructor & Destructor Documentation

◆ PolygonKey() [1/3]

HPS.PolygonKey.PolygonKey ( )
inline

The default constructor creates an uninitialized PolygonKey object. The Type() function will return Type.None.

◆ PolygonKey() [2/3]

HPS.PolygonKey.PolygonKey ( HPS.Key  in_that)
inline

This constructor creates an PolygonKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a polygon key. Otherwise the copy will fail and the resulting PolygonKey will be invalid.

◆ PolygonKey() [3/3]

HPS.PolygonKey.PolygonKey ( HPS.PolygonKey  in_that)
inline

The copy constructor creates a PolygonKey object that shares the underlying smart-pointer of the source PolygonKey.

Parameters
in_thatThe source PolygonKey to copy.

Member Function Documentation

◆ Consume()

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

Completely replaces all settings on this PolygonKit with those set on the specified kit and resets the kit.

Parameters
in_kitThe kit from which to get the settings to replace on this PolygonKit.

◆ EditPointsByDeletion()

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

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

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

◆ EditPointsByInsertion()

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

Add points to this PolygonKey at the specified offset.

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

◆ EditPointsByReplacement()

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

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

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

◆ GetPointCount()

ulong HPS.PolygonKey.GetPointCount ( )
inline

Retrieves the number of points in this polygon.

Returns
The number of points in this polygon.

◆ ObjectType()

override HPS.Type HPS.PolygonKey.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.GeometryKey.

◆ Set()

void HPS.PolygonKey.Set ( HPS.PolygonKit  in_kit)
inline

Replace those settings on this PolygonKey with those set on the specified kit.

Parameters
in_kitThe kit from which to get the settings to replace on this PolygonKey.

◆ SetPoints()

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

Replace the points on this PolygonKey with the specified points.

Parameters
in_pointsThe points to use to replace those on this PolygonKey.
Returns
A reference to this PolygonKey.

◆ Show()

void HPS.PolygonKey.Show ( out HPS.PolygonKit  out_kit)
inline

Copy the contents of this PolygonKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this PolygonKey.

◆ ShowPoints()

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

Show the points for this PolygonKey.

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

◆ ShowPointsByList()

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

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

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

◆ ShowPointsByRange()

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

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

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

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.PolygonKey.cs