#include <hps.h>

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

Public Member Functions

void Consume (PolygonKit &in_kit)
 
PolygonKeyEditPointsByDeletion (size_t in_offset, size_t in_count)
 
PolygonKeyEditPointsByInsertion (size_t in_offset, size_t in_count, Point const in_points[])
 
PolygonKeyEditPointsByInsertion (size_t in_offset, PointArray const &in_points)
 
PolygonKeyEditPointsByReplacement (size_t in_offset, size_t in_count, Point const in_points[])
 
PolygonKeyEditPointsByReplacement (size_t in_offset, PointArray const &in_points)
 
size_t GetPointCount () const
 
HPS::Type ObjectType () const
 
PolygonKeyoperator= (PolygonKey const &in_that)
 
PolygonKeyoperator= (PolygonKey &&in_that)
 
 PolygonKey ()
 
 PolygonKey (Key const &in_that)
 
 PolygonKey (PolygonKey const &in_that)
 
 PolygonKey (PolygonKey &&in_that)
 
void Set (PolygonKit const &in_kit)
 
PolygonKeySetPoints (PointArray const &in_points)
 
PolygonKeySetPoints (size_t in_count, Point const in_points [])
 
void Show (PolygonKit &out_kit) const
 
bool ShowPoints (PointArray &out_points) const
 
bool ShowPointsByList (SizeTArray const &in_indices, PointArray &out_points) const
 
bool ShowPointsByList (size_t in_count, size_t const in_indices[], PointArray &out_points) const
 
bool ShowPointsByRange (size_t in_start_index, size_t in_count, PointArray &out_points) const
 
- Public Member Functions inherited from HPS::GeometryKey
 GeometryKey ()
 
 GeometryKey (Key const &in_that)
 
 GeometryKey (GeometryKey const &in_that)
 
 GeometryKey (GeometryKey &&in_that)
 
GeometryKeyoperator= (GeometryKey const &in_that)
 
GeometryKeyoperator= (GeometryKey &&in_that)
 
GeometryKeySetPriority (int in_priority)
 
GeometryKeySetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
 
GeometryKeySetUserData (intptr_t in_index, ByteArray const &in_data)
 
GeometryKeySetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
 
bool ShowBounding (BoundingKit &out_kit) const
 
bool ShowPriority (int &out_priority) const
 
size_t ShowReferrers (SegmentKeyArray &out_segments) const
 
size_t ShowReferrers (ReferenceKeyArray &out_references) const
 
bool ShowUserData (intptr_t in_index, ByteArray &out_data) const
 
bool ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const
 
size_t ShowUserDataCount () const
 
bool ShowUserDataIndices (IntPtrTArray &out_indices) const
 
GeometryKeyUnsetAllUserData ()
 
GeometryKeyUnsetPriority ()
 
GeometryKeyUnsetUserData (intptr_t in_index)
 
GeometryKeyUnsetUserData (size_t in_count, intptr_t const in_indices[])
 
GeometryKeyUnsetUserData (IntPtrTArray const &in_indices)
 
- Public Member Functions inherited from HPS::Key
virtual void Assign (Key const &in_that)
 
Key CopyTo (SegmentKey const &in_destination) const
 
void Delete ()
 
bool Equals (Key const &in_that) const
 
size_t GetHash () const
 
bool HasOwner () const
 
 Key ()
 
 Key (Key const &in_that)
 
 Key (Control const &in_control)
 
 Key (Key &&in_that)
 
void MoveTo (SegmentKey const &in_new_owner)
 
bool operator!= (Key const &in_that) const
 
Keyoperator= (Key &&in_that)
 
Keyoperator= (Key const &in_that)
 
bool operator== (Key const &in_that) const
 
SegmentKey Owner () const
 
SegmentKey Up () const
 
virtual ~Key ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::PolygonKey
 
- Static Public Attributes inherited from HPS::GeometryKey
static const HPS::Type staticType = HPS::Type::GeometryKey
 
- Static Public Attributes inherited from HPS::Key
static const HPS::Type staticType = HPS::Type::Key
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

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/4]

HPS::PolygonKey::PolygonKey ( )

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

◆ PolygonKey() [2/4]

HPS::PolygonKey::PolygonKey ( Key const &  in_that)
explicit

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.

Parameters
in_keyThe source Key to copy.

◆ PolygonKey() [3/4]

HPS::PolygonKey::PolygonKey ( PolygonKey const &  in_that)

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

Parameters
in_thatThe source PolygonKey to copy.

◆ PolygonKey() [4/4]

HPS::PolygonKey::PolygonKey ( PolygonKey &&  in_that)

The move constructor creates a PolygonKey by transferring the underlying impl of the rvalue reference to this PolygonKey thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a PolygonKey to take the impl from.

Member Function Documentation

◆ Consume()

void HPS::PolygonKey::Consume ( PolygonKit in_kit)

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()

PolygonKey& HPS::PolygonKey::EditPointsByDeletion ( size_t  in_offset,
size_t  in_count 
)

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() [1/2]

PolygonKey& HPS::PolygonKey::EditPointsByInsertion ( size_t  in_offset,
size_t  in_count,
Point const  in_points[] 
)

Add points to this PolygonKey at the specified offset.

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

◆ EditPointsByInsertion() [2/2]

PolygonKey& HPS::PolygonKey::EditPointsByInsertion ( size_t  in_offset,
PointArray const &  in_points 
)

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() [1/2]

PolygonKey& HPS::PolygonKey::EditPointsByReplacement ( size_t  in_offset,
size_t  in_count,
Point const  in_points[] 
)

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_countSize of the following array.
in_pointsThe points to use to replace those on this PolygonKey.
Returns
A reference to this PolygonKey.

◆ EditPointsByReplacement() [2/2]

PolygonKey& HPS::PolygonKey::EditPointsByReplacement ( size_t  in_offset,
PointArray const &  in_points 
)

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()

size_t HPS::PolygonKey::GetPointCount ( ) const

Retrieves the number of points in this polygon.

Returns
The number of points in this polygon.

◆ ObjectType()

HPS::Type HPS::PolygonKey::ObjectType ( ) const
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.

◆ operator=() [1/2]

PolygonKey& HPS::PolygonKey::operator= ( PolygonKey const &  in_that)

Associate this PolygonKey with the same underlying impl as the source PolygonKey.

Parameters
in_thatThe source PolygonKey for the assignment.
Returns
A reference to this PolygonKey.

◆ operator=() [2/2]

PolygonKey& HPS::PolygonKey::operator= ( PolygonKey &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this PolygonKey thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a PolygonKey to take the impl from.
Returns
A reference to this PolygonKey.

◆ Set()

void HPS::PolygonKey::Set ( PolygonKit const &  in_kit)

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() [1/2]

PolygonKey& HPS::PolygonKey::SetPoints ( PointArray const &  in_points)

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.

◆ SetPoints() [2/2]

PolygonKey& HPS::PolygonKey::SetPoints ( size_t  in_count,
Point const  in_points[] 
)

Replace the points on this PolygonKey with the specified points.

Parameters
in_countSize of the following array.
in_pointsThe points to use to replace those on this PolygonKey.
Returns
A reference to this PolygonKey.

◆ Show()

void HPS::PolygonKey::Show ( PolygonKit out_kit) const

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 ( PointArray out_points) const

Show the points for this PolygonKey.

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

◆ ShowPointsByList() [1/2]

bool HPS::PolygonKey::ShowPointsByList ( SizeTArray const &  in_indices,
PointArray out_points 
) const

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.

◆ ShowPointsByList() [2/2]

bool HPS::PolygonKey::ShowPointsByList ( size_t  in_count,
size_t const  in_indices[],
PointArray out_points 
) const

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

Parameters
in_countThe number of points to show.
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 ( size_t  in_start_index,
size_t  in_count,
PointArray out_points 
) const

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: